'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'DlfNext', 'version' => '2025-03-10', ], 'directories' => [ [ 'id' => 357291, 'title' => '通用服务', 'type' => 'directory', 'children' => [ 'Subscribe', 'DescribeRegions', 'GetRegionStatus', ], ], [ 'id' => 357295, 'title' => '数据目录', 'type' => 'directory', 'children' => [ 'CreateCatalog', 'GetCatalog', 'GetCatalogById', 'AlterCatalog', 'DropCatalog', 'ListCatalogs', 'GetCatalogToken', ], ], [ 'id' => 357303, 'title' => '数据库', 'type' => 'directory', 'children' => [ 'GetDatabase', 'CreateDatabase', 'AlterDatabase', 'DropDatabase', 'ListDatabases', 'ListDatabaseDetails', ], ], [ 'id' => 357310, 'title' => '数据表', 'type' => 'directory', 'children' => [ 'GetTableCompaction', 'GetTable', 'CreateTable', 'AlterTable', 'DropTable', 'RollbackTable', 'ListTables', 'ListTableDetails', 'GetTableSnapshot', 'ListSnapshots', 'GetTableToken', ], ], [ 'id' => 357322, 'title' => '视图', 'type' => 'directory', 'children' => [ 'ListViews', 'ListViewDetails', ], ], [ 'id' => 357325, 'title' => '函数', 'type' => 'directory', 'children' => [ 'ListFunctions', ], ], [ 'id' => 357327, 'title' => '数据表分区', 'type' => 'directory', 'children' => [ 'ListPartitions', ], ], [ 'id' => 357329, 'title' => '数据共享', 'type' => 'directory', 'children' => [ 'CreateShare', 'GetShare', 'AlterShare', 'DropShare', 'ListProvidedShares', 'ListReceivedShares', 'CreateReceiver', 'GetReceiver', 'AlterReceiver', 'DropReceiver', 'ListReceivers', 'ListShareReceivers', 'AlterShareReceivers', 'AlterShareReceivers', 'AlterShareResources', 'ListShareResources', ], ], [ 'id' => 357345, 'title' => '权限', 'type' => 'directory', 'children' => [ 'BatchGrantPermissions', 'BatchRevokePermissions', 'ListPermissions', ], ], [ 'id' => 357349, 'title' => '用户和角色', 'type' => 'directory', 'children' => [ 'CreateRole', 'GetRole', 'UpdateRole', 'DeleteRole', 'ListRoles', 'GetUser', 'ListUsers', 'ListRoleUsers', 'UpdateRoleUsers', 'ListUserRoles', 'GrantRoleToUsers', 'RevokeRoleFromUsers', 'RefreshUserSync', ], ], [ 'id' => 357363, 'title' => '存储概览', 'type' => 'directory', 'children' => [ 'GetCatalogSummary', 'GetCatalogSummaryTrend', 'GetDatabaseSummary', 'GetTableSummary', 'ListPartitionSummaries', ], ], [ 'id' => 357369, 'title' => 'ICEBERG', 'type' => 'directory', 'children' => [ 'ListIcebergTableDetails', 'ListIcebergSnapshots', 'ListIcebergNamespaceDetails', 'GetIcebergTable', 'GetIcebergNamespace', ], ], [ 'id' => 357375, 'title' => '其他', 'type' => 'directory', 'children' => [], ], ], 'components' => [ 'schemas' => [ 'CacheCluster' => [ 'type' => 'object', 'properties' => [ 'clusterId' => [ 'type' => 'string', ], 'clusterName' => [ 'type' => 'string', ], 'vpcId' => [ 'type' => 'string', ], 'instanceVersion' => [ 'type' => 'string', ], 'deployInstanceVersion' => [ 'type' => 'string', ], 'optionsVersion' => [ 'type' => 'integer', 'format' => 'int64', ], 'deployOptionsVersion' => [ 'type' => 'integer', 'format' => 'int64', ], 'status' => [ 'type' => 'string', ], 'createdBy' => [ 'type' => 'string', ], 'createdAt' => [ 'type' => 'integer', 'format' => 'int64', ], 'updatedBy' => [ 'type' => 'string', ], 'updatedAt' => [ 'type' => 'integer', 'format' => 'int64', ], 'vSwitches' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'vSwitchId' => [ 'type' => 'string', ], 'zone' => [ 'type' => 'string', ], ], ], ], 'options' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], ], ], 'Catalog' => [ 'description' => '数据目录。', 'type' => 'object', 'properties' => [ 'owner' => [ 'description' => 'Owner。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '最近修改人。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdBy' => [ 'description' => '创建人。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'name' => [ 'description' => '数据目录名称。', 'type' => 'string', 'example' => 'test_catalog', ], 'id' => [ 'description' => '数据目录ID。', 'type' => 'string', 'example' => 'clg-paimon-xxxx', ], 'type' => [ 'type' => 'string', ], 'updatedAt' => [ 'description' => '最近修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'status' => [ 'description' => '状态。', 'type' => 'string', 'example' => 'NEW'."\n" .'INITIALIZING'."\n" .'INITIALIZE_FAILED'."\n" .'RUNNING'."\n" .'TERMINATED'."\n" .'DELETING'."\n" .'DELETE_FAILED '."\n" .'DELETED'."\n" .'STORAGE_RESTRICTED ', ], 'shareId' => [ 'type' => 'string', ], 'options' => [ 'description' => '扩展选项。', 'type' => 'object', 'additionalProperties' => [ 'description' => '选项值。', 'type' => 'string', 'example' => '{\\"comment\\":\\"test\\"}', ], ], 'isShared' => [ 'type' => 'boolean', ], ], ], 'CatalogSummary' => [ 'description' => '数据目录存储概览。', 'type' => 'object', 'properties' => [ 'databaseCount' => [ 'description' => '库总数量环比数据。', '$ref' => '#/components/schemas/MoMValues', ], 'tableCount' => [ 'description' => '表总数量环比数据。', '$ref' => '#/components/schemas/MoMValues', ], 'partitionCount' => [ 'description' => '分区总数量环比数据。', '$ref' => '#/components/schemas/MoMValues', ], 'totalFileSizeInBytes' => [ 'description' => '存储容量环比数据（单位为Byte）。', '$ref' => '#/components/schemas/MoMValues', ], 'totalFileCount' => [ 'description' => '文件总数环比数据。', '$ref' => '#/components/schemas/MoMValues', ], 'apiVisitCountMonthly' => [ 'description' => '本月元数据请求总次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'fileAccessCountMonthly' => [ 'description' => '本月文件请求总次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'throughputMonthly' => [ 'description' => '本月数据访问流量（单位为Byte）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'generatedDate' => [ 'description' => '存储概览数据更新日期。', 'type' => 'string', 'example' => '2025-01-01', ], 'objTypeStandardSize' => [ 'description' => '标准数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeIaSize' => [ 'description' => '低频数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeArchiveSize' => [ 'description' => '归档数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeColdArchiveSize' => [ 'description' => '冷归档数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'totalMetaSizeInBytes' => [ 'description' => '元数据文件存储量环比数据。', '$ref' => '#/components/schemas/MoMValues', ], 'totalMetaFileCount' => [ 'description' => '元数据文件数环比数据。', '$ref' => '#/components/schemas/MoMValues', ], ], ], 'CatalogSummaryTrend' => [ 'description' => '数据目录存储概览趋势。', 'type' => 'object', 'properties' => [ 'apiVisitCount' => [ 'description' => '元数据请求总次数趋势。', 'type' => 'array', 'items' => [ 'description' => '天级数据点。', '$ref' => '#/components/schemas/DateSummary', ], ], 'fileAccessCount' => [ 'description' => 'file access count trends', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/DateSummary', ], ], 'throughput' => [ 'description' => '数据访问流量趋势。', 'type' => 'array', 'items' => [ 'description' => '天级数据点。', '$ref' => '#/components/schemas/DateSummary', ], ], 'totalMetaCount' => [ 'description' => '元数据对象总数量趋势。', 'type' => 'array', 'items' => [ 'description' => '天级数据点。', '$ref' => '#/components/schemas/DateSummary', ], ], 'totalFileCount' => [ 'description' => '文件总数趋势。', 'type' => 'array', 'items' => [ 'description' => '天级数据点。', '$ref' => '#/components/schemas/DateSummary', ], ], 'totalFileSizeInBytes' => [ 'description' => '总存储容量趋势。', 'type' => 'array', 'items' => [ 'description' => '天级数据点。', '$ref' => '#/components/schemas/DateSummary', ], ], ], ], 'DataField' => [ 'description' => '表的字段定义。', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '表字段名。', 'type' => 'string', 'example' => 'order_id', ], 'description' => [ 'description' => '表字段描述。', 'type' => 'string', 'example' => 'description', ], 'id' => [ 'description' => '表字段号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'type' => [ 'description' => '表字段类型。', '$ref' => '#/components/schemas/FullDataType', ], ], ], 'Database' => [ 'description' => '数据库结构。', 'type' => 'object', 'properties' => [ 'owner' => [ 'description' => '数据库所有者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdBy' => [ 'description' => '创建者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'name' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'test_database', ], 'options' => [ 'description' => '扩展选项。', 'type' => 'object', 'additionalProperties' => [ 'description' => '选项值。', 'type' => 'string', 'example' => '{\\"comment\\":\\"测试\\"}', ], ], 'location' => [ 'description' => '数据库存储路径。', 'type' => 'string', 'example' => 'oss://clg-paimon-xxx/db-xxx'."\n", ], 'id' => [ 'description' => '数据库UUID。', 'type' => 'string', 'example' => '1', ], 'updatedAt' => [ 'description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], ], ], 'DatabaseSummary' => [ 'description' => '库存储概览。', 'type' => 'object', 'properties' => [ 'databaseName' => [ 'description' => '库名。', 'type' => 'string', 'example' => 'default', ], 'createdAt' => [ 'description' => '库创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'location' => [ 'description' => '存储位置。', 'type' => 'string', 'example' => 'oss://clg-paimon-xxx/db-xxx', ], 'tableCount' => [ 'description' => '表总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'partitionCount' => [ 'description' => '分区总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'totalFileSizeInBytes' => [ 'description' => '存储容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', ], 'totalFileCount' => [ 'description' => '文件总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'generatedDate' => [ 'description' => '存储概览数据更新日期。', 'type' => 'string', 'example' => '2025-06-01', ], 'objTypeStandardSize' => [ 'description' => '标准数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeIaSize' => [ 'description' => '低频数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeArchiveSize' => [ 'description' => '归档数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeColdArchiveSize' => [ 'description' => '冷归档数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'totalMetaSizeInBytes' => [ 'description' => '元数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'totalMetaFileCount' => [ 'description' => '元数据文件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1500', ], ], ], 'DateSummary' => [ 'description' => '存储概览天级数据点。', 'type' => 'object', 'properties' => [ 'date' => [ 'description' => '存储概览日期。', 'type' => 'string', 'example' => '2025-06-01', ], 'value' => [ 'description' => '存储概览数值。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'ErrorResponse' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'integer', 'format' => 'int32', ], 'resourceName' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], ], ], 'FailurePermission' => [ 'description' => 'FailurePermission', 'type' => 'object', 'properties' => [ 'errorMessage' => [ 'description' => '错误信息', 'type' => 'string', 'example' => '空', ], 'errorCode' => [ 'description' => '错误码。', 'type' => 'string', 'example' => '空', ], 'permission' => [ 'description' => '权限信息。', '$ref' => '#/components/schemas/Permission', ], ], ], 'FieldRef' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'type' => 'string', ], 'type' => [ '$ref' => '#/components/schemas/FullDataType', ], 'index' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], 'FullDataType' => [ 'description' => '表字段数据类型定义。', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '元素数据类型，type是ARRAY和MULTISET时必传。', 'type' => 'string', 'enumValueTitles' => [ 'BYTES' => 'BYTES', 'ARRAY' => 'ARRAY', 'BINARY' => 'BINARY', 'CHAR' => 'CHAR', 'DECIMAL' => 'DECIMAL', 'BIGINT' => 'BIGINT', 'FLOAT ' => 'FLOAT ', 'TIME' => 'TIME', 'BOOLEAN' => 'BOOLEAN', 'INT' => 'INT', 'DATE' => 'DATE', 'SMALLINT' => 'SMALLINT', 'TIMESTAMP' => 'TIMESTAMP', 'MULTISET' => 'MULTISET', 'VARCHAR' => 'VARCHAR', 'STRING' => 'STRING', 'VARBINARY' => 'VARBINARY', 'DOUBLE' => 'DOUBLE', 'ROW' => 'ROW', 'MAP' => 'MAP', 'TINYINT' => 'TINYINT', ], 'example' => 'STRING', ], 'fields' => [ 'description' => '字段定义列表，type是ROW时必传。', 'type' => 'array', 'items' => [ 'description' => '字段定义。', '$ref' => '#/components/schemas/DataField', ], ], 'value' => [ 'description' => '值数据类型，type是MAP时必传。', '$ref' => '#/components/schemas/FullDataType', ], 'key' => [ 'description' => '键数据类型，type是MAP时必传。', '$ref' => '#/components/schemas/FullDataType', ], 'element' => [ 'description' => '数据类型。', '$ref' => '#/components/schemas/FullDataType', ], ], ], 'FullInstant' => [ 'type' => 'object', 'properties' => [ 'snapshotId' => [ 'type' => 'integer', 'format' => 'int64', ], 'tagName' => [ 'type' => 'string', ], 'type' => [ 'type' => 'string', ], ], ], 'FullSchemaChange' => [ 'description' => '表结构变更信息。', 'type' => 'object', 'properties' => [ 'keepNullability' => [ 'description' => '是否可空，action是UpdateColumnType时必传。', 'type' => 'boolean', 'example' => 'true', ], 'move' => [ 'description' => '移动列，action是AddColumn/UpdateColumnPosition时必传。', '$ref' => '#/components/schemas/Move', ], 'newName' => [ 'description' => '新字段名称，action是RenameColumn时必传。', 'type' => 'string', 'example' => 'new_col_test', ], 'newNullability' => [ 'description' => '新字段是否可空，action是UpdateColumnType时必传。', 'type' => 'boolean', 'example' => 'true', ], 'fieldNames' => [ 'description' => '表字段名称列表，action是AddColumn/RenameColumn/DropColumn/UpdateColumnComment/UpdateColumnType/UpdateColumnNullability时必传。', 'type' => 'array', 'items' => [ 'description' => '表字段名称。', 'type' => 'string', 'example' => 'col', ], ], 'dataType' => [ 'description' => '字段类型，action是AddColumn时必传', '$ref' => '#/components/schemas/FullDataType', ], 'newComment' => [ 'description' => '新字段描述，action是UpdateColumnComment时必传。', 'type' => 'string', 'example' => 'col_comment_test', ], 'action' => [ 'description' => '变更类型。', 'type' => 'string', 'example' => 'setOption', 'enum' => [ 'setOption', 'removeOption', 'updateComment', 'addColumn', 'renameColumn', 'dropColumn', 'updateColumnComment', 'updateColumnType', 'updateColumnPosition', 'updateColumnNullability', ], ], 'comment' => [ 'description' => '描述，action是UpdateComment/AddColumn时必传。', 'type' => 'string', 'example' => 'col_comment', ], 'value' => [ 'description' => '配置值，action是SetOption必传。', 'type' => 'string', 'example' => '\'manifest.delete-file-drop-stats\'', ], 'key' => [ 'description' => '配置key, action是SetOption/RemoveOption必传。', 'type' => 'string', 'example' => '\'true\'', ], 'newDataType' => [ 'description' => '新字段类型，action是UpdateColumnType时必传。', '$ref' => '#/components/schemas/FullDataType', ], ], ], 'Function' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'type' => 'string', ], 'deterministic' => [ 'type' => 'boolean', ], 'comment' => [ 'type' => 'string', ], 'owner' => [ 'type' => 'string', ], 'createdBy' => [ 'type' => 'string', ], 'createdAt' => [ 'type' => 'integer', 'format' => 'int64', ], 'updatedAt' => [ 'type' => 'integer', 'format' => 'int64', ], 'updatedBy' => [ 'type' => 'string', ], 'inputParams' => [ 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/DataField', ], ], 'returnParams' => [ 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/DataField', ], ], 'definitions' => [ 'type' => 'object', 'additionalProperties' => [ '$ref' => '#/components/schemas/FunctionDefinition', ], ], 'options' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], 'id' => [ 'type' => 'string', ], ], ], 'FunctionChange' => [ 'type' => 'object', 'properties' => [ 'action' => [ 'type' => 'string', 'enum' => [ 'setOption', 'removeOption', 'updateComment', 'addDefinition', 'updateDefinition', 'dropDefinition', ], ], 'key' => [ 'description' => 'required in SetFunctionOption/RemoveFunctionOption', 'type' => 'string', ], 'value' => [ 'description' => 'required in SetFunctionOption', 'type' => 'string', ], 'comment' => [ 'description' => 'required in UpdateFunctionComment', 'type' => 'string', ], 'name' => [ 'description' => 'required in AddDefinition/UpdateDefinition/DropDefinition', 'type' => 'string', ], 'definition' => [ 'description' => 'required in AddDefinition/UpdateDefinition', '$ref' => '#/components/schemas/FunctionDefinition', ], ], ], 'FunctionDefinition' => [ 'type' => 'object', 'properties' => [ 'type' => [ 'type' => 'string', 'enum' => [ 'sql', 'file', 'lambda', ], ], 'definition' => [ 'description' => 'required in SQLFunctionDefinition/LambdaFunctionDefinition', 'type' => 'string', ], 'language' => [ 'description' => 'required in LambdaFunctionDefinition/FileFunctionDefinition', 'type' => 'string', ], 'className' => [ 'description' => 'required in FileFunctionDefinition', 'type' => 'string', ], 'functionName' => [ 'description' => 'required in FileFunctionDefinition', 'type' => 'string', ], 'fileResources' => [ 'description' => 'required in FileFunctionDefinition', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/FunctionFileResource', ], ], ], ], 'FunctionFileResource' => [ 'type' => 'object', 'properties' => [ 'resourceType' => [ 'type' => 'string', ], 'uri' => [ 'type' => 'string', ], ], ], 'IcebergNestedField' => [ 'description' => 'iceberg嵌套数据类型', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '列名称', 'type' => 'string', 'example' => 'col1', ], 'doc' => [ 'description' => '注释', 'type' => 'string', 'example' => 'desc1', ], 'optional' => [ 'description' => '是否可选', 'type' => 'boolean', 'example' => 'true', ], 'id' => [ 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'type' => [ 'description' => '类型', 'type' => 'string', 'example' => 'string', ], ], ], 'IcebergPartitionField' => [ 'description' => 'Iceberg分区', 'type' => 'object', 'properties' => [ 'sourceId' => [ 'description' => '对应列id', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'transform' => [ 'description' => '转换规则', 'type' => 'string', 'example' => 'day', ], 'name' => [ 'description' => '分区名', 'type' => 'string', 'example' => 'ts_day', ], 'fieldId' => [ 'description' => '分区id', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'IcebergSnapshot' => [ 'description' => 'iceberg 快照', 'type' => 'object', 'properties' => [ 'sequenceNumber' => [ 'description' => '次序编号', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'timestampMillis' => [ 'description' => '时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1750313724369', ], 'schemaId' => [ 'description' => 'schema序号', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'addedRows' => [ 'description' => '增加行数', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'operation' => [ 'description' => '操作', 'type' => 'string', 'example' => 'append', ], 'id' => [ 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '2443368274334000657', ], 'parentId' => [ 'description' => '父id', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'idString' => [ 'type' => 'string', ], 'parentIdString' => [ 'type' => 'string', ], 'summary' => [ 'description' => '概况', 'type' => 'object', 'additionalProperties' => [ 'description' => '概况', 'type' => 'string', 'example' => 'total-records:3', ], ], ], ], 'IcebergTable' => [ 'description' => 'iceberg表', 'type' => 'object', 'properties' => [ 'owner' => [ 'description' => '表所有者', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'path' => [ 'description' => '表路径', 'type' => 'string', 'example' => 'oss://clg-iceberg-xxxx/ns-xxxx/table-xxxx', ], 'createdAt' => [ 'description' => '表创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1747120676378', ], 'updatedBy' => [ 'description' => '更新者', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdBy' => [ 'description' => '创建者', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'name' => [ 'description' => '表名称', 'type' => 'string', 'example' => 'table1', ], 'id' => [ 'description' => '表UUID', 'type' => 'string', 'example' => 'tbl-xxxx', ], 'version' => [ 'description' => '表版本', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'icebergTableMetadata' => [ 'description' => '表元数据', '$ref' => '#/components/schemas/IcebergTableMetadata', ], 'updatedAt' => [ 'description' => '表更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], ], ], 'IcebergTableMetadata' => [ 'description' => 'iceberg表元数据', 'type' => 'object', 'properties' => [ 'currentSnapshot' => [ 'description' => 'iceberg 最新snapshot', '$ref' => '#/components/schemas/IcebergSnapshot', ], 'partitionFields' => [ 'description' => '分区字段列表', 'type' => 'array', 'items' => [ 'description' => '分区字段', '$ref' => '#/components/schemas/IcebergPartitionField', ], ], 'fields' => [ 'description' => '列字段', 'type' => 'array', 'items' => [ 'description' => '列字段', '$ref' => '#/components/schemas/IcebergNestedField', ], ], 'properties' => [ 'description' => '属性', 'type' => 'object', 'additionalProperties' => [ 'description' => '属性', 'type' => 'string', 'example' => 'write.format.default:parquet', ], ], 'identifierFieldIds' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], 'Identifier' => [ 'description' => '表标识符。', 'type' => 'object', 'properties' => [ 'database' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'database_name', ], 'object' => [ 'description' => '表名称。', 'type' => 'string', 'example' => 'table_name', ], ], ], 'MoMValues' => [ 'description' => '环比数据。', 'type' => 'object', 'properties' => [ 'lastDayValue' => [ 'description' => '前一天值。', 'type' => 'integer', 'format' => 'int64', 'example' => '800', ], 'lastMonthValue' => [ 'description' => '上月值。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'currentValue' => [ 'description' => '当前值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], 'Move' => [ 'description' => '移动列。', 'type' => 'object', 'properties' => [ 'referenceFieldName' => [ 'description' => '参考字段名。', 'type' => 'string', 'example' => 'col_test', ], 'fieldName' => [ 'description' => '字段名。', 'type' => 'string', 'example' => 'other_col_test', ], 'type' => [ 'description' => '类型。', 'type' => 'string', 'example' => 'FIRST', 'enum' => [ 'FIRST', 'AFTER', 'BEFORE', 'LAST', ], ], ], ], 'Namespace' => [ 'type' => 'object', 'properties' => [ 'owner' => [ 'type' => 'string', ], 'createdAt' => [ 'type' => 'integer', 'format' => 'int64', ], 'updatedBy' => [ 'type' => 'string', ], 'createdBy' => [ 'type' => 'string', ], 'name' => [ 'type' => 'string', ], 'options' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], 'location' => [ 'type' => 'string', ], 'id' => [ 'type' => 'string', ], 'updatedAt' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], 'Partition' => [ 'description' => '分区详情。', 'type' => 'object', 'properties' => [ 'lastFileCreationTime' => [ 'description' => '最新文件创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1741701564261', ], 'recordCount' => [ 'description' => '记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'fileSizeInBytes' => [ 'description' => '文件大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'fileCount' => [ 'description' => '文件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'done' => [ 'description' => '是否记标完成。', 'type' => 'boolean', 'example' => 'true', ], 'spec' => [ 'description' => '分区值键值对。', 'type' => 'object', 'example' => '{"year":"2025"}', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1747120676378', ], 'createdBy' => [ 'description' => '创建者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'updatedAt' => [ 'description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'storageClass' => [ 'description' => '存储类型。', 'type' => 'string', 'example' => 'STANDARD', ], 'storageAction' => [ 'description' => '存储类型转换状态。', 'type' => 'string', 'example' => 'COMPLETE', ], 'storageActionTimestamp' => [ 'description' => '存储类型转换时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1758189669915', ], 'totalBuckets' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], 'PartitionSummaries' => [ 'description' => '分区存储概览。', 'type' => 'object', 'properties' => [ 'partitions' => [ 'description' => '分区存储概览列表。', 'type' => 'array', 'items' => [ 'description' => '单个分区存储概览。', '$ref' => '#/components/schemas/PartitionSummary', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'hh=10', ], ], ], 'PartitionSummary' => [ 'description' => '单个分区存储概览。', 'type' => 'object', 'properties' => [ 'databaseName' => [ 'description' => '库名。', 'type' => 'string', 'example' => 'default', ], 'tableName' => [ 'description' => '表名。', 'type' => 'string', 'example' => 'table1', ], 'partitionName' => [ 'description' => '分区名。', 'type' => 'string', 'example' => 'hh=18', ], 'createdAt' => [ 'description' => '分区创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'totalFileSizeInBytes' => [ 'description' => '存储容量（单位为Byte）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2048', ], 'totalFileCount' => [ 'description' => '文件总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'lastAccessTime' => [ 'description' => '最后数据访问时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedAt' => [ 'description' => '最近更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'storageClass' => [ 'type' => 'string', ], 'storageActionTimestamp' => [ 'type' => 'integer', 'format' => 'int64', ], 'storageActionParams' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], ], ], 'Permission' => [ 'description' => 'Permission', 'type' => 'object', 'properties' => [ 'resourceType' => [ 'description' => '权限资源类型。', 'type' => 'string', 'example' => 'CATALOG', ], 'database' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'database_name', ], 'table' => [ 'description' => '数据表名称。', 'type' => 'string', 'example' => 'table_name', ], 'access' => [ 'description' => '访问类型。', 'type' => 'string', 'example' => 'DROP', ], 'principal' => [ 'description' => '用户资源描述符。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:user/user_name', ], 'columns' => [ 'type' => 'object', 'properties' => [ 'columnNames' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'excludedColumnNames' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], 'function' => [ 'type' => 'string', ], 'view' => [ 'type' => 'string', ], 'expireTime' => [ 'type' => 'string', ], 'rowFilter' => [ '$ref' => '#/components/schemas/RowFilter', ], ], ], 'Predicate' => [ 'type' => 'object', 'properties' => [ 'kind' => [ 'type' => 'string', ], 'transform' => [ '$ref' => '#/components/schemas/Transform', ], 'function' => [ 'type' => 'string', ], 'literals' => [ 'type' => 'array', 'items' => [ 'type' => 'any', ], ], 'children' => [ 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/Predicate', ], ], ], ], 'PrepayResource' => [ 'description' => '包年包月计算资源。', 'type' => 'object', 'properties' => [ 'catalogId' => [ 'description' => '数据目录ID。', 'type' => 'string', 'example' => 'clg-xxxx', ], 'instanceId' => [ 'description' => '包年包月计算资源实例ID。', 'type' => 'string', 'example' => 'dlf-cu-quota-xxxx', ], 'catalogName' => [ 'description' => '数据目录名称。', 'type' => 'string', 'example' => 'test_catalog', ], 'instanceStatus' => [ 'title' => 'RUNNING|UPGRADING|CEASED|RELEASED', 'description' => '包年包月计算资源状态。', 'type' => 'string', 'example' => 'RUNNING'."\n" .'UPGRADING'."\n" .'CEASED'."\n" .'RELEASED', ], 'cu' => [ 'description' => '当前包年包月CU数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'gmtCreate' => [ 'description' => '包年包月购买时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1764070447351', ], 'expireTime' => [ 'description' => '包年包月过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1769356800000', ], ], ], 'ReceivedShare' => [ 'description' => '接收的共享。', 'type' => 'object', 'properties' => [ 'providerTenantId' => [ 'description' => '提供者的账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', ], 'shareId' => [ 'description' => '共享ID。', 'type' => 'string', 'example' => '1111', ], 'shareName' => [ 'description' => '共享名称。', 'type' => 'string', 'example' => 'share_name', ], 'owner' => [ 'description' => '共享所有者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'createdBy' => [ 'description' => '创建者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'updatedAt' => [ 'description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'catalogName' => [ 'description' => 'catalog名称。', 'type' => 'string', 'example' => 'catalog_name', ], 'comment' => [ 'description' => '共享的注释信息。', 'type' => 'string', 'example' => 'demo', ], 'enableWrite' => [ 'type' => 'boolean', ], ], ], 'Receiver' => [ 'description' => '接收者。', 'type' => 'object', 'properties' => [ 'receiverName' => [ 'description' => '接收者名称。', 'type' => 'string', 'example' => 'receiver_name', ], 'receiverTenantId' => [ 'description' => '接收者账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', ], 'comment' => [ 'description' => '注释。', 'type' => 'string', 'example' => 'comment', ], 'createdBy' => [ 'description' => '创建者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'updatedAt' => [ 'description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], ], ], 'Role' => [ 'description' => '角色信息。', 'type' => 'object', 'properties' => [ 'createdAt' => [ 'description' => '创建时间，Unix 时间戳毫秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'isPredefined' => [ 'description' => '是否内置角色。', 'type' => 'string', 'example' => 'true', ], 'updatedBy' => [ 'description' => '更新者名称。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdBy' => [ 'description' => '创建者名称。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'displayName' => [ 'description' => '角色显示名称。', 'type' => 'string', 'example' => 'role_display_name', ], 'roleName' => [ 'description' => '角色名称。', 'type' => 'string', 'example' => 'role_name', ], 'description' => [ 'description' => '角色描述。', 'type' => 'string', 'example' => 'role_description', ], 'rolePrincipal' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'example' => 'acs:dlf::[accountId]:role/role_name', ], 'users' => [ 'description' => '用户信息列表。', 'type' => 'array', 'items' => [ 'description' => '用户信息。', '$ref' => '#/components/schemas/User', ], ], 'updatedAt' => [ 'description' => '更新时间，Unix 时间戳毫秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], ], ], 'RowFilter' => [ 'type' => 'object', 'properties' => [ 'expression' => [ 'type' => 'string', ], 'predicate' => [ 'type' => 'string', ], ], ], 'Schema' => [ 'description' => '表结构。', 'type' => 'object', 'properties' => [ 'primaryKeys' => [ 'description' => '表主键字段名称列表。', 'type' => 'array', 'items' => [ 'description' => '表主键字段名称。', 'type' => 'string', 'example' => 'order_id', ], ], 'options' => [ 'description' => '表配置参数列表。', 'type' => 'object', 'additionalProperties' => [ 'description' => '配置参数。', 'type' => 'string', 'example' => 'bucket : 5', ], ], 'comment' => [ 'description' => '表的注释信息。', 'type' => 'string', 'example' => 'description', ], 'partitionKeys' => [ 'description' => '表的分区字段名称列表。', 'type' => 'array', 'items' => [ 'description' => '表的分区字段名称。', 'type' => 'string', 'example' => 'pt', ], ], 'fields' => [ 'description' => '表的字段定义列表。', 'type' => 'array', 'items' => [ 'description' => '表的字段定义。', '$ref' => '#/components/schemas/DataField', ], ], ], ], 'Share' => [ 'description' => '共享实体。', 'type' => 'object', 'properties' => [ 'providerTenantId' => [ 'description' => '提供者的账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', ], 'shareId' => [ 'description' => '共享ID。', 'type' => 'string', 'example' => '1111', ], 'shareName' => [ 'description' => '共享名称。', 'type' => 'string', 'example' => 'share_name', ], 'comment' => [ 'description' => '共享的注释信息。', 'type' => 'string', 'example' => 'demo', ], 'owner' => [ 'description' => '共享所有者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '共享创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'createdBy' => [ 'description' => '创建人。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'updatedAt' => [ 'description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'enableWrite' => [ 'type' => 'boolean', ], ], ], 'ShareOptions' => [ 'type' => 'object', 'properties' => [ 'receiverSizeLimit' => [ 'type' => 'integer', 'format' => 'int32', ], 'shareSizeLimit' => [ 'type' => 'integer', 'format' => 'int32', ], 'shareResourceSizeLimit' => [ 'type' => 'integer', 'format' => 'int32', ], 'catalogSizeLimit' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], 'ShareResource' => [ 'description' => '共享资源。', 'type' => 'object', 'properties' => [ 'shareType' => [ 'description' => '共享类型。', 'type' => 'string', 'example' => 'TABLE', 'enum' => [ 'CATALOG_ALL', 'DATABASE_ALL', 'TABLE', ], ], 'databaseName' => [ 'description' => '数据库名。', 'type' => 'string', 'example' => 'database_name', ], 'tableName' => [ 'description' => '数据表名。', 'type' => 'string', 'example' => 'table_name', ], 'createdBy' => [ 'description' => '创建人。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedAt' => [ 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], ], ], 'Snapshot' => [ 'type' => 'object', 'properties' => [ 'deltaManifestList' => [ 'title' => '记录本次提交新增的文件', 'type' => 'string', ], 'changelogManifestList' => [ 'title' => '本次提交产生的变更日志', 'type' => 'string', ], 'watermark' => [ 'type' => 'integer', 'format' => 'int64', ], 'commitKind' => [ 'title' => '提交类型：APPEND,COMPACT,OVERWRITE,ANALYZE', 'type' => 'string', 'enum' => [ 'APPEND', 'COMPACT', 'OVERWRITE', 'ANALYZE', ], ], 'deltaRecordCount' => [ 'title' => '本次提交新增记录行数', 'type' => 'integer', 'format' => 'int64', ], 'baseManifestList' => [ 'type' => 'string', ], 'version' => [ 'type' => 'integer', 'format' => 'int32', ], 'totalRecordCount' => [ 'title' => '表总行数', 'type' => 'integer', 'format' => 'int64', ], 'commitUser' => [ 'type' => 'string', ], 'logOffsets' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'integer', 'format' => 'int64', ], ], 'schemaId' => [ 'title' => 'schema id', 'type' => 'integer', 'format' => 'int64', ], 'indexManifest' => [ 'type' => 'string', ], 'changelogRecordCount' => [ 'type' => 'integer', 'format' => 'int64', ], 'id' => [ 'title' => '快照ID', 'type' => 'integer', 'format' => 'int64', ], 'timeMillis' => [ 'title' => '提交时间', 'type' => 'integer', 'format' => 'int64', ], 'statistics' => [ 'type' => 'string', ], 'commitIdentifier' => [ 'type' => 'integer', 'format' => 'int64', ], 'parentIdString' => [ 'type' => 'string', ], 'sequenceNumber' => [ 'type' => 'integer', 'format' => 'int64', ], 'summary' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], 'idString' => [ 'type' => 'string', ], ], ], 'Table' => [ 'description' => '表结构。', 'type' => 'object', 'properties' => [ 'id' => [ 'description' => '表UUID。', 'type' => 'string', 'example' => '1', ], 'name' => [ 'description' => '表名称。', 'type' => 'string', 'example' => 'table_test', ], 'path' => [ 'description' => '表路径。', 'type' => 'string', 'example' => 'oss://clg-paimon-xxx/db-xxx/tbl-xxxx', ], 'isExternal' => [ 'description' => '是否外表。', 'type' => 'boolean', 'example' => 'true', ], 'schemaId' => [ 'description' => '表结构信息ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'schema' => [ 'description' => '表结构信息。', '$ref' => '#/components/schemas/Schema', ], 'owner' => [ 'description' => '表所有者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1741266704867', ], 'createdBy' => [ 'description' => '创建者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'updatedAt' => [ 'description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1741266704867', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'storageClass' => [ 'type' => 'string', ], 'storageAction' => [ 'type' => 'string', ], 'storageActionTimestamp' => [ 'type' => 'integer', 'format' => 'int64', ], 'icebergTableMetadata' => [ '$ref' => '#/components/schemas/IcebergTableMetadata', ], 'type' => [ 'type' => 'string', ], ], ], 'TableCompaction' => [ 'description' => 'TableCompaction。', 'type' => 'object', 'properties' => [ 'catalogId' => [ 'description' => '数据目录ID。', 'type' => 'string', 'example' => 'clg-paimon-xxx', ], 'tableId' => [ 'description' => '表ID', 'type' => 'string', 'example' => 'tbl-xxx', ], 'lastCompactedFileTime' => [ 'description' => '最后合并的文件时间。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '1759111660075', ], 'cuUsage' => [ 'description' => 'cu使用总量', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'maxLevel0FileCount' => [ 'description' => 'Level0 文件个数。', 'type' => 'string', 'deprecated' => true, 'example' => '1', ], 'latencyFileEarliestTime' => [ 'description' => '当前未合并文件的 earliestCreationTime。', 'type' => 'integer', 'format' => 'int64', 'example' => '1760321763633', ], ], ], 'TableCompactionHistory' => [ 'type' => 'object', 'properties' => [ 'catalogId' => [ 'type' => 'string', ], 'tableId' => [ 'type' => 'string', ], 'snapshotId' => [ 'type' => 'integer', 'format' => 'int64', ], 'updatedBy' => [ 'type' => 'string', ], 'updatedAt' => [ 'type' => 'integer', 'format' => 'int64', ], 'commitTime' => [ 'type' => 'integer', 'format' => 'int64', ], 'beforeFilesLastCreationTime' => [ 'type' => 'integer', 'format' => 'int64', ], 'beforeFilesCount' => [ 'type' => 'integer', 'format' => 'int64', ], 'afterFilesCount' => [ 'type' => 'integer', 'format' => 'int64', ], 'beforeFilesSize' => [ 'type' => 'integer', 'format' => 'int64', ], 'afterFilesSize' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], 'TableSnapshot' => [ 'type' => 'object', 'properties' => [ 'lastFileCreationTime' => [ 'type' => 'integer', 'format' => 'int64', ], 'recordCount' => [ 'type' => 'integer', 'format' => 'int64', ], 'fileSizeInBytes' => [ 'type' => 'integer', 'format' => 'int64', ], 'fileCount' => [ 'type' => 'integer', 'format' => 'int64', ], 'snapshot' => [ '$ref' => '#/components/schemas/Snapshot', ], 'totalBuckets' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], 'TableSummary' => [ 'description' => '表存储概览。', 'type' => 'object', 'properties' => [ 'databaseName' => [ 'description' => '库名。', 'type' => 'string', 'example' => 'default', ], 'tableName' => [ 'description' => '表名。', 'type' => 'string', 'example' => 'table1', ], 'createdAt' => [ 'description' => '表创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'partitionCount' => [ 'description' => '分区总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'unaccessedStdPartitionCount30d' => [ 'description' => '近30天未访问的标准存储分区数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'unaccessedStdIaPartitionCount180d' => [ 'description' => '近180天未访问的标准或低频分区数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'totalFileSizeInBytes' => [ 'description' => '表存储容量（单位为Byte）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'totalFileCount' => [ 'description' => '表文件总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'lastAccessTime' => [ 'description' => '表最近数据访问时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'generatedDate' => [ 'description' => '存储概览数据更新日期。', 'type' => 'string', 'example' => '2025-06-01', ], 'path' => [ 'description' => '存储位置。', 'type' => 'string', 'example' => 'oss://clg-xxxx/db-xxxx/tbl-xxxx', ], 'storageClass' => [ 'type' => 'string', ], 'storageActionTimestamp' => [ 'type' => 'integer', 'format' => 'int64', ], 'objTypeStandardSize' => [ 'description' => '标准数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeIaSize' => [ 'description' => '低频数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeArchiveSize' => [ 'description' => '归档数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'objTypeColdArchiveSize' => [ 'description' => '冷归档数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'updatedAt' => [ 'type' => 'integer', 'format' => 'int64', ], 'totalMetaSizeInBytes' => [ 'description' => '元数据文件存储量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'totalMetaFileCount' => [ 'description' => '元数据文件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'storageActionParams' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], ], ], ], 'Transform' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'type' => 'string', ], 'fieldRef' => [ '$ref' => '#/components/schemas/FieldRef', ], 'castType' => [ '$ref' => '#/components/schemas/FullDataType', ], 'inputs' => [ 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/TransformInput', ], ], ], ], 'TransformInput' => [ 'type' => 'object', 'properties' => [ 'type' => [ 'type' => 'string', ], 'input' => [ 'type' => 'any', ], ], ], 'User' => [ 'description' => '用户信息。', 'type' => 'object', 'properties' => [ 'createdAt' => [ 'description' => '创建时间，Unix 时间戳毫秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '更新者名称。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdBy' => [ 'description' => '创建者名称。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'displayName' => [ 'description' => '用户显示名称。', 'type' => 'string', 'example' => 'user_display_name', ], 'userName' => [ 'description' => '用户名称。', 'type' => 'string', 'example' => 'user_name', ], 'type' => [ 'description' => '用户类型。', 'type' => 'string', 'example' => 'RAM_USER', 'enum' => [ 'RAM_USER', 'RAM_ROLE', ], ], 'userId' => [ 'description' => '用户 ID。', 'type' => 'string', 'example' => '222748924538****', ], 'userPrincipal' => [ 'description' => '用户的资源描述符。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:user/user_name', ], 'updatedAt' => [ 'description' => '更新时间，Unix 时间戳毫秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], ], ], 'View' => [ 'description' => '视图结构。', 'type' => 'object', 'properties' => [ 'schema' => [ 'description' => '视图结构信息。', '$ref' => '#/components/schemas/ViewSchema', ], 'owner' => [ 'description' => '视图所有者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdAt' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], 'updatedBy' => [ 'description' => '更新者。', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'createdBy' => [ 'description' => '创建者', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', ], 'name' => [ 'description' => '视图名称。', 'type' => 'string', 'example' => 'view_test', ], 'id' => [ 'description' => '视图UUID。', 'type' => 'string', 'example' => '1', ], 'updatedAt' => [ 'description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744970111419', ], ], ], 'ViewChange' => [ 'type' => 'object', 'properties' => [ 'action' => [ 'type' => 'string', 'enum' => [ 'addDialect', 'updateDialect', 'dropDialect', 'setOption', 'removeOption', 'updateComment', ], ], 'dialect' => [ 'description' => 'required in AddDialect/UpdateDialect/DropDialect', 'type' => 'string', ], 'query' => [ 'description' => 'required in AddDialect/UpdateDialect', 'type' => 'string', ], 'comment' => [ 'description' => 'required in UpdateComment', 'type' => 'string', ], 'value' => [ 'description' => 'required in SetOption', 'type' => 'string', ], 'key' => [ 'description' => 'required in SetOption/RemoveOption', 'type' => 'string', ], ], ], 'ViewSchema' => [ 'description' => '视图结构信息。', 'type' => 'object', 'properties' => [ 'fields' => [ 'description' => '视图的字段定义列表。', 'type' => 'array', 'items' => [ 'description' => '视图的字段定义。', '$ref' => '#/components/schemas/DataField', ], ], 'query' => [ 'description' => '视图默认的查询。', 'type' => 'string', 'example' => 'select id from t1;', ], 'dialects' => [ 'description' => '不同引擎的查询。', 'type' => 'object', 'additionalProperties' => [ 'description' => '引擎的查询。', 'type' => 'string', 'example' => 'spark: select id from t1;', ], ], 'comment' => [ 'description' => '注释。', 'type' => 'string', 'example' => 'comment', ], 'options' => [ 'description' => '视图配置参数列表。', 'type' => 'object', 'additionalProperties' => [ 'description' => '配置参数。', 'type' => 'string', 'example' => 'k1：t1', ], ], ], ], 'ViewSchemaChange' => [ 'type' => 'object', 'properties' => [ 'action' => [ 'type' => 'string', 'enum' => [ 'addDialect', 'updateDialect', 'dropDialect', 'setOption', 'removeOption', 'updateComment', ], ], 'dialect' => [ 'description' => 'required in AddDialect/UpdateDialect/DropDialect', 'type' => 'string', ], 'query' => [ 'description' => 'required in AddDialect/UpdateDialect', 'type' => 'string', ], 'comment' => [ 'description' => 'required in UpdateComment', 'type' => 'string', ], 'value' => [ 'description' => 'required in SetOption', 'type' => 'string', ], 'key' => [ 'description' => 'required in SetOption/RemoveOption', 'type' => 'string', ], ], ], ], ], 'apis' => [ 'Subscribe' => [ 'summary' => '订阅当前地域的 DLF。', 'path' => '/dlf/v1/service/subscribe', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230463', 'abilityTreeNodes' => [ 'FEATUREdlfSKHNZC', ], ], 'parameters' => [], 'responses' => [ 200 => [], 409 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '订阅当前地域的 DLF', ], 'DescribeRegions' => [ 'summary' => '查询 DLF 开通地域。', 'path' => '/dlf/v1/service/regions', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230450', 'abilityTreeNodes' => [ 'FEATUREdlfSKHNZC', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Response', 'description' => 'Response', 'type' => 'object', 'properties' => [ 'regions' => [ 'description' => '地域列表。', 'type' => 'array', 'items' => [ 'description' => '地域信息。', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => '类型。', 'type' => 'string', 'example' => 'region', ], 'showName' => [ 'description' => '显示名称。', 'type' => 'string', 'example' => '华东1（杭州）', ], 'name' => [ 'description' => '名称。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'description' => [ 'description' => '描述。', 'type' => 'string', 'example' => '华东 1', ], ], ], ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regions\\": [\\n {\\n \\"type\\": \\"region\\",\\n \\"showName\\": \\"华东1（杭州）\\",\\n \\"name\\": \\"cn-hangzhou\\",\\n \\"description\\": \\"华东 1\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询 DLF 开通地域', ], 'GetRegionStatus' => [ 'summary' => '查询 DLF 当前地域开通状态。', 'path' => '/dlf/v1/service/status', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230461', 'abilityTreeNodes' => [ 'FEATUREdlfSKHNZC', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Response', 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'status' => [ 'description' => '状态。', 'type' => 'string', 'enumValueTitles' => [ 'READY' => '已开通', 'UNINIALIZED' => '未开通', 'INITIALIZING' => '开通中', 'INITIALIZE_FAILED' => '开通失败', ], 'example' => 'READY', ], 'serviceRoleExists' => [ 'description' => '是否完成云资源访问授权。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"READY\\",\\n \\"serviceRoleExists\\": true\\n}","type":"json"}]', 'title' => '查询 DLF 当前地域开通状态', ], 'CreateCatalog' => [ 'summary' => '创建数据目录。', 'path' => '/dlf/v1/catalogs', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'catalog_demo', ], 'options' => [ 'description' => '配置参数结构体。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '"storage.data.redundancy.type" : "LRS"', 'description' => '配置参数。', ], ], 'type' => [ 'description' => '类型。', 'type' => 'string', 'required' => false, 'example' => 'PAIMON', 'enum' => [ 'PAIMON', 'ICEBERG', ], ], 'isShared' => [ 'description' => '是否是共享数据目录。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'shareId' => [ 'description' => '共享ID。', 'type' => 'string', 'required' => false, 'example' => 'share-xxxx', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建数据湖数据目录', ], 'GetCatalog' => [ 'summary' => '获取数据目录详情。', 'path' => '/dlf/v1/catalogs/{catalog}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'catalog', 'in' => 'path', 'schema' => [ 'description' => '数据目录名称。', 'type' => 'string', 'required' => true, 'example' => 'catalog_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '数据目录。', '$ref' => '#/components/schemas/Catalog', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'integer', 'format' => 'int32', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'headers' => [ 'x-acs-ext-1' => [ 'schema' => [ 'type' => 'string', ], ], ], 'schema' => [ 'title' => 'Response Code', 'description' => 'Response Code', 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'integer', 'format' => 'int32', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'integer', 'format' => 'int32', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"status\\": \\"\\",\\n \\"shareId\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"isShared\\": true\\n}","type":"json"}]', 'title' => '获取目录详情', ], 'GetCatalogById' => [ 'summary' => '获取数据目录详情。', 'path' => '/dlf/v1/catalogs/id/{id}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '数据目录。', '$ref' => '#/components/schemas/Catalog', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'integer', 'format' => 'int32', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'headers' => [ 'x-acs-ext-1' => [ 'schema' => [ 'type' => 'string', ], ], ], 'schema' => [ 'title' => 'Response Code', 'description' => 'Response Code', 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'integer', 'format' => 'int32', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'integer', 'format' => 'int32', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"status\\": \\"\\",\\n \\"shareId\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"isShared\\": true\\n}","type":"json"}]', 'title' => '获取目录详情', ], 'AlterCatalog' => [ 'summary' => '更新数据目录。', 'path' => '/dlf/v1/catalogs/{catalog}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'catalog', 'in' => 'path', 'schema' => [ 'description' => '数据目录名称。', 'type' => 'string', 'required' => true, 'example' => 'catalog_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'removals' => [ 'description' => '删除列表。', 'type' => 'array', 'items' => [ 'description' => '删除项。', 'type' => 'string', 'required' => false, 'example' => '“”', ], 'required' => false, ], 'updates' => [ 'description' => '更新列表。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '更新项。', 'example' => '“”', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AlterCatalogResponse', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ 'removed' => [ 'description' => '删除列表。', 'type' => 'array', 'items' => [ 'description' => '删除项。', 'type' => 'string', 'example' => '“”', ], ], 'updated' => [ 'description' => '更新列表。', 'type' => 'array', 'items' => [ 'description' => '更新项。', 'type' => 'string', 'example' => '“”', ], ], 'missing' => [ 'description' => '缺失列表。', 'type' => 'array', 'items' => [ 'description' => '缺失项。', 'type' => 'string', 'example' => '“”', ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"removed\\": [\\n \\"“”\\"\\n ],\\n \\"updated\\": [\\n \\"“”\\"\\n ],\\n \\"missing\\": [\\n \\"“”\\"\\n ]\\n}","type":"json"}]', 'title' => ' 更新数据目录', ], 'DropCatalog' => [ 'summary' => '删除数据湖数据目录。', 'path' => '/dlf/v1/catalogs/{catalog}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'catalog', 'in' => 'path', 'schema' => [ 'description' => '数据目录名称。', 'type' => 'string', 'required' => true, 'example' => 'catalog_name', ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ '$ref' => '#/components/schemas/ErrorResponse', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除数据湖数据目录', ], 'ListCatalogs' => [ 'summary' => '查看数据目录列表。', 'path' => '/dlf/v1/catalogs', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'catalogNamePattern', 'in' => 'query', 'schema' => [ 'description' => '目录名称模式。', 'type' => 'string', 'required' => false, 'example' => 'mi', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCatalogsResponseBody', 'description' => 'ListCatalogsResponseBody', 'type' => 'object', 'properties' => [ 'catalogs' => [ 'description' => 'Catalog 列表。', 'type' => 'array', 'items' => [ 'description' => '数据目录。', '$ref' => '#/components/schemas/Catalog', ], ], 'prepayResource' => [ 'description' => '包年包月计算资源列表。', 'type' => 'array', 'items' => [ 'description' => '包年包月计算资源。', '$ref' => '#/components/schemas/PrepayResource', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ '$ref' => '#/components/schemas/ErrorResponse', ], ], 500 => [ 'schema' => [ '$ref' => '#/components/schemas/ErrorResponse', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"catalogs\\": [\\n {\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"status\\": \\"\\",\\n \\"shareId\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"isShared\\": true\\n }\\n ],\\n \\"prepayResource\\": [\\n {\\n \\"catalogId\\": \\"\\",\\n \\"instanceId\\": \\"\\",\\n \\"catalogName\\": \\"\\",\\n \\"instanceStatus\\": \\"\\",\\n \\"cu\\": 0,\\n \\"gmtCreate\\": 0,\\n \\"expireTime\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取数据目录列表', ], 'GetCatalogToken' => [ 'summary' => '获取数据湖Catalog的临时访问凭证。', 'path' => '/dlf/v1/catalogs/{catalog}/token', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'catalog', 'in' => 'path', 'schema' => [ 'description' => '数据目录名称。', 'type' => 'string', 'required' => true, 'example' => 'catalog_demo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'token' => [ 'description' => '数据目录的临时访问凭证。', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '数据目录的临时访问凭证。', 'example' => '{'."\n" .' "fs.oss.accessKeyId": "xxx",'."\n" .' "fs.oss.accessKeySecret": "xxx",'."\n" .' "fs.oss.securityToken": "xxx",'."\n" .' "fs.oss.endpoint": "xxx",'."\n" .' "fs.oss.bucket.name": "xxx"'."\n" .' }', ], ], 'expiresAtMillis' => [ 'description' => '临时访问凭证的过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1749160909000', ], ], ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], 'code' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"token\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"fs.oss.accessKeyId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"fs.oss.accessKeySecret\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"fs.oss.securityToken\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"fs.oss.endpoint\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"fs.oss.bucket.name\\\\\\": \\\\\\"xxx\\\\\\"\\\\n }\\"\\n },\\n \\"expiresAtMillis\\": 1749160909000\\n}","type":"json"}]', 'title' => '获取数据目录的临时访问凭证', ], 'GetDatabase' => [ 'summary' => '获取数据湖具体的一个数据库的详细信息。', 'path' => '/dlf/v1/{catalogId}/databases/{database}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfHM4IA0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '数据库。', '$ref' => '#/components/schemas/Database', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"location\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"updatedAt\\": 0\\n}","type":"json"}]', 'title' => '获取数据库详情', ], 'CreateDatabase' => [ 'summary' => '创建数据库。', 'path' => '/dlf/v1/{catalogId}/databases', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfLW6EXT', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], 'options' => [ 'description' => '配置参数列表。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '配置参数。', 'example' => '“”', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 409 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => ' 创建数据库', ], 'AlterDatabase' => [ 'summary' => '更新数据库。', 'path' => '/dlf/v1/{catalogId}/databases/{database}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfLW6EXT', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => false, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'removals' => [ 'description' => '删除列表。', 'type' => 'array', 'items' => [ 'description' => '删除项。', 'type' => 'string', 'required' => false, 'example' => '“”', ], 'required' => false, ], 'updates' => [ 'description' => '更新列表。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '“”', 'description' => '更新项。', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AlterDatabaseResponse', 'description' => 'AlterDatabaseResponse', 'type' => 'object', 'properties' => [ 'removed' => [ 'description' => '删除列表。', 'type' => 'array', 'items' => [ 'description' => '删除列表。', 'type' => 'string', 'example' => '“”', ], ], 'updated' => [ 'description' => '更新列表。', 'type' => 'array', 'items' => [ 'description' => '更新项。', 'type' => 'string', 'example' => '“”', ], ], 'missing' => [ 'description' => '缺失列表。', 'type' => 'array', 'items' => [ 'description' => '缺失项。', 'type' => 'string', 'example' => '“”', ], ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"removed\\": [\\n \\"“”\\"\\n ],\\n \\"updated\\": [\\n \\"“”\\"\\n ],\\n \\"missing\\": [\\n \\"“”\\"\\n ]\\n}","type":"json"}]', 'title' => '更新数据库信息', ], 'DropDatabase' => [ 'summary' => '删除数据湖中的数据库。', 'path' => '/dlf/v1/{catalogId}/databases/{database}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfLW6EXT', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除数据库', ], 'ListDatabases' => [ 'summary' => '查看数据库列表。', 'path' => '/dlf/v1/{catalogId}/databases', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfHM4IA0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'databaseNamePattern', 'in' => 'query', 'schema' => [ 'description' => '数据库模糊匹配名。', 'type' => 'string', 'required' => false, 'example' => 'database%', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListDatabaseDetailsResponse', 'description' => 'ListDatabaseDetailsResponse', 'type' => 'object', 'properties' => [ 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], 'databases' => [ 'description' => '数据库列表。', 'type' => 'array', 'items' => [ 'description' => '数据库名。', 'type' => 'string', 'example' => 'database_name', ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\",\\n \\"databases\\": [\\n \\"database_name\\"\\n ]\\n}","type":"json"}]', 'title' => '获取数据库列表', ], 'ListDatabaseDetails' => [ 'summary' => '获取数据湖中数据库列表，分页查询。', 'path' => '/dlf/v1/{catalogId}/database-details', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfHM4IA0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '分页大小'."\n" .'默认值:'."\n" .' 1000'."\n" .'最大值:'."\n" .' 1000', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'databaseNamePattern', 'in' => 'query', 'schema' => [ 'description' => 'sql风格数据库右模糊匹配模式，支持%。', 'type' => 'string', 'required' => false, 'example' => 'database%', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListDatabaseDetailsResponse', 'description' => '返回体。', 'type' => 'object', 'properties' => [ 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => ' '."\n" .'E8ABEB1C3DB893D16576269017992F57'."\n", ], 'databaseDetails' => [ 'description' => '数据库列表。', 'type' => 'array', 'items' => [ 'description' => '数据库。', '$ref' => '#/components/schemas/Database', ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextPageToken\\": \\"\\\\t\\\\nE8ABEB1C3DB893D16576269017992F57\\\\n\\",\\n \\"databaseDetails\\": [\\n {\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"location\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取数据库详细列表', ], 'GetTableCompaction' => [ 'summary' => '查看表Compaction详情', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/compaction', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => true, 'example' => 'table_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '表合并信息。', '$ref' => '#/components/schemas/TableCompaction', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"catalogId\\": \\"\\",\\n \\"tableId\\": \\"\\",\\n \\"lastCompactedFileTime\\": 0,\\n \\"cuUsage\\": 0,\\n \\"maxLevel0FileCount\\": \\"\\",\\n \\"latencyFileEarliestTime\\": 0\\n}","type":"json"}]', 'title' => '获取表合并信息', ], 'GetTable' => [ 'summary' => '获取数据湖中数据表的详细信息。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '数据表。', '$ref' => '#/components/schemas/Table', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"isExternal\\": true,\\n \\"schemaId\\": 0,\\n \\"schema\\": {\\n \\"primaryKeys\\": [\\n \\"\\"\\n ],\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"comment\\": \\"\\",\\n \\"partitionKeys\\": [\\n \\"\\"\\n ],\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": []\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"createdBy\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"storageClass\\": \\"\\",\\n \\"storageAction\\": \\"\\",\\n \\"storageActionTimestamp\\": 0,\\n \\"icebergTableMetadata\\": {\\n \\"currentSnapshot\\": {\\n \\"sequenceNumber\\": 0,\\n \\"timestampMillis\\": 0,\\n \\"schemaId\\": 0,\\n \\"addedRows\\": 0,\\n \\"operation\\": \\"\\",\\n \\"id\\": 0,\\n \\"parentId\\": 0,\\n \\"idString\\": \\"\\",\\n \\"parentIdString\\": \\"\\",\\n \\"summary\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"partitionFields\\": [\\n {\\n \\"sourceId\\": 0,\\n \\"transform\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"fieldId\\": 0\\n }\\n ],\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"doc\\": \\"\\",\\n \\"optional\\": true,\\n \\"id\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ],\\n \\"properties\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"identifierFieldIds\\": [\\n 0\\n ]\\n },\\n \\"type\\": \\"\\"\\n}","type":"json"}]', 'title' => '获取数据表详情', ], 'CreateTable' => [ 'summary' => '创建数据湖的数据表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfY9STF0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求体参数', 'type' => 'object', 'properties' => [ 'identifier' => [ 'description' => '表标识符。', 'required' => false, '$ref' => '#/components/schemas/Identifier', ], 'schema' => [ 'description' => '表结构。', 'required' => false, '$ref' => '#/components/schemas/Schema', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '新增数据表', ], 'AlterTable' => [ 'summary' => '根据名称更新数据湖中数据表信息。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfY9STF0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'changes' => [ 'description' => '表变更信息列表。', 'type' => 'array', 'items' => [ 'description' => '表变更信息。', 'required' => false, '$ref' => '#/components/schemas/FullSchemaChange', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新数据表信息', ], 'DropTable' => [ 'summary' => '删除数据湖的数据表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfY9STF0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => ' 删除数据表', ], 'RollbackTable' => [ 'summary' => '回滚表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/rollback', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfY9STF0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => false, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'instant' => [ 'description' => '回滚实例信息。', 'required' => false, '$ref' => '#/components/schemas/FullInstant', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], 'code' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], 'code' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], 'code' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => ' 回滚表', ], 'ListTables' => [ 'summary' => '获取数据湖中数据表列表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'tableNamePattern', 'in' => 'query', 'schema' => [ 'description' => '表模糊匹配名。', 'type' => 'string', 'required' => false, 'example' => 'table%', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListTableDetailsResponse', 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'tables' => [ 'description' => '数据表列表。', 'type' => 'array', 'items' => [ 'description' => '数据表详细信息。', 'type' => 'string', 'example' => 'table_name', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tables\\": [\\n \\"table_name\\"\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取数据表列表', ], 'ListTableDetails' => [ 'summary' => '查看表详情列表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/table-details', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'tableNamePattern', 'in' => 'query', 'schema' => [ 'description' => '表模糊匹配名。', 'type' => 'string', 'required' => false, 'example' => 'table%', ], ], [ 'name' => 'type', 'in' => 'query', 'schema' => [ 'description' => '类型', 'type' => 'string', 'required' => false, 'example' => 'table', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListTableDetailsResponse', 'description' => 'ListTableDetailsResponse', 'type' => 'object', 'properties' => [ 'tableDetails' => [ 'description' => '数据表列表。', 'type' => 'array', 'items' => [ 'description' => '数据表。', '$ref' => '#/components/schemas/Table', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tableDetails\\": [\\n {\\n \\"id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"isExternal\\": true,\\n \\"schemaId\\": 0,\\n \\"schema\\": {\\n \\"primaryKeys\\": [\\n \\"\\"\\n ],\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"comment\\": \\"\\",\\n \\"partitionKeys\\": [\\n \\"\\"\\n ],\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": []\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"createdBy\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"storageClass\\": \\"\\",\\n \\"storageAction\\": \\"\\",\\n \\"storageActionTimestamp\\": 0,\\n \\"icebergTableMetadata\\": {\\n \\"currentSnapshot\\": {\\n \\"sequenceNumber\\": 0,\\n \\"timestampMillis\\": 0,\\n \\"schemaId\\": 0,\\n \\"addedRows\\": 0,\\n \\"operation\\": \\"\\",\\n \\"id\\": 0,\\n \\"parentId\\": 0,\\n \\"idString\\": \\"\\",\\n \\"parentIdString\\": \\"\\",\\n \\"summary\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"partitionFields\\": [\\n {\\n \\"sourceId\\": 0,\\n \\"transform\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"fieldId\\": 0\\n }\\n ],\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"doc\\": \\"\\",\\n \\"optional\\": true,\\n \\"id\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ],\\n \\"properties\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"identifierFieldIds\\": [\\n 0\\n ]\\n },\\n \\"type\\": \\"\\"\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取数据表详细列表', ], 'GetTableSnapshot' => [ 'summary' => '查看表快照。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/snapshot', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '数据表。', '$ref' => '#/components/schemas/TableSnapshot', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"lastFileCreationTime\\": 0,\\n \\"recordCount\\": 0,\\n \\"fileSizeInBytes\\": 0,\\n \\"fileCount\\": 0,\\n \\"snapshot\\": {\\n \\"deltaManifestList\\": \\"\\",\\n \\"changelogManifestList\\": \\"\\",\\n \\"watermark\\": 0,\\n \\"commitKind\\": \\"\\",\\n \\"deltaRecordCount\\": 0,\\n \\"baseManifestList\\": \\"\\",\\n \\"version\\": 0,\\n \\"totalRecordCount\\": 0,\\n \\"commitUser\\": \\"\\",\\n \\"logOffsets\\": {\\n \\"key\\": 0\\n },\\n \\"schemaId\\": 0,\\n \\"indexManifest\\": \\"\\",\\n \\"changelogRecordCount\\": 0,\\n \\"id\\": 0,\\n \\"timeMillis\\": 0,\\n \\"statistics\\": \\"\\",\\n \\"commitIdentifier\\": 0,\\n \\"parentIdString\\": \\"\\",\\n \\"sequenceNumber\\": 0,\\n \\"summary\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"idString\\": \\"\\"\\n },\\n \\"totalBuckets\\": 0\\n}","type":"json"}]', 'title' => '获取表快照', ], 'ListSnapshots' => [ 'summary' => '查看表快照列表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/snapshots', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => true, 'example' => 'table_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListTableDetailsResponse', 'description' => 'ListTableDetailsResponse', 'type' => 'object', 'properties' => [ 'snapshots' => [ 'description' => '快照列表。', 'type' => 'array', 'items' => [ 'description' => '快照。', '$ref' => '#/components/schemas/Snapshot', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"snapshots\\": [\\n {\\n \\"deltaManifestList\\": \\"\\",\\n \\"changelogManifestList\\": \\"\\",\\n \\"watermark\\": 0,\\n \\"commitKind\\": \\"\\",\\n \\"deltaRecordCount\\": 0,\\n \\"baseManifestList\\": \\"\\",\\n \\"version\\": 0,\\n \\"totalRecordCount\\": 0,\\n \\"commitUser\\": \\"\\",\\n \\"logOffsets\\": {\\n \\"key\\": 0\\n },\\n \\"schemaId\\": 0,\\n \\"indexManifest\\": \\"\\",\\n \\"changelogRecordCount\\": 0,\\n \\"id\\": 0,\\n \\"timeMillis\\": 0,\\n \\"statistics\\": \\"\\",\\n \\"commitIdentifier\\": 0,\\n \\"parentIdString\\": \\"\\",\\n \\"sequenceNumber\\": 0,\\n \\"summary\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"idString\\": \\"\\"\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取快照列表', ], 'GetTableToken' => [ 'summary' => '获取数据湖表的临时访问凭证', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/token', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'isInternal', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => '是否是内网访问', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'table_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'token' => [ 'description' => '表的数据目录的临时访问凭证。', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '表的数据目录的临时访问凭证。', 'example' => '{'."\n" .' "fs.oss.accessKeyId": "xxx",'."\n" .' "fs.oss.accessKeySecret": "xxx",'."\n" .' "fs.oss.securityToken": "xxx",'."\n" .' "fs.oss.endpoint": "xxx"'."\n" .' }', ], ], 'expiresAtMillis' => [ 'description' => '临时访问凭证的过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1749160909000', ], ], ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], 'code' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"token\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"fs.oss.accessKeyId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"fs.oss.accessKeySecret\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"fs.oss.securityToken\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"fs.oss.endpoint\\\\\\": \\\\\\"xxx\\\\\\"\\\\n }\\"\\n },\\n \\"expiresAtMillis\\": 1749160909000\\n}","type":"json"}]', 'title' => '获取表数据的临时访问凭证', ], 'ListViews' => [ 'summary' => '查看视图名字列表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/views', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'viewNamePattern', 'in' => 'query', 'schema' => [ 'description' => '视图模糊匹配名。', 'type' => 'string', 'required' => false, 'example' => 'view%', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListViewsResponse', 'description' => 'ListViewsResponse', 'type' => 'object', 'properties' => [ 'views' => [ 'description' => '视图名字列表。', 'type' => 'array', 'items' => [ 'description' => '视图名字信息。', 'type' => 'string', 'example' => 'view_name', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57'."\n", ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"views\\": [\\n \\"view_name\\"\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\\\n\\"\\n}","type":"json"}]', 'title' => '获取视图列表', ], 'ListViewDetails' => [ 'summary' => '查看视图详情列表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/view-details', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'viewNamePattern', 'in' => 'query', 'schema' => [ 'description' => '视图模糊匹配名。', 'type' => 'string', 'required' => false, 'example' => 'view%', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListViewDetailsResponse', 'description' => 'ListViewDetailsResponse', 'type' => 'object', 'properties' => [ 'viewDetails' => [ 'description' => '视图列表。', 'type' => 'array', 'items' => [ 'description' => '视图详情。', '$ref' => '#/components/schemas/View', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '“”', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"viewDetails\\": [\\n {\\n \\"schema\\": {\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"id\\": 0,\\n \\"type\\": {\\n \\"type\\": \\"\\",\\n \\"fields\\": []\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ],\\n \\"query\\": \\"\\",\\n \\"dialects\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"comment\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"“”\\"\\n}","type":"json"}]', 'title' => '获取视图详细列表', ], 'ListFunctions' => [ 'summary' => '查看函数列表', 'path' => '/dlf/v1/{catalogId}/databases/{database}/functions', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-iceberg-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'functionNamePattern', 'in' => 'query', 'schema' => [ 'description' => '函数模糊匹配名。', 'type' => 'string', 'required' => false, 'example' => 'function%', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListFunctionsResponse', 'description' => 'ListFunctionsResponse', 'type' => 'object', 'properties' => [ 'functions' => [ 'description' => '函数的定义。', 'type' => 'array', 'items' => [ 'description' => '函数的定义。', 'type' => 'string', 'example' => '[]', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"functions\\": [\\n \\"[]\\"\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取函数列表', ], 'ListPartitions' => [ 'summary' => 'listPartitions', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/partitions', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => false, 'example' => 'clg-paimon-xxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'partitionNamePattern', 'in' => 'query', 'schema' => [ 'description' => '分区名规则。', 'type' => 'string', 'required' => false, 'example' => 'partition', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'partitions' => [ 'description' => '分区列表。', 'type' => 'array', 'items' => [ 'description' => '分区。', '$ref' => '#/components/schemas/Partition', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"partitions\\": [\\n {\\n \\"lastFileCreationTime\\": 0,\\n \\"recordCount\\": 0,\\n \\"fileSizeInBytes\\": 0,\\n \\"fileCount\\": 0,\\n \\"done\\": true,\\n \\"spec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"createdAt\\": 0,\\n \\"createdBy\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"storageClass\\": \\"\\",\\n \\"storageAction\\": \\"\\",\\n \\"storageActionTimestamp\\": 0,\\n \\"totalBuckets\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取数据表分区列表。', ], 'CreateShare' => [ 'summary' => '创建共享。', 'path' => '/dlf/v1/share/shares', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'shareName' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => true, 'example' => 'share_name', ], 'comment' => [ 'description' => '共享的注释信息。', 'type' => 'string', 'required' => false, 'example' => 'demo', ], 'enableWrite' => [ 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 409 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建共享', ], 'GetShare' => [ 'summary' => '获取共享。', 'path' => '/dlf/v1/share/shares/{share}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'share', 'in' => 'path', 'schema' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '共享结构。', '$ref' => '#/components/schemas/Share', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"providerTenantId\\": 0,\\n \\"shareId\\": \\"\\",\\n \\"shareName\\": \\"\\",\\n \\"comment\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"createdBy\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"enableWrite\\": true\\n}","type":"json"}]', 'title' => '获取共享', ], 'AlterShare' => [ 'summary' => '更新共享。', 'path' => '/dlf/v1/share/shares/{share}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'share', 'in' => 'path', 'schema' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'shareName' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], 'comment' => [ 'description' => '共享的注释信息。', 'type' => 'string', 'required' => false, 'example' => 'description', ], 'enableWrite' => [ 'description' => '开启共享写入权限', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '变更共享', ], 'DropShare' => [ 'summary' => '删除共享。', 'path' => '/dlf/v1/share/shares/{share}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'share', 'in' => 'path', 'schema' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], ], ], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除共享', ], 'ListProvidedShares' => [ 'summary' => '获取提供的共享列表。', 'path' => '/dlf/v1/share/shares/list/provided', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '""', ], 'shares' => [ 'description' => '共享列表。', 'type' => 'array', 'items' => [ 'description' => '共享。', '$ref' => '#/components/schemas/Share', ], ], ], ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextPageToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"shares\\": [\\n {\\n \\"providerTenantId\\": 0,\\n \\"shareId\\": \\"\\",\\n \\"shareName\\": \\"\\",\\n \\"comment\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"createdBy\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"enableWrite\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取提供的共享列表', ], 'ListReceivedShares' => [ 'summary' => '获取接收的共享列表。', 'path' => '/dlf/v1/share/shares/list/received', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '""', ], 'shares' => [ 'description' => '接收的共享列表。', 'type' => 'array', 'items' => [ 'description' => '接收的共享。', '$ref' => '#/components/schemas/ReceivedShare', ], ], ], ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextPageToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"shares\\": [\\n {\\n \\"providerTenantId\\": 0,\\n \\"shareId\\": \\"\\",\\n \\"shareName\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"createdBy\\": \\"\\",\\n \\"updatedAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"catalogName\\": \\"\\",\\n \\"comment\\": \\"\\",\\n \\"enableWrite\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取接收的共享列表', ], 'CreateReceiver' => [ 'summary' => '创建接收者。', 'path' => '/dlf/v1/share/receivers', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'receiverName' => [ 'description' => '接收者名称。', 'type' => 'string', 'required' => false, 'example' => 'receiver_name', ], 'receiverTenantId' => [ 'description' => '接收者账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1111', ], 'comment' => [ 'description' => '注释。', 'type' => 'string', 'required' => false, 'example' => '客户A。', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 409 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建接收者', ], 'GetReceiver' => [ 'summary' => '获取接收者。', 'path' => '/dlf/v1/share/receivers/{receiver}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'receiver', 'in' => 'path', 'schema' => [ 'description' => '接收者名称。', 'type' => 'string', 'required' => false, 'example' => 'receiver_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '接收者。', '$ref' => '#/components/schemas/Receiver', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"receiverName\\": \\"\\",\\n \\"receiverTenantId\\": 0,\\n \\"comment\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"updatedAt\\": 0\\n}","type":"json"}]', 'title' => '获取接收者', ], 'AlterReceiver' => [ 'summary' => '更新接收者。', 'path' => '/dlf/v1/share/receivers/{receiver}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'receiver', 'in' => 'path', 'schema' => [ 'description' => '接收者名称。', 'type' => 'string', 'required' => false, 'example' => '1111', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'receiverName' => [ 'description' => '接收者名称。', 'type' => 'string', 'required' => false, 'example' => 'receiver_name', ], 'comment' => [ 'description' => '注释。', 'type' => 'string', 'required' => false, 'example' => '客户A。', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '变更接收者', ], 'DropReceiver' => [ 'summary' => '删除接收者', 'path' => '/dlf/v1/share/receivers/{receiver}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'receiver', 'in' => 'path', 'schema' => [ 'description' => '接收者名称。', 'type' => 'string', 'required' => false, 'example' => 'receiver_name', ], ], ], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除接收者', ], 'ListReceivers' => [ 'summary' => '获取接收者列表', 'path' => '/dlf/v1/share/receivers', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'receiverName', 'in' => 'query', 'schema' => [ 'description' => '接收者名称。', 'type' => 'string', 'required' => false, 'example' => 'receiver_name', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""'."\n", ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCatalogsResponseBody', 'description' => 'ListCatalogsResponseBody', 'type' => 'object', 'properties' => [ 'receivers' => [ 'description' => '接收者列表。', 'type' => 'array', 'items' => [ 'description' => '接收者。', '$ref' => '#/components/schemas/Receiver', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '""', ], ], ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"receivers\\": [\\n {\\n \\"receiverName\\": \\"\\",\\n \\"receiverTenantId\\": 0,\\n \\"comment\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', 'title' => '获取接收者列表', ], 'ListShareReceivers' => [ 'summary' => '获取共享中的接收者列表', 'path' => '/dlf/v1/share/shares/{share}/receivers', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'share', 'in' => 'path', 'schema' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListCatalogsResponseBody', 'description' => '共享接收列表。', 'type' => 'object', 'properties' => [ 'receivers' => [ 'description' => '接收者列表。', 'type' => 'array', 'items' => [ 'description' => '接收者。', '$ref' => '#/components/schemas/Receiver', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '“”', ], ], ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"receivers\\": [\\n {\\n \\"receiverName\\": \\"\\",\\n \\"receiverTenantId\\": 0,\\n \\"comment\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"“”\\"\\n}","type":"json"}]', 'title' => '获取共享接收列表', ], 'AlterShareReceivers' => [ 'summary' => '更新共享中的接收者', 'path' => '/dlf/v1/share/shares/{share}/receivers', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266447', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'share', 'in' => 'path', 'schema' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'addedReceivers' => [ 'description' => '新增接收者列表。', 'type' => 'array', 'items' => [ 'description' => '接收者。', 'type' => 'string', 'required' => false, 'example' => '1111', ], 'required' => false, ], 'removedReceivers' => [ 'description' => '删除接收者列表。', 'type' => 'array', 'items' => [ 'description' => '接收者。', 'type' => 'string', 'required' => false, 'example' => '1111', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '变更共享接收者', ], 'AlterShareResources' => [ 'summary' => '更改共享资源。', 'path' => '/dlf/v1/share/shares/{share}/resources', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'catalogId' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => false, 'example' => 'clg-paimon-xxxx', ], 'shareResourceList' => [ 'description' => '共享资源列表。', 'type' => 'array', 'items' => [ 'description' => '共享资源。', 'required' => false, '$ref' => '#/components/schemas/ShareResource', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'share', 'in' => 'path', 'schema' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 409 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '变更共享资源', ], 'ListShareResources' => [ 'summary' => '获取共享资源列表', 'path' => '/dlf/v1/share/shares/{share}/resources', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'share', 'in' => 'path', 'schema' => [ 'description' => '共享名称。', 'type' => 'string', 'required' => false, 'example' => 'share_name', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""'."\n", ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '本次请求所返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'catalogId' => [ 'description' => '数据目录ID。', 'type' => 'string', 'example' => 'clg-paimon-xxxx', ], 'shareResources' => [ 'description' => '共享资源列表。', 'type' => 'array', 'items' => [ 'description' => '共享资源。', '$ref' => '#/components/schemas/ShareResource', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '""', ], ], ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"catalogId\\": \\"clg-paimon-xxxx\\",\\n \\"shareResources\\": [\\n {\\n \\"shareType\\": \\"\\",\\n \\"databaseName\\": \\"\\",\\n \\"tableName\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"updatedBy\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', 'title' => '获取共享资源列表', ], 'BatchGrantPermissions' => [ 'summary' => '批量授权。', 'path' => '/dlf/v1/auth/permissions/{catalogId}/batchgrant', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => false, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'struct', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'permissions' => [ 'description' => '权限列表。', 'type' => 'array', 'items' => [ 'description' => '权限。', 'required' => false, '$ref' => '#/components/schemas/Permission', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'failurePermissions' => [ 'description' => '授权失败列表。', 'type' => 'array', 'items' => [ 'description' => '授权失败项。', '$ref' => '#/components/schemas/FailurePermission', ], ], 'success' => [ 'description' => 'true 接口调用成功，false 接口调用失败', 'type' => 'boolean', 'example' => 'True', ], 'errorMessage' => [ 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', 'type' => 'string', 'example' => '空', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"failurePermissions\\": [\\n {\\n \\"errorMessage\\": \\"\\",\\n \\"errorCode\\": \\"\\",\\n \\"permission\\": {\\n \\"resourceType\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"table\\": \\"\\",\\n \\"access\\": \\"\\",\\n \\"principal\\": \\"\\",\\n \\"columns\\": {\\n \\"columnNames\\": [\\n \\"\\"\\n ],\\n \\"excludedColumnNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"function\\": \\"\\",\\n \\"view\\": \\"\\",\\n \\"expireTime\\": \\"\\",\\n \\"rowFilter\\": {\\n \\"expression\\": \\"\\",\\n \\"predicate\\": \\"\\"\\n }\\n }\\n }\\n ],\\n \\"success\\": true,\\n \\"errorMessage\\": \\"空\\"\\n}","type":"json"}]', 'title' => '批量对User/数据湖角色授予资源的操作权限', ], 'BatchRevokePermissions' => [ 'summary' => '批量取消授权。', 'path' => '/dlf/v1/auth/permissions/{catalogId}/batchrevoke', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => false, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'HTTP 请求体。', 'type' => 'object', 'properties' => [ 'permissions' => [ 'description' => '待撤销授权列表。', 'type' => 'array', 'items' => [ 'description' => '撤销权限项。', 'required' => false, '$ref' => '#/components/schemas/Permission', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'failurePermissions' => [ 'description' => '批量授权撤销失败结果。', 'type' => 'array', 'items' => [ 'description' => '批量授权撤销失败结果列表。', '$ref' => '#/components/schemas/FailurePermission', ], ], 'success' => [ 'description' => 'true 接口调用成功，false 接口调用失败。', 'type' => 'boolean', 'example' => 'true', ], 'errorMessage' => [ 'description' => '- 当success为false，返回业务错误信息。'."\n" ."\n" .'- 当success为true，返回空值。', 'type' => 'string', 'example' => '空', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"failurePermissions\\": [\\n {\\n \\"errorMessage\\": \\"\\",\\n \\"errorCode\\": \\"\\",\\n \\"permission\\": {\\n \\"resourceType\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"table\\": \\"\\",\\n \\"access\\": \\"\\",\\n \\"principal\\": \\"\\",\\n \\"columns\\": {\\n \\"columnNames\\": [\\n \\"\\"\\n ],\\n \\"excludedColumnNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"function\\": \\"\\",\\n \\"view\\": \\"\\",\\n \\"expireTime\\": \\"\\",\\n \\"rowFilter\\": {\\n \\"expression\\": \\"\\",\\n \\"predicate\\": \\"\\"\\n }\\n }\\n }\\n ],\\n \\"success\\": true,\\n \\"errorMessage\\": \\"空\\"\\n}","type":"json"}]', 'title' => '批量取消对User/数据湖角色授予的权限', ], 'ListPermissions' => [ 'summary' => '获取指定资源或指定Principal的权限信息。', 'path' => '/dlf/v1/auth/permissions/{catalogId}/list', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => false, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'title' => 'A short description of struct', 'description' => '权限资源类型。', 'type' => 'string', 'required' => true, 'example' => 'CATALOG', ], ], [ 'name' => 'database', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'database_name', ], ], [ 'name' => 'table', 'in' => 'query', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], [ 'name' => 'function', 'in' => 'query', 'schema' => [ 'description' => '函数名', 'type' => 'string', 'required' => false, 'example' => 'function_name', ], ], [ 'name' => 'view', 'in' => 'query', 'schema' => [ 'description' => '视图名', 'type' => 'string', 'required' => false, 'example' => 'view_name', ], ], [ 'name' => 'principal', 'in' => 'query', 'schema' => [ 'description' => '用户资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::[accountId]:user/user_name', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'permissions' => [ 'description' => '权限列表。', 'type' => 'array', 'items' => [ 'description' => '权限项。', '$ref' => '#/components/schemas/Permission', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"permissions\\": [\\n {\\n \\"resourceType\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"table\\": \\"\\",\\n \\"access\\": \\"\\",\\n \\"principal\\": \\"\\",\\n \\"columns\\": {\\n \\"columnNames\\": [\\n \\"\\"\\n ],\\n \\"excludedColumnNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"function\\": \\"\\",\\n \\"view\\": \\"\\",\\n \\"expireTime\\": \\"\\",\\n \\"rowFilter\\": {\\n \\"expression\\": \\"\\",\\n \\"predicate\\": \\"\\"\\n }\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取权限列表', ], 'CreateRole' => [ 'summary' => '创建角色。', 'path' => '/dlf/v1/auth/roles', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'HTTP 请求体。', 'type' => 'object', 'properties' => [ 'roleName' => [ 'description' => '角色名称。', 'type' => 'string', 'required' => false, 'example' => 'role_name', ], 'displayName' => [ 'description' => '角色显示名称。', 'type' => 'string', 'required' => false, 'example' => 'role_display_name', ], 'description' => [ 'description' => '角色描述。', 'type' => 'string', 'required' => false, 'example' => 'role_description', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 409 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建角色', ], 'GetRole' => [ 'summary' => '获取角色。', 'path' => '/dlf/v1/auth/roles', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'rolePrincipal', 'in' => 'query', 'schema' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:dlf::[accountId]:role/role_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '角色信息。', '$ref' => '#/components/schemas/Role', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"createdAt\\": 0,\\n \\"isPredefined\\": \\"\\",\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"roleName\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"rolePrincipal\\": \\"\\",\\n \\"users\\": [\\n {\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"userName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"userId\\": \\"\\",\\n \\"userPrincipal\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"updatedAt\\": 0\\n}","type":"json"}]', 'title' => '获取角色', ], 'UpdateRole' => [ 'summary' => '更新角色。', 'path' => '/dlf/v1/auth/roles', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'HTTP 请求体。', 'type' => 'object', 'properties' => [ 'displayName' => [ 'description' => '角色显示名称。', 'type' => 'string', 'required' => false, 'example' => 'role_display_name', ], 'description' => [ 'description' => '角色描述。', 'type' => 'string', 'required' => false, 'example' => 'role_description'."\n", ], 'rolePrincipal' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:dlf::[accountId]:role/role_name', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新角色', ], 'DeleteRole' => [ 'summary' => '删除角色。', 'path' => '/dlf/v1/auth/roles', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'rolePrincipal', 'in' => 'query', 'schema' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:dlf::[accountId]:role/role_name', ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除角色', ], 'ListRoles' => [ 'summary' => '获取角色列表。', 'path' => '/dlf/v1/auth/roles/list', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'roleName', 'in' => 'query', 'schema' => [ 'description' => '角色名称。', 'type' => 'string', 'required' => false, 'example' => 'role_name', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'roles' => [ 'description' => '角色信息列表。', 'type' => 'array', 'items' => [ 'description' => '角色信息。', '$ref' => '#/components/schemas/Role', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"roles\\": [\\n {\\n \\"createdAt\\": 0,\\n \\"isPredefined\\": \\"\\",\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"roleName\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"rolePrincipal\\": \\"\\",\\n \\"users\\": [\\n {\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"userName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"userId\\": \\"\\",\\n \\"userPrincipal\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取角色列表', ], 'GetUser' => [ 'summary' => '获取用户。', 'path' => '/dlf/v1/auth/users', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'userPrincipal', 'in' => 'query', 'schema' => [ 'description' => '用户的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::[accountId]:user/user_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '用户信息。', '$ref' => '#/components/schemas/User', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"userName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"userId\\": \\"\\",\\n \\"userPrincipal\\": \\"\\",\\n \\"updatedAt\\": 0\\n}","type":"json"}]', 'title' => '获取用户', ], 'ListUsers' => [ 'summary' => '获取用户列表。', 'path' => '/dlf/v1/auth/users/list', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'userName', 'in' => 'query', 'schema' => [ 'description' => '用户名称。', 'type' => 'string', 'required' => false, 'example' => 'user_name', ], ], [ 'name' => 'type', 'in' => 'query', 'schema' => [ 'description' => '用户类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'RAM_USER' => 'RAM_USER', 'RAM_ROLE' => 'RAM_ROLE', ], 'example' => 'RAM_USER', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListUserResponse', 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'users' => [ 'description' => '用户信息列表。', 'type' => 'array', 'items' => [ 'description' => '用户信息。', '$ref' => '#/components/schemas/User', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"users\\": [\\n {\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"userName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"userId\\": \\"\\",\\n \\"userPrincipal\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取用户列表', ], 'ListRoleUsers' => [ 'summary' => '获取角色用户列表。', 'path' => '/dlf/v1/auth/roles/users/list', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'rolePrincipal', 'in' => 'query', 'schema' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:dlf::[accountId]:role/role_name', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""'."\n", ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'users' => [ 'description' => '用户信息列表。', 'type' => 'array', 'items' => [ 'description' => '用户信息。', '$ref' => '#/components/schemas/User', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"users\\": [\\n {\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"userName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"userId\\": \\"\\",\\n \\"userPrincipal\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取角色用户列表', ], 'UpdateRoleUsers' => [ 'summary' => '更新角色用户。', 'path' => '/dlf/v1/auth/roles/users', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'HTTP 请求体。', 'type' => 'object', 'properties' => [ 'userPrincipals' => [ 'description' => '用户的资源描述符列表。', 'type' => 'array', 'items' => [ 'description' => '用户的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::[accountId]:user/user_name', ], 'required' => false, ], 'rolePrincipal' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:dlf::[accountId]:role/role_name', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新角色用户', ], 'ListUserRoles' => [ 'summary' => '获取用户角色列表。', 'path' => '/dlf/v1/auth/users/roles/list', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'userPrincipal', 'in' => 'query', 'schema' => [ 'description' => '用户的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::[accountId]:user/user_name', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回消息体。', 'type' => 'object', 'properties' => [ 'roles' => [ 'description' => '角色信息列表。', 'type' => 'array', 'items' => [ 'description' => '角色信息。', '$ref' => '#/components/schemas/Role', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"roles\\": [\\n {\\n \\"createdAt\\": 0,\\n \\"isPredefined\\": \\"\\",\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"roleName\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"rolePrincipal\\": \\"\\",\\n \\"users\\": [\\n {\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"userName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"userId\\": \\"\\",\\n \\"userPrincipal\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\"\\n}","type":"json"}]', 'title' => '获取用户角色列表', ], 'GrantRoleToUsers' => [ 'summary' => '批量授予角色权限给用户。', 'path' => '/dlf/v1/auth/roles/grant', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'HTTP 请求体。', 'type' => 'object', 'properties' => [ 'userPrincipals' => [ 'description' => '用户的资源描述符列表。', 'type' => 'array', 'items' => [ 'description' => '用户的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::[accountId]:user/user_name', ], 'required' => false, ], 'rolePrincipal' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:dlf::[accountId]:role/role_name', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '将角色授予用户', ], 'RevokeRoleFromUsers' => [ 'summary' => '将多个用户从角色中移除。', 'path' => '/dlf/v1/auth/roles/revoke', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'HTTP 请求体。', 'type' => 'object', 'properties' => [ 'userPrincipals' => [ 'description' => '用户的资源描述符列表。', 'type' => 'array', 'items' => [ 'description' => '用户的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::[accountId]:user/user_name', ], 'required' => false, ], 'rolePrincipal' => [ 'description' => '角色的资源描述符。', 'type' => 'string', 'required' => false, 'example' => 'acs:dlf::[accountId]:role/role_name', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '将用户从角色中移除', ], 'RefreshUserSync' => [ 'summary' => '刷新用户同步。', 'path' => '/dlf/v1/auth/usersync', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlf4RLCBT', ], ], 'parameters' => [], 'responses' => [ 200 => [], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '用户同步', ], 'GetCatalogSummary' => [ 'summary' => '获取数据目录存储概览。', 'path' => '/dlf/v1/{catalogId}/storage-summary', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'date', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '数据目录存储概览。', '$ref' => '#/components/schemas/CatalogSummary', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"databaseCount\\": {\\n \\"lastDayValue\\": 0,\\n \\"lastMonthValue\\": 0,\\n \\"currentValue\\": 0\\n },\\n \\"tableCount\\": {\\n \\"lastDayValue\\": 0,\\n \\"lastMonthValue\\": 0,\\n \\"currentValue\\": 0\\n },\\n \\"partitionCount\\": {\\n \\"lastDayValue\\": 0,\\n \\"lastMonthValue\\": 0,\\n \\"currentValue\\": 0\\n },\\n \\"apiVisitCountMonthly\\": 0,\\n \\"fileAccessCountMonthly\\": 0,\\n \\"throughputMonthly\\": 0,\\n \\"generatedDate\\": \\"\\",\\n \\"objTypeStandardSize\\": 0,\\n \\"objTypeIaSize\\": 0,\\n \\"objTypeArchiveSize\\": 0,\\n \\"objTypeColdArchiveSize\\": 0\\n}","type":"json"}]', 'title' => '获取数据目录存储概览', ], 'GetCatalogSummaryTrend' => [ 'summary' => '获取数据目录存储概览趋势。', 'path' => '/dlf/v1/{catalogId}/storage-summary/trend', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'startDate', 'in' => 'query', 'schema' => [ 'description' => '起始日期（yyyy-MM-dd格式，结果包含起始日期）。', 'type' => 'string', 'required' => true, 'example' => '2025-05-01', ], ], [ 'name' => 'endDate', 'in' => 'query', 'schema' => [ 'description' => '结束日期（yyyy-MM-dd格式，结果包含结束日期）。', 'type' => 'string', 'required' => true, 'example' => '2025-06-01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '存储概览趋势。', '$ref' => '#/components/schemas/CatalogSummaryTrend', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"apiVisitCount\\": [\\n {\\n \\"date\\": \\"\\",\\n \\"value\\": 0\\n }\\n ],\\n \\"fileAccessCount\\": [\\n {\\n \\"date\\": \\"\\",\\n \\"value\\": 0\\n }\\n ],\\n \\"throughput\\": [\\n {\\n \\"date\\": \\"\\",\\n \\"value\\": 0\\n }\\n ],\\n \\"totalMetaCount\\": [],\\n \\"totalFileCount\\": [],\\n \\"totalFileSizeInBytes\\": []\\n}","type":"json"}]', 'title' => '获取数据目录存储概览趋势', ], 'GetDatabaseSummary' => [ 'summary' => '获取库存储概览。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/storage-summary', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '库名称。', 'type' => 'string', 'required' => true, 'example' => 'default', ], ], [ 'name' => 'date', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '库存储概览。', '$ref' => '#/components/schemas/DatabaseSummary', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"databaseName\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"location\\": \\"\\",\\n \\"tableCount\\": 0,\\n \\"partitionCount\\": 0,\\n \\"totalFileSizeInBytes\\": 0,\\n \\"totalFileCount\\": 0,\\n \\"generatedDate\\": \\"\\",\\n \\"objTypeStandardSize\\": 0,\\n \\"objTypeIaSize\\": 0,\\n \\"objTypeArchiveSize\\": 0,\\n \\"objTypeColdArchiveSize\\": 0,\\n \\"totalMetaSizeInBytes\\": 0,\\n \\"totalMetaFileCount\\": 0\\n}","type":"json"}]', 'title' => '获取库存储概览', ], 'GetTableSummary' => [ 'summary' => '获取表存储概览。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/storage-summary', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '库名称。', 'type' => 'string', 'required' => true, 'example' => 'default', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'table1', ], ], [ 'name' => 'date', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => ' 表存储概览。', '$ref' => '#/components/schemas/TableSummary', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"databaseName\\": \\"\\",\\n \\"tableName\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"partitionCount\\": 0,\\n \\"unaccessedStdPartitionCount30d\\": 0,\\n \\"unaccessedStdIaPartitionCount180d\\": 0,\\n \\"totalFileSizeInBytes\\": 0,\\n \\"totalFileCount\\": 0,\\n \\"lastAccessTime\\": 0,\\n \\"generatedDate\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"storageClass\\": \\"\\",\\n \\"storageActionTimestamp\\": 0,\\n \\"objTypeStandardSize\\": 0,\\n \\"objTypeIaSize\\": 0,\\n \\"objTypeArchiveSize\\": 0,\\n \\"objTypeColdArchiveSize\\": 0,\\n \\"updatedAt\\": 0,\\n \\"totalMetaSizeInBytes\\": 0,\\n \\"totalMetaFileCount\\": 0,\\n \\"storageActionParams\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '获取表存储概览', ], 'ListPartitionSummaries' => [ 'summary' => '获取分区存储概览列表。', 'path' => '/dlf/v1/{catalogId}/databases/{database}/tables/{table}/partitions/storage-summary', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-paimon-xxxx', ], ], [ 'name' => 'database', 'in' => 'path', 'schema' => [ 'description' => '库名称。', 'type' => 'string', 'required' => true, 'example' => 'default', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'table1', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'partitionNamePattern', 'in' => 'query', 'schema' => [ 'description' => '分区名规则。', 'type' => 'string', 'required' => false, 'example' => 'hh=10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '分区存储概览返回结果。', '$ref' => '#/components/schemas/PartitionSummaries', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"partitions\\": [\\n {\\n \\"databaseName\\": \\"\\",\\n \\"tableName\\": \\"\\",\\n \\"partitionName\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"totalFileSizeInBytes\\": 0,\\n \\"totalFileCount\\": 0,\\n \\"lastAccessTime\\": 0,\\n \\"updatedAt\\": 0,\\n \\"storageClass\\": \\"\\",\\n \\"storageActionTimestamp\\": 0,\\n \\"storageActionParams\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ],\\n \\"nextPageToken\\": \\"\\"\\n}","type":"json"}]', 'title' => '获取分区存储概览列表', ], 'ListIcebergTableDetails' => [ 'summary' => '查看iceberg表详情列表', 'path' => '/iceberg/dlf/v1/{catalogId}/namespaces/{namespace}/table-details', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-iceberg-xxxx', ], ], [ 'name' => 'namespace', 'in' => 'path', 'schema' => [ 'description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'namespace_name', ], ], [ 'name' => 'tableNamePattern', 'in' => 'query', 'schema' => [ 'description' => '表模糊匹配名。', 'type' => 'string', 'required' => false, 'example' => 'table%', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListTableDetailsResponse', 'description' => 'ListTableDetailsResponse', 'type' => 'object', 'properties' => [ 'tableDetails' => [ 'description' => '数据表列表。', 'type' => 'array', 'items' => [ 'description' => '数据表。', '$ref' => '#/components/schemas/IcebergTable', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '""', ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tableDetails\\": [\\n {\\n \\"owner\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"version\\": 0,\\n \\"icebergTableMetadata\\": {\\n \\"currentSnapshot\\": {\\n \\"sequenceNumber\\": 0,\\n \\"timestampMillis\\": 0,\\n \\"schemaId\\": 0,\\n \\"addedRows\\": 0,\\n \\"operation\\": \\"\\",\\n \\"id\\": 0,\\n \\"parentId\\": 0,\\n \\"idString\\": \\"\\",\\n \\"parentIdString\\": \\"\\",\\n \\"summary\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"partitionFields\\": [\\n {\\n \\"sourceId\\": 0,\\n \\"transform\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"fieldId\\": 0\\n }\\n ],\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"doc\\": \\"\\",\\n \\"optional\\": true,\\n \\"id\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ],\\n \\"properties\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"identifierFieldIds\\": [\\n 0\\n ]\\n },\\n \\"updatedAt\\": 0\\n }\\n ],\\n \\"nextPageToken\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', 'title' => '获取Iceberg数据表详细列表', ], 'ListIcebergSnapshots' => [ 'summary' => '查看iceberg表快照列表', 'path' => '/iceberg/dlf/v1/{catalogId}/namespaces/{namespace}/tables/{table}/snapshots', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-iceberg-xxxx', ], ], [ 'name' => 'namespace', 'in' => 'path', 'schema' => [ 'description' => '项目空间名称。', 'type' => 'string', 'required' => true, 'example' => 'namespace_test', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => true, 'example' => 'table_name', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListTableDetailsResponse', 'description' => 'ListTableDetailsResponse', 'type' => 'object', 'properties' => [ 'snapshots' => [ 'description' => '快照列表。', 'type' => 'array', 'items' => [ 'description' => '快照。', '$ref' => '#/components/schemas/IcebergSnapshot', ], ], 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => 'E8ABEB1C3DB893D16576269017992F57'."\n", ], ], ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"snapshots\\": [\\n {\\n \\"sequenceNumber\\": 0,\\n \\"timestampMillis\\": 0,\\n \\"schemaId\\": 0,\\n \\"addedRows\\": 0,\\n \\"operation\\": \\"\\",\\n \\"id\\": 0,\\n \\"parentId\\": 0,\\n \\"idString\\": \\"\\",\\n \\"parentIdString\\": \\"\\",\\n \\"summary\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ],\\n \\"nextPageToken\\": \\"E8ABEB1C3DB893D16576269017992F57\\\\n\\"\\n}","type":"json"}]', 'title' => '获取快照列表', ], 'ListIcebergNamespaceDetails' => [ 'summary' => '查看iceberg数据库列表', 'path' => '/iceberg/dlf/v1/{catalogId}/namespace-details', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfHM4IA0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-iceberg-xxx', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '分页大小'."\n" .'默认值:'."\n" .' 1000'."\n" .'最大值:'."\n" .' 1000', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'pageToken', 'in' => 'query', 'schema' => [ 'description' => '翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（\'\'）。', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'namespaceNamePattern', 'in' => 'query', 'schema' => [ 'description' => 'sql风格数据库右模糊匹配模式，支持%。', 'type' => 'string', 'required' => false, 'example' => 'namespace%', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ListNamespaceDetailsResponse', 'description' => 'ListNamespaceDetailsResponse', 'type' => 'object', 'properties' => [ 'nextPageToken' => [ 'description' => '翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。', 'type' => 'string', 'example' => '""', ], 'namespaceDetails' => [ 'description' => '命名空间列表。', 'type' => 'array', 'items' => [ 'description' => '命名空间。', '$ref' => '#/components/schemas/Namespace', ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextPageToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"namespaceDetails\\": [\\n {\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"location\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"updatedAt\\": 0\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看命名空间详细列表', ], 'GetIcebergTable' => [ 'summary' => '查看表', 'path' => '/iceberg/dlf/v1/{catalogId}/namespaces/{namespace}/tables/{table}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfXYB6JJ', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-iceberg-xxxx', ], ], [ 'name' => 'namespace', 'in' => 'path', 'schema' => [ 'description' => '命名空间名称。', 'type' => 'string', 'required' => false, 'example' => 'namespace_name', ], ], [ 'name' => 'table', 'in' => 'path', 'schema' => [ 'description' => '数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '数据表。', '$ref' => '#/components/schemas/IcebergTable', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'code' => [ 'type' => 'string', ], 'message' => [ 'type' => 'string', ], 'resourceType' => [ 'type' => 'string', ], 'resourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"owner\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"version\\": 0,\\n \\"icebergTableMetadata\\": {\\n \\"currentSnapshot\\": {\\n \\"sequenceNumber\\": 0,\\n \\"timestampMillis\\": 0,\\n \\"schemaId\\": 0,\\n \\"addedRows\\": 0,\\n \\"operation\\": \\"\\",\\n \\"id\\": 0,\\n \\"parentId\\": 0,\\n \\"idString\\": \\"\\",\\n \\"parentIdString\\": \\"\\",\\n \\"summary\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"partitionFields\\": [\\n {\\n \\"sourceId\\": 0,\\n \\"transform\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"fieldId\\": 0\\n }\\n ],\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"doc\\": \\"\\",\\n \\"optional\\": true,\\n \\"id\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ],\\n \\"properties\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"identifierFieldIds\\": [\\n 0\\n ]\\n },\\n \\"updatedAt\\": 0\\n}","type":"json"}]', 'title' => '获取Iceberg表详情', ], 'GetIcebergNamespace' => [ 'summary' => '查看iceberg数据库', 'path' => '/iceberg/dlf/v1/{catalogId}/namespaces/{namespace}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREdlfHM4IA0', ], ], 'parameters' => [ [ 'name' => 'catalogId', 'in' => 'path', 'schema' => [ 'description' => '数据目录ID。', 'type' => 'string', 'required' => true, 'example' => 'clg-iceberg-xxx', ], ], [ 'name' => 'namespace', 'in' => 'path', 'schema' => [ 'description' => '项目空间名称。', 'type' => 'string', 'required' => false, 'example' => 'namespace_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '命名空间。', '$ref' => '#/components/schemas/Namespace', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', ], ], ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', ], ], ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"owner\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"updatedBy\\": \\"\\",\\n \\"createdBy\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"options\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"location\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"updatedAt\\": 0\\n}","type":"json"}]', 'title' => '获取命名空间详情', ], ], 'endpoints' => [ [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'dlfnext.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'dlfnext.cn-wulanchabu.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'dlfnext.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'dlfnext.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'dlfnext.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'dlfnext.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'dlfnext.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'dlfnext.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'dlfnext.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'dlfnext.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'dlfnext.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'dlfnext.us-east-1.aliyuncs.com', ], ], ];