diff options
Diffstat (limited to 'data/en_us/datalake/2020-07-10')
| -rw-r--r-- | data/en_us/datalake/2020-07-10/api-docs.php | 21544 |
1 files changed, 9531 insertions, 12013 deletions
diff --git a/data/en_us/datalake/2020-07-10/api-docs.php b/data/en_us/datalake/2020-07-10/api-docs.php index 3302c4c..bdb51ac 100644 --- a/data/en_us/datalake/2020-07-10/api-docs.php +++ b/data/en_us/datalake/2020-07-10/api-docs.php @@ -1,1432 +1,595 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'DataLake', - 'version' => '2020-07-10', - ], + 'info' => ['style' => 'ROA', 'product' => 'DataLake', 'version' => '2020-07-10'], 'directories' => [ [ - 'id' => 167316, - 'title' => 'Metadata', - 'type' => 'directory', 'children' => [ [ - 'id' => 169629, - 'title' => 'Catalog', + 'children' => ['UpdateCatalog'], 'type' => 'directory', - 'children' => [ - 'CreateCatalog', - 'DeleteCatalog', - 'UpdateCatalog', - 'ListCatalogs', - 'GetCatalog', - ], + 'title' => 'Catalog', ], [ - 'id' => 161865, - 'title' => 'Database', + 'children' => ['UpdateDatabase'], 'type' => 'directory', - 'children' => [ - 'CreateDatabase', - 'DeleteDatabase', - 'UpdateDatabase', - 'GetDatabase', - 'ListDatabases', - ], + 'title' => 'Database', ], [ - 'id' => 161889, + 'children' => ['CreateTable', 'DeleteTable', 'DeleteTableColumnStatistics', 'DeleteTableVersion', 'UpdateTableColumnStatistics', 'GetTableColumnStatistics', 'GetTableVersion', 'ListTableNames', 'ListTableVersions', 'GetTableProfile', 'RenameTable', 'BatchGetTables', 'BatchCreateTables', 'BatchDeleteTables', 'BatchDeleteTableVersions', 'BatchUpdateTables'], + 'type' => 'directory', 'title' => 'Table', + ], + [ + 'children' => ['CreatePartition', 'DeletePartition', 'DeletePartitionColumnStatistics', 'UpdatePartitionColumnStatistics', 'GetPartitionColumnStatistics', 'ListPartitionNames', 'ListPartitionsByFilter', 'BatchCreatePartitions', 'BatchDeletePartitions', 'BatchGetPartitionColumnStatistics', 'BatchGetPartitions', 'BatchUpdatePartitions', 'RenamePartition'], 'type' => 'directory', - 'children' => [ - 'CreateTable', - 'DeleteTable', - 'DeleteTableColumnStatistics', - 'DeleteTableVersion', - 'UpdateTable', - 'UpdateTableColumnStatistics', - 'GetTable', - 'GetTableColumnStatistics', - 'GetTableVersion', - 'ListTableNames', - 'ListTables', - 'ListTableVersions', - 'GetTableProfile', - 'RenameTable', - 'BatchGetTables', - 'BatchCreateTables', - 'BatchDeleteTables', - 'BatchDeleteTableVersions', - 'BatchUpdateTables', - ], - ], - [ - 'id' => 161872, 'title' => 'Partition', + ], + [ + 'children' => ['ListFunctionNames'], 'type' => 'directory', - 'children' => [ - 'CreatePartition', - 'DeletePartition', - 'DeletePartitionColumnStatistics', - 'UpdatePartitionColumnStatistics', - 'GetPartition', - 'GetPartitionColumnStatistics', - 'ListPartitionNames', - 'ListPartitions', - 'ListPartitionsByFilter', - 'BatchCreatePartitions', - 'BatchDeletePartitions', - 'BatchGetPartitionColumnStatistics', - 'BatchGetPartitions', - 'BatchUpdatePartitions', - 'RenamePartition', - ], - ], - [ - 'id' => 161908, 'title' => 'Function', - 'type' => 'directory', - 'children' => [ - 'CreateFunction', - 'DeleteFunction', - 'UpdateFunction', - 'ListFunctionNames', - 'ListFunctions', - 'GetFunction', - ], ], [ - 'id' => 161845, - 'title' => 'Lock', + 'children' => ['CreateLock', 'GetLock', 'AbortLock', 'RefreshLock', 'UnLock'], 'type' => 'directory', - 'children' => [ - 'CreateLock', - 'GetLock', - 'AbortLock', - 'RefreshLock', - 'UnLock', - ], + 'title' => 'Lock', ], [ - 'id' => 166936, - 'title' => 'Metadata Migration', + 'children' => ['StopMigrationWorkflow', 'RunMigrationWorkflow'], 'type' => 'directory', - 'children' => [ - 'StopMigrationWorkflow', - 'RunMigrationWorkflow', - ], + 'title' => 'Metadata migration', ], 'GetAsyncTaskStatus', - 'Search', ], + 'type' => 'directory', + 'title' => 'Metadata', ], [ - 'id' => 161796, - 'title' => 'Permissions', + 'children' => ['GrantRolesToUser', 'BatchGrantPermissions', 'RevokeRolesFromUser', 'RevokePermissions', 'BatchRevokePermissions', 'UpdateRoleUsers', 'UpdatePermissions', 'UpdateCatalogSettings', 'ListRoleUsers', 'ListUserRoles', 'CheckPermissions', 'GetCatalogSettings'], 'type' => 'directory', - 'children' => [ - 'CreateRole', - 'GrantRoleToUsers', - 'GrantRolesToUser', - 'GrantPermissions', - 'BatchGrantPermissions', - 'DeleteRole', - 'RevokeRoleFromUsers', - 'RevokeRolesFromUser', - 'RevokePermissions', - 'BatchRevokePermissions', - 'UpdateRole', - 'UpdateRoleUsers', - 'UpdatePermissions', - 'UpdateCatalogSettings', - 'GetRole', - 'ListRoles', - 'ListRoleUsers', - 'ListUserRoles', - 'ListPermissions', - 'CheckPermissions', - 'GetCatalogSettings', - ], + 'title' => 'Permission', ], [ - 'id' => 166939, - 'title' => 'Data exploration', + 'children' => ['GetQueryResult', 'SubmitQuery', 'CancelQuery'], 'type' => 'directory', - 'children' => [ - 'GetQueryResult', - 'SubmitQuery', - 'CancelQuery', - ], + 'title' => 'Data exploration', ], [ - 'id' => 161818, - 'title' => 'Universal Services', + 'children' => ['GetRegionStatus', 'GetServiceStatus'], 'type' => 'directory', - 'children' => [ - 'GetRegionStatus', - 'GetServiceStatus', - 'DescribeRegions', - ], + 'title' => 'Common services', ], [ - 'id' => 178756, - 'title' => 'Other', - 'type' => 'directory', 'children' => [ - 'SearchAcrossCatalog', - 'RegisterLocation', - 'DeregisterLocation', - 'UpdateRegisteredLocation', - 'ListPartitionsByExpr', - 'GetDatabaseProfile', - 'GetLifecycleRule', - 'ListPartitionsProfile', + 'SearchAcrossCatalog', 'RegisterLocation', 'DeregisterLocation', 'UpdateRegisteredLocation', 'ListPartitionsByExpr', 'GetDatabaseProfile', 'GetLifecycleRule', 'CreateCatalog', 'CreateDatabase', 'CreateFunction', 'CreateRole', 'DeleteCatalog', 'DeleteDatabase', 'DeleteFunction', 'DeleteRole', 'DescribeRegions', 'GetCatalog', 'GetDatabase', 'GetFunction', 'GetPartition', + 'GetRole', 'GetTable', 'GrantPermissions', 'GrantRoleToUsers', 'ListCatalogs', 'ListDatabases', 'ListFunctions', 'ListPartitions', 'ListPartitionsProfile', 'ListPermissions', 'ListRoles', 'ListTables', 'RevokeRoleFromUsers', 'Search', 'UpdateFunction', 'UpdateRole', 'UpdateTable', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ - 'AccessRequest' => [ + 'Accesses' => [ 'title' => 'A short description of struct', - 'description' => 'The information about the access request.'."\n", - 'visibility' => 'public', + 'description' => 'accesses 列表', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'ALTER/SELECT/CREATE, etc.'], + ], + 'AccessRequest' => [ + 'title' => '', + 'description' => 'Information about the access request.', 'type' => 'object', 'properties' => [ - 'PrivilegeResources' => [ - 'description' => 'resource list to be authorized.'."\n", - 'visibility' => 'public', - 'backendName' => 'PrivilegeResources', - '$ref' => '#/components/schemas/PrivilegeResources', - ], - 'Principal' => [ - 'description' => 'Visitors.'."\n", - 'visibility' => 'public', - 'backendName' => 'Principal', - '$ref' => '#/components/schemas/Principal', - ], - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The category ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1344371', - 'backendName' => 'CatalogId', - ], + 'PrivilegeResources' => ['description' => 'The list of resources to be granted permissions.', '$ref' => '#/components/schemas/PrivilegeResources', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'PrivilegeResources'], + 'Principal' => ['description' => 'The principal.', '$ref' => '#/components/schemas/Principal', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Principal'], + 'CatalogId' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'example' => '1344371', 'visibility' => 'Public', 'backendName' => 'CatalogId'], ], + 'example' => '', + 'visibility' => 'Public', ], - 'Catalog' => [ + 'BatchGrantRevokeFailureResult' => [ 'title' => 'A short description of struct', - 'description' => 'The information about the data directory.'."\n", - 'visibility' => 'public', + 'description' => '批量授权错误时的结果', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/GrantRevokeFailureEntry'], + ], + 'Catalog' => [ + 'title' => '', + 'description' => 'Details of the catalog.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1344371', - 'backendName' => 'CatalogId', - ], - 'Description' => [ - 'title' => 'Description', - 'description' => 'The description of the cluster.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'Description', - ], - 'LocationUri' => [ - 'title' => 'LocationUri', - 'description' => 'The path of the directory.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss://dlf-test-oss-location/', - 'backendName' => 'LocationUri', - ], - 'Owner' => [ - 'title' => '', - 'description' => 'Owner: Principal format.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs:ram::[accountId]:root', - 'backendName' => 'Owner', - ], - 'CreatedBy' => [ - 'title' => '', - 'description' => 'Created by: principal format.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs:ram::[accountId]:root'."\n", - 'backendName' => 'CreatedBy', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'Creation time: the number of seconds in a UNIX timestamp.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640662815603', - 'backendName' => 'CreateTime', - ], - 'UpdateTime' => [ - 'title' => '', - 'description' => 'Update time: the number of seconds in the UNIX timestamp.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640662815603', - 'backendName' => 'UpdateTime', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The status of the catalog.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'CREATED', - 'backendName' => 'Status', - ], + 'CatalogId' => ['title' => '', 'description' => 'The unique ID of the catalog.', 'type' => 'string', 'example' => '1344371', 'visibility' => 'Public', 'backendName' => 'CatalogId'], + 'Description' => ['title' => '', 'description' => 'A description of the catalog.', 'type' => 'string', 'example' => '测试', 'visibility' => 'Public', 'backendName' => 'Description'], + 'LocationUri' => ['title' => '', 'description' => 'The location of the catalog, specified as an OSS URI.', 'type' => 'string', 'example' => 'oss://dlf-test-oss-location/', 'visibility' => 'Public', 'backendName' => 'LocationUri'], + 'Owner' => ['title' => '', 'description' => 'The owner, specified in principal format.', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', 'visibility' => 'Public', 'backendName' => 'Owner'], + 'CreatedBy' => ['title' => '', 'description' => 'The creator, specified in principal format.', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root'."\n", 'visibility' => 'Public', 'backendName' => 'CreatedBy'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640662815', 'visibility' => 'Public', 'backendName' => 'CreateTime'], + 'UpdateTime' => ['title' => '', 'description' => 'The update time, as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640662815', 'visibility' => 'Public', 'backendName' => 'UpdateTime'], + 'Status' => ['title' => '', 'description' => 'The status of the catalog.', 'type' => 'string', 'example' => 'CREATED', 'visibility' => 'Public', 'backendName' => 'Status'], 'CatalogType' => [ 'title' => '', - 'description' => 'The catalog type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* NATIVE: NATIVE.'."\n" - .'* HMS: HMS.'."\n", - 'visibility' => 'Public', + 'description' => 'The catalog type.', + 'enumValueTitles' => ['NATIVE' => 'NATIVE', 'HMS' => 'HMS'], 'type' => 'string', - 'enumValueTitles' => [ - 'NATIVE' => 'NATIVE', - 'HMS' => 'HMS', - ], 'example' => 'HMS', - 'backendName' => 'CatalogType', - ], - 'DefaultCatalog' => [ - 'title' => '', - 'description' => 'Whether it is the default data directory.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'DefaultCatalog', - ], - 'ThriftEnabled' => [ - 'title' => 'ThriftEnabled', - 'description' => 'Whether to enable Thrift port access.'."\n", 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ThriftEnabled', - ], - 'JdbcEnabled' => [ - 'title' => 'JdbcEnabled', - 'description' => 'Whether to enable JDBC port access.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'JdbcEnabled', - ], - 'StorageAccessConfig' => [ - 'title' => 'StorageAccessConfig', - 'description' => 'Storage access configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'StorageAccessConfig', + 'backendName' => 'CatalogType', ], + 'DefaultCatalog' => ['title' => '', 'description' => 'Indicates whether this is the default catalog.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'DefaultCatalog'], + 'ThriftEnabled' => ['title' => '', 'description' => 'Indicates whether Thrift port access is enabled.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'ThriftEnabled'], + 'JdbcEnabled' => ['title' => '', 'description' => 'Indicates whether JDBC port access is enabled.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'JdbcEnabled'], + 'StorageAccessConfig' => ['title' => '', 'description' => 'The storage access configuration.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'StorageAccessConfig'], ], + 'example' => '', + 'visibility' => 'Public', ], 'CatalogInput' => [ - 'title' => 'A short description of struct', - 'description' => 'Creates or updates the structure of a catalog.', - 'visibility' => 'public', + 'title' => '', + 'description' => 'The structure for creating or updating a catalog.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the catalog.', - 'visibility' => 'public', - 'type' => 'string', - 'required' => true, - 'example' => 'catalog_test', - 'backendName' => 'CatalogId', - ], - 'Description' => [ - 'title' => 'Description', - 'description' => 'The description of the catalog.', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'The test data catalog.', - 'backendName' => 'Description', - ], - 'LocationUri' => [ - 'title' => 'LocationUri', - 'description' => 'The path to the catalog.', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss://dlf-test-oss-location/', - 'backendName' => 'LocationUri', - ], - 'Owner' => [ - 'title' => '', - 'description' => 'Owner: Principal format.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs:ram::[accountId]:root', - 'backendName' => 'Owner', - ], - 'CatalogType' => [ - 'title' => '', - 'description' => 'The catalog type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'CatalogType', - 'default' => 'NATIVE', - ], - 'ThriftEnabled' => [ - 'title' => 'ThriftEnabled', - 'description' => 'Specifies whether to enable Thrift port access.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ThriftEnabled', - ], - 'JdbcEnabled' => [ - 'title' => 'JdbcEnabled', - 'description' => 'Specifies whether to enable JDBC port access.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'JdbcEnabled', - ], - 'StorageAccessConfig' => [ - 'title' => 'StorageAccessConfig', - 'description' => 'The storage access configuration.', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'StorageAccessConfig', - ], - ], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => true, 'example' => 'catalog_test', 'visibility' => 'Public', 'backendName' => 'CatalogId'], + 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'Test catalog', 'visibility' => 'Public', 'backendName' => 'Description'], + 'LocationUri' => ['title' => '', 'description' => 'The path of the catalog.', 'type' => 'string', 'example' => 'oss://dlf-test-oss-location/', 'visibility' => 'Public', 'backendName' => 'LocationUri'], + 'Owner' => ['title' => '', 'description' => 'The owner, in Principal format. If this parameter is left empty, it is automatically populated with the identity of the creator.', 'type' => 'string', 'example' => 'acs:ram::[accountId]:root', 'visibility' => 'Public', 'backendName' => 'Owner'], + 'CatalogType' => ['title' => '', 'description' => 'The type of the catalog.', 'type' => 'string', 'default' => 'NATIVE', 'example' => '', 'visibility' => 'Public', 'backendName' => 'CatalogType'], + 'ThriftEnabled' => ['title' => '', 'description' => 'Specifies whether to enable access through the Thrift port.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'ThriftEnabled'], + 'JdbcEnabled' => ['title' => '', 'description' => 'Specifies whether to enable access through the Java Database Connectivity (JDBC) port.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'JdbcEnabled'], + 'StorageAccessConfig' => ['title' => '', 'description' => 'The storage access configuration.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'StorageAccessConfig'], + ], + 'example' => '', + 'visibility' => 'Public', ], 'CatalogResource' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Authentication resource structure: data directory.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'Catalog id', - 'description' => 'The ID of the data directory.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1344371', - 'backendName' => 'CatalogId', - ], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data directory.'."\n", 'type' => 'string', 'example' => '1344371', 'visibility' => 'Public', 'backendName' => 'CatalogId'], ], + 'visibility' => 'Public', + 'example' => '', ], 'CatalogSettings' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Data Lake-related configurations'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'Config' => [ 'title' => '', 'description' => 'The metadata of the sample.'."\n", - 'visibility' => 'public', - 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The permission configuration of the data lake. auth.permission.check.enable indicates whether to enable metadata server-side authentication. After metadata access through API is enabled, authentication is performed. auth.super.principal indicates that a super user is configured and the super user bypasses all authentication.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '{'."\n" - .'"auth.permission.check.enable":'."\n" - .'"true",'."\n" - .'"auth.super.principal":'."\n" - .'"acs:ram::[aliyunAccountId]:role/aliyundlfworkflowdefaultrole"'."\n" - .'}', - ], + 'type' => 'object', + 'additionalProperties' => ['description' => 'The permission configuration of the data lake. auth.permission.check.enable indicates whether to enable metadata server-side authentication. After metadata access through API is enabled, authentication is performed. auth.super.principal indicates that a super user is configured and the super user bypasses all authentication.'."\n", 'type' => 'string', 'example' => '{'."\n" + .'"auth.permission.check.enable":'."\n" + .'"true",'."\n" + .'"auth.super.principal":'."\n" + .'"acs:ram::[aliyunAccountId]:role/aliyundlfworkflowdefaultrole"'."\n" + .'}', 'visibility' => 'Public', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'Config', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'ColumnResource' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Authentication resource structure-Column'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'DatabaseName', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the metatable.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'TableName', - ], + 'DatabaseName' => ['title' => '', 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'default', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'TableName' => ['title' => '', 'description' => 'The name of the metatable.'."\n", 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'TableName'], 'ColumnNames' => [ - 'title' => 'ColumnName', + 'title' => '', 'description' => 'The list of field names.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The field name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'name', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The field name.'."\n", 'type' => 'string', 'example' => 'name', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'ColumnNames', 'itemName' => 'ColumnName', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'ColumnStatistics' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The field statistics.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'ColumnStatisticsDesc' => [ - 'description' => 'The description of the field statistics.'."\n", - 'visibility' => 'public', - 'backendName' => 'ColumnStatisticsDesc', - '$ref' => '#/components/schemas/ColumnStatisticsDesc', - ], + 'ColumnStatisticsDesc' => ['description' => 'The description of the field statistics.'."\n", '$ref' => '#/components/schemas/ColumnStatisticsDesc', 'visibility' => 'Public', 'backendName' => 'ColumnStatisticsDesc', 'title' => '', 'example' => ''], 'ColumnStatisticsObjList' => [ - 'title' => 'ColumnStatisticsObjList', + 'title' => '', 'description' => 'The field statistics.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The field statistics.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ColumnStatisticsObj', - ], + 'items' => ['description' => 'The field statistics.'."\n", '$ref' => '#/components/schemas/ColumnStatisticsObj', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'ColumnStatisticsObjectList', - ], - 'Engine' => [ - 'title' => 'Engine for hive3+', - 'description' => 'The database engine version of the instance.'."\n", - 'visibility' => 'public', - 'type' => 'string', 'example' => '', - 'backendName' => 'Engine', - ], - 'IsStatsCompliant' => [ - 'title' => 'IsStatsCompliant for hive3+', - 'description' => 'Whether the field statistics comply with the statistical specifications. Valid values:'."\n" - ."\n" - .'* true: The column statistics comply with Hive specifications and can be used by the query optimizer.'."\n" - .'* false: indicates that the column statistics do not conform to the specifications. The query optimizer may not use these statistics for query optimization.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'IsStatsCompliant', ], + 'Engine' => ['title' => '', 'description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'example' => '""，"hive"等', 'visibility' => 'Public', 'backendName' => 'Engine'], + 'IsStatsCompliant' => ['title' => '', 'description' => 'Whether the field statistics comply with the statistical specifications. Valid values:'."\n" + ."\n" + .'* true: The column statistics comply with Hive specifications and can be used by the query optimizer.'."\n" + .'* false: indicates that the column statistics do not conform to the specifications. The query optimizer may not use these statistics for query optimization.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'IsStatsCompliant'], ], + 'visibility' => 'Public', + 'example' => '', ], 'ColumnStatisticsDesc' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'ColumnStatisticsDesc'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'LastAnalyzedTime' => [ - 'title' => 'optional', - 'description' => 'Last Analysis Time'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12312323', - 'backendName' => 'LastAnalyzedTime', - ], - 'PartitionName' => [ - 'title' => 'required', - 'description' => 'The name of the partition.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ds=201212/hh=23', - 'backendName' => 'PartitionName', - ], + 'LastAnalyzedTime' => ['title' => '', 'description' => 'Last Analysis Time'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12312323', 'visibility' => 'Public', 'backendName' => 'LastAnalyzedTime'], + 'PartitionName' => ['title' => '', 'description' => 'The name of the partition.'."\n", 'type' => 'string', 'example' => 'ds=201212/hh=23', 'visibility' => 'Public', 'backendName' => 'PartitionName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'ColumnStatisticsObj' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'ColumnStatisticsObj'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'ColumnName' => [ - 'title' => 'ColumnName of the table', - 'description' => 'The name of the field.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'col1', - 'backendName' => 'ColumnName', - ], - 'ColumnType' => [ - 'title' => 'ColumnType', - 'description' => 'Field type, including array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'int', - 'backendName' => 'ColumnType', - ], + 'ColumnName' => ['title' => '', 'description' => 'The name of the field.'."\n", 'type' => 'string', 'example' => 'col1', 'visibility' => 'Public', 'backendName' => 'ColumnName'], + 'ColumnType' => ['title' => '', 'description' => 'Field type, including array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar'."\n", 'type' => 'string', 'example' => 'int', 'visibility' => 'Public', 'backendName' => 'ColumnType'], 'ColumnStatisticsData' => [ - 'title' => 'ColumnStatisticsData', + 'title' => '', 'description' => 'The statistics on the field.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'StatisticsData' => [ - 'title' => 'StatisticsData', - 'description' => 'The statistical results of the field.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '{"numNulls":0,"numTrues":1,"numFalses":5}', - 'backendName' => 'StatisticsData', - ], - 'StatisticsType' => [ - 'title' => 'StatisticsType', - 'description' => 'Statistics type: BOOLEAN_STATS,LONG_STATS,DOUBLE_STATS,STRING_STATS,BINARY_STATS,DECIMAL_STATS, and DATE_STATS'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'BOOLEAN_STATS', - 'backendName' => 'StatisticsType', - ], + 'StatisticsData' => ['title' => '', 'description' => 'The statistical results of the field.'."\n", 'type' => 'string', 'example' => '{"numNulls":0,"numTrues":1,"numFalses":5}', 'visibility' => 'Public', 'backendName' => 'StatisticsData'], + 'StatisticsType' => ['title' => '', 'description' => 'Statistics type: BOOLEAN_STATS,LONG_STATS,DOUBLE_STATS,STRING_STATS,BINARY_STATS,DECIMAL_STATS, and DATE_STATS'."\n", 'type' => 'string', 'example' => 'BOOLEAN_STATS', 'visibility' => 'Public', 'backendName' => 'StatisticsType'], ], + 'visibility' => 'Public', 'backendName' => 'ColumnStatisticsData', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Database' => [ - 'title' => 'Database Object', + 'title' => '', 'description' => 'Database object'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'CreateTime', - ], - 'Description' => [ - 'title' => 'description', - 'description' => 'The description of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'this is a hive database', - 'backendName' => 'Description', - ], - 'LocationUri' => [ - 'title' => 'locationUri', - 'description' => 'Metabase storage path, such as HDFS path'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '/hdfs/hivedb/data', - 'backendName' => 'LocationUri', - ], - 'Name' => [ - 'title' => 'name', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'Name', - ], - 'OwnerName' => [ - 'title' => 'ownerName', - 'description' => 'The name of the owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'OwnerName', - ], - 'OwnerType' => [ - 'title' => 'ownerType', - 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'OwnerType', - ], - 'Parameters' => [ - 'description' => 'The key-value pairs (KVPs) that define the parameters and attributes of the metadatabase.'."\n", - 'visibility' => 'public', - 'backendName' => 'Parameters', - '$ref' => '#/components/schemas/Parameters', - ], - 'Privileges' => [ - 'description' => 'The permissions on the metadatabase. This parameter is optional.'."\n", - 'visibility' => 'public', - 'backendName' => 'Privileges', - '$ref' => '#/components/schemas/PrincipalPrivilegeSet', - ], - 'UpdateTime' => [ - 'title' => 'updateTime', - 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'UpdateTime', - ], - 'CreatedBy' => [ - 'title' => 'CreatedBy', - 'description' => 'The user who created the drive.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'root', - 'backendName' => 'CreatedBy', - ], - ], + 'CreateTime' => ['title' => '', 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407'], + 'Description' => ['title' => '', 'description' => 'The description of the metadatabase.'."\n", 'type' => 'string', 'example' => 'this is a hive database'], + 'LocationUri' => ['title' => '', 'description' => 'Metabase storage path, such as HDFS path'."\n", 'type' => 'string', 'example' => '/hdfs/hivedb/data'], + 'Name' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.'."\n", 'type' => 'string', 'example' => 'zhangsan'], + 'OwnerType' => ['title' => '', 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", 'type' => 'string', 'example' => 'USER'], + 'Parameters' => ['description' => 'The key-value pairs (KVPs) that define the parameters and attributes of the metadatabase.'."\n", '$ref' => '#/components/schemas/Parameters', 'title' => '', 'example' => ''], + 'Privileges' => ['description' => 'The permissions on the metadatabase. This parameter is optional.'."\n", '$ref' => '#/components/schemas/PrincipalPrivilegeSet', 'title' => '', 'example' => ''], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407'], + 'CreatedBy' => ['title' => '', 'description' => 'The user who created the drive.'."\n", 'type' => 'string', 'example' => 'root'], + ], + 'example' => '', ], 'DatabaseInput' => [ - 'title' => 'Database input', + 'title' => '', 'description' => 'Database object'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'Description', - 'description' => 'The description of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'this is a hive database', - 'backendName' => 'Description', - ], - 'LocationUri' => [ - 'title' => 'locationUri', - 'description' => 'The storage path of the metabase. For example, you can enter the HDFS path.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '/hdfs/hivedb/data', - 'backendName' => 'LocationUri', - ], - 'Name' => [ - 'title' => 'name', - 'description' => 'The name of the metabase. The verification length is 128. Special characters other than underscores are not supported.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'name', - 'backendName' => 'Name', - ], - 'OwnerName' => [ - 'title' => 'ownerName', - 'description' => 'The name of the owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'OwnerName', - ], - 'OwnerType' => [ - 'title' => 'ownerType', - 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'OwnerType', - ], - 'Parameters' => [ - 'description' => 'The key-value pairs (KVPs) that define the parameters and attributes of the metadatabase.'."\n", - 'visibility' => 'public', - 'backendName' => 'Parameters', - '$ref' => '#/components/schemas/Parameters', - ], - 'Privileges' => [ - 'description' => 'The permissions on the metadatabase. This parameter is optional.'."\n", - 'visibility' => 'public', - 'backendName' => 'Privileges', - '$ref' => '#/components/schemas/PrincipalPrivilegeSet', - ], - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'Creation time, required.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1580869631', - 'backendName' => 'CreateTime', - ], + 'Description' => ['title' => '', 'description' => 'The description of the metadatabase.'."\n", 'type' => 'string', 'example' => 'this is a hive database', 'visibility' => 'Public', 'backendName' => 'Description'], + 'LocationUri' => ['title' => '', 'description' => 'The storage path of the metabase. For example, you can enter the HDFS path.'."\n", 'type' => 'string', 'example' => '/hdfs/hivedb/data', 'visibility' => 'Public', 'backendName' => 'LocationUri'], + 'Name' => ['title' => '', 'description' => 'The name of the metabase. The verification length is 128. Special characters other than underscores are not supported.'."\n", 'type' => 'string', 'example' => 'name', 'visibility' => 'Public', 'backendName' => 'Name'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.'."\n", 'type' => 'string', 'example' => 'zhangsan', 'visibility' => 'Public', 'backendName' => 'OwnerName'], + 'OwnerType' => ['title' => '', 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", 'type' => 'string', 'example' => 'USER', 'visibility' => 'Public', 'backendName' => 'OwnerType'], + 'Parameters' => ['description' => 'The key-value pairs (KVPs) that define the parameters and attributes of the metadatabase.'."\n", '$ref' => '#/components/schemas/Parameters', 'visibility' => 'Public', 'backendName' => 'Parameters', 'title' => '', 'example' => ''], + 'Privileges' => ['description' => 'The permissions on the metadatabase. This parameter is optional.'."\n", '$ref' => '#/components/schemas/PrincipalPrivilegeSet', 'visibility' => 'Public', 'backendName' => 'Privileges', 'title' => '', 'example' => ''], + 'CreateTime' => ['title' => '', 'description' => 'Creation time, required.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1580869631', 'visibility' => 'Public', 'backendName' => 'CreateTime'], ], + 'visibility' => 'Public', + 'example' => '', ], 'DatabaseProfile' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Database Data Overview'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'FileCnt' => [ - 'title' => '', - 'description' => 'Total library files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3234', - 'backendName' => 'fileCnt', - ], - 'FileSize' => [ - 'title' => '', - 'description' => 'Library storage size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1254312', - 'backendName' => 'fileSize', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The library name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_db', - 'backendName' => 'databaseName', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the data address was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-08-16 18:02:22', - 'backendName' => 'createTime', - ], - 'Location' => [ - 'title' => '', - 'description' => 'The location where the sample is stored.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/', - 'backendName' => 'location', - ], - 'ObjectSize' => [ - 'title' => '', - 'description' => 'OSS file size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1254312', - 'backendName' => 'objectSize', - ], - 'ObjectCnt' => [ - 'title' => '', - 'description' => 'Number of OSS files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3234', - 'backendName' => 'objectCnt', - ], - 'LatestDate' => [ - 'title' => '', - 'description' => 'The time when the metadata warehouse was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-08-30 19:16:10', - 'backendName' => 'latestDate', - ], + 'FileCnt' => ['title' => '', 'description' => 'Total library files'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3234', 'visibility' => 'Public', 'backendName' => 'fileCnt'], + 'FileSize' => ['title' => '', 'description' => 'Library storage size'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1254312', 'visibility' => 'Public', 'backendName' => 'fileSize'], + 'Name' => ['title' => '', 'description' => 'The library name.'."\n", 'type' => 'string', 'example' => 'test_db', 'visibility' => 'Public', 'backendName' => 'databaseName'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the data address was created.'."\n", 'type' => 'string', 'example' => '2023-08-16 18:02:22', 'visibility' => 'Public', 'backendName' => 'createTime'], + 'Location' => ['title' => '', 'description' => 'The location where the sample is stored.'."\n", 'type' => 'string', 'example' => 'oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/', 'visibility' => 'Public', 'backendName' => 'location'], + 'ObjectSize' => ['title' => '', 'description' => 'OSS file size'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1254312', 'visibility' => 'Public', 'backendName' => 'objectSize'], + 'ObjectCnt' => ['title' => '', 'description' => 'Number of OSS files'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3234', 'visibility' => 'Public', 'backendName' => 'objectCnt'], + 'LatestDate' => ['title' => '', 'description' => 'The time when the metadata warehouse was updated.'."\n", 'type' => 'string', 'example' => '2023-08-30 19:16:10', 'visibility' => 'Public', 'backendName' => 'latestDate'], ], + 'visibility' => 'Public', + 'example' => '', ], 'DatabaseResource' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Authentication resource structure: database.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => 'Database name', - 'description' => 'The name of the queried database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'DatabaseName', - ], - 'DatabaseWildcard' => [ - 'title' => 'A wildcard member representing every resource under a database', - 'description' => 'Database wildcard.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '*', - 'backendName' => 'DatabaseWildcard', - ], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the queried database.'."\n", 'type' => 'string', 'example' => 'default', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'DatabaseWildcard' => ['title' => '', 'description' => 'Database wildcard.'."\n", 'type' => 'string', 'example' => '*', 'visibility' => 'Public', 'backendName' => 'DatabaseWildcard'], ], + 'visibility' => 'Public', 'parseType' => 'struct', + 'example' => '', ], 'DbStorageRank' => [ 'title' => '', 'description' => 'Library storage ranking'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Quantity' => [ - 'title' => '', - 'description' => 'Library storage size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9897183010448', - 'backendName' => 'Quantity', - ], - 'DbName' => [ - 'title' => '', - 'description' => 'The library name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tpcds_text_parquet_10000"', - 'backendName' => 'DbName', - ], + 'Quantity' => ['title' => '', 'description' => 'Library storage size'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9897183010448', 'visibility' => 'Public', 'backendName' => 'Quantity'], + 'DbName' => ['title' => '', 'description' => 'The library name.'."\n", 'type' => 'string', 'example' => 'tpcds_text_parquet_10000"', 'visibility' => 'Public', 'backendName' => 'DbName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'ErrorDetail' => [ - 'title' => 'ErrorDetail', + 'title' => '', 'description' => 'ErrorDetail'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The error code.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '401', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The error message.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'auth failed', - ], + 'Code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '401', 'visibility' => 'Public'], + 'Message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'auth failed', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'FieldSchema' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'FieldSchema'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Comment' => [ - 'title' => 'Comment', - 'description' => 'The comments on the field.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'comment_day', - ], - 'Name' => [ - 'title' => 'Name', - 'description' => 'The name of the field.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'day', - ], - 'Parameters' => [ - 'description' => 'The KVPs that define the attributes associated with the field.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/Parameters', - ], - 'Type' => [ - 'title' => 'Type', - 'description' => 'Field type, including array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'int', - ], + 'Comment' => ['title' => '', 'description' => 'The comments on the field.'."\n", 'type' => 'string', 'example' => 'comment_day', 'visibility' => 'Public'], + 'Name' => ['title' => '', 'description' => 'The name of the field.'."\n", 'type' => 'string', 'example' => 'day', 'visibility' => 'Public'], + 'Parameters' => ['description' => 'The KVPs that define the attributes associated with the field.'."\n", '$ref' => '#/components/schemas/Parameters', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'Type' => ['title' => '', 'description' => 'Field type, including array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar'."\n", 'type' => 'string', 'example' => 'int', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'FileCnt' => [ 'title' => '', 'description' => 'Small file distribution information'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Small' => [ - 'title' => '', - 'description' => 'Number of small files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'backendName' => 'Small', - ], - 'Large' => [ - 'title' => '', - 'description' => 'Number of large files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'Large', - ], - 'Tiny' => [ - 'title' => '', - 'description' => 'Number of very small files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '124', - 'backendName' => 'Tiny', - ], - 'Middle' => [ - 'title' => '', - 'description' => 'Number of files in'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - 'backendName' => 'Middle', - ], + 'Small' => ['title' => '', 'description' => 'Number of small files'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'Small'], + 'Large' => ['title' => '', 'description' => 'Number of large files'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'Large'], + 'Tiny' => ['title' => '', 'description' => 'Number of very small files'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '124', 'visibility' => 'Public', 'backendName' => 'Tiny'], + 'Middle' => ['title' => '', 'description' => 'Number of files in'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'visibility' => 'Public', 'backendName' => 'Middle'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Function' => [ - 'title' => 'Function Object', + 'title' => '', 'description' => 'Functions'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1344371', - 'backendName' => 'CatalogId', - ], - 'ClassName' => [ - 'title' => 'ClassName', - 'description' => 'The name of the Java class that contains the implementation of the function'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'com.xxx.xxxxFunction', - 'backendName' => 'ClassName', - ], - 'CreateTime' => [ - 'title' => 'CreateTime', - 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608863962', - 'backendName' => 'CreateTime', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'DatabaseName', - ], - 'FunctionName' => [ - 'title' => 'FunctionName', - 'description' => 'The function name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'function1', - 'backendName' => 'FunctionName', - ], - 'FunctionType' => [ - 'title' => 'FunctionType', - 'description' => 'The type of the function. Currently, the supported enumeration is JAVA.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'JAVA', - 'backendName' => 'FunctionType', - ], - 'OwnerName' => [ - 'title' => 'OwnerName', - 'description' => 'The name of the owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'OwnerName', - ], - 'OwnerType' => [ - 'title' => 'OwnerType', - 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'OwnerType', - ], + 'CatalogId' => ['title' => '', 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n", 'type' => 'string', 'example' => '1344371', 'visibility' => 'Public', 'backendName' => 'CatalogId'], + 'ClassName' => ['title' => '', 'description' => 'The name of the Java class that contains the implementation of the function'."\n", 'type' => 'string', 'example' => 'com.xxx.xxxxFunction', 'visibility' => 'Public', 'backendName' => 'ClassName'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608863962', 'visibility' => 'Public', 'backendName' => 'CreateTime'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'FunctionName' => ['title' => '', 'description' => 'The function name.'."\n", 'type' => 'string', 'example' => 'function1', 'visibility' => 'Public', 'backendName' => 'FunctionName'], + 'FunctionType' => ['title' => '', 'description' => 'The type of the function. Currently, the supported enumeration is JAVA.'."\n", 'type' => 'string', 'example' => 'JAVA', 'visibility' => 'Public', 'backendName' => 'FunctionType'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.'."\n", 'type' => 'string', 'example' => 'zhangsan', 'visibility' => 'Public', 'backendName' => 'OwnerName'], + 'OwnerType' => ['title' => '', 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", 'type' => 'string', 'example' => 'USER', 'visibility' => 'Public', 'backendName' => 'OwnerType'], 'ResourceUri' => [ - 'title' => 'ResourceUri', + 'title' => '', 'description' => 'Resource URI of the function'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Resource URI of the function'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ResourceUri', - ], + 'items' => ['description' => 'Resource URI of the function'."\n", '$ref' => '#/components/schemas/ResourceUri', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'ResourceUri', + 'example' => '', ], - 'UpdateTime' => [ - 'title' => 'UpdateTime', - 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608863962', - 'backendName' => 'UpdateTime', - ], - 'CreatedBy' => [ - 'title' => 'CreatedBy', - 'description' => 'The user who created the drive.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'CreatedBy', - 'backendName' => 'CreatedBy', - ], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608863962', 'visibility' => 'Public', 'backendName' => 'UpdateTime'], + 'CreatedBy' => ['title' => '', 'description' => 'The user who created the drive.'."\n", 'type' => 'string', 'example' => 'CreatedBy', 'visibility' => 'Public', 'backendName' => 'CreatedBy'], ], + 'visibility' => 'Public', + 'example' => '', ], 'FunctionInput' => [ - 'title' => 'Function Input', + 'title' => '', 'description' => 'Functions'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'ClassName' => [ - 'title' => 'ClassName', - 'description' => 'The name of the Java class that contains the implementation of the function'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'com.xxx.xxxxFunction', - 'backendName' => 'ClassName', - ], - 'FunctionName' => [ - 'title' => 'FunctionName', - 'description' => 'The function name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'function1', - 'backendName' => 'FunctionName', - ], - 'FunctionType' => [ - 'title' => 'FunctionType', - 'description' => 'The type of the function. Currently, the supported enumeration is JAVA.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'JAVA', - 'backendName' => 'FunctionType', - ], - 'OwnerName' => [ - 'title' => 'OwnerName', - 'description' => 'The name of the owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'OwnerName', - ], - 'OwnerType' => [ - 'title' => 'OwnerType', - 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'OwnerType', - ], + 'ClassName' => ['title' => '', 'description' => 'The name of the Java class that contains the implementation of the function'."\n", 'type' => 'string', 'example' => 'com.xxx.xxxxFunction', 'visibility' => 'Public', 'backendName' => 'ClassName'], + 'FunctionName' => ['title' => '', 'description' => 'The function name.'."\n", 'type' => 'string', 'example' => 'function1', 'visibility' => 'Public', 'backendName' => 'FunctionName'], + 'FunctionType' => ['title' => '', 'description' => 'The type of the function. Currently, the supported enumeration is JAVA.'."\n", 'type' => 'string', 'example' => 'JAVA', 'visibility' => 'Public', 'backendName' => 'FunctionType'], + 'OwnerName' => ['title' => '', 'description' => 'The name of the owner.'."\n", 'type' => 'string', 'example' => 'zhangsan', 'visibility' => 'Public', 'backendName' => 'OwnerName'], + 'OwnerType' => ['title' => '', 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", 'type' => 'string', 'example' => 'USER', 'visibility' => 'Public', 'backendName' => 'OwnerType'], 'ResourceUri' => [ - 'title' => 'ResourceUri', + 'title' => '', 'description' => 'Resource URI of the function'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Resource URI of the function'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ResourceUri', - ], + 'items' => ['description' => 'Resource URI of the function'."\n", '$ref' => '#/components/schemas/ResourceUri', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'ResourceUri', + 'example' => '', ], - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'The time when the rule was created.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1638501155', - 'backendName' => 'CreateTime', - ], + 'CreateTime' => ['title' => '', 'description' => 'The time when the rule was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1638501155', 'visibility' => 'Public', 'backendName' => 'CreateTime'], ], + 'visibility' => 'Public', + 'example' => '', ], 'FunctionResource' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Authentication resource structure: Function.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => 'Database name', - 'description' => 'The name of the database.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'DatabaseName', - ], - 'FunctionName' => [ - 'title' => 'Function name', - 'description' => 'The name of the function.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'FunctioName', - ], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'default', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'FunctionName' => ['title' => '', 'description' => 'The name of the function.'."\n", 'type' => 'string', 'example' => 'default', 'visibility' => 'Public', 'backendName' => 'FunctioName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'GrantRevokeEntry' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'A short description of struct'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'MetaResource' => [ - 'title' => '', - 'description' => 'Authorized resource structure'."\n", - 'visibility' => 'public', - 'backendName' => 'MetaResource', - '$ref' => '#/components/schemas/MetaResource', - ], - 'Accesses' => [ - 'title' => '', - 'description' => 'Permissions Access List'."\n", - 'visibility' => 'public', - 'backendName' => 'Accesses', - '$ref' => '#/components/schemas/Accesses', - ], - 'DelegateAccesses' => [ - 'title' => '', - 'description' => 'Later through the server extension support'."\n", - 'visibility' => 'public', - 'backendName' => 'DelegateAccesses', - '$ref' => '#/components/schemas/Accesses', - ], - 'Principal' => [ - 'title' => '', - 'description' => 'The ARN of the unique identity.'."\n", - 'visibility' => 'public', - 'backendName' => 'Principal', - '$ref' => '#/components/schemas/Principal', - ], - 'Id' => [ - 'title' => 'identifier for this entry', - 'description' => 'The entry ID is used to process exception messages.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'CRW-7A1EC3D73BF419AF', - 'backendName' => 'Id', - ], + 'MetaResource' => ['title' => '', 'description' => 'Authorized resource structure'."\n", '$ref' => '#/components/schemas/MetaResource', 'visibility' => 'Public', 'backendName' => 'MetaResource', 'example' => ''], + 'Accesses' => ['title' => '', 'description' => 'Permissions Access List'."\n", '$ref' => '#/components/schemas/Accesses', 'visibility' => 'Public', 'backendName' => 'Accesses', 'example' => ''], + 'DelegateAccesses' => ['title' => '', 'description' => 'Later through the server extension support'."\n", '$ref' => '#/components/schemas/Accesses', 'visibility' => 'Public', 'backendName' => 'DelegateAccesses', 'example' => ''], + 'Principal' => ['title' => '', 'description' => 'The ARN of the unique identity.'."\n", '$ref' => '#/components/schemas/Principal', 'visibility' => 'Public', 'backendName' => 'Principal', 'example' => ''], + 'Id' => ['title' => '', 'description' => 'The entry ID is used to process exception messages.'."\n", 'type' => 'string', 'example' => 'CRW-7A1EC3D73BF419AF', 'visibility' => 'Public', 'backendName' => 'Id'], + ], + 'visibility' => 'Public', + 'example' => '', + ], + 'GrantRevokeFailureEntry' => [ + 'title' => 'A short description of struct', + 'description' => '批量授权错误时的结构', + 'type' => 'object', + 'properties' => [ + 'GrantRevokeEntry' => ['$ref' => '#/components/schemas/GrantRevokeEntry'], + 'ErrorDetail' => ['$ref' => '#/components/schemas/ErrorDetail'], + ], + ], + 'HighLight' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '高亮的key', 'type' => 'string', 'example' => 'name'], + 'Value' => ['title' => '高亮的value', 'type' => 'string', 'example' => '<em>tab</em>2'], ], ], 'IndicatorStatistic' => [ 'title' => '', - 'description' => 'Metric Detail Record'."\n", - 'visibility' => 'public', + 'description' => 'A detailed record for an indicator.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '', - 'description' => 'Detail Data'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Data', + 'Data' => ['title' => '', 'description' => 'The value of the indicator.', 'type' => 'integer', 'format' => 'int64', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Data'], + 'Date' => ['title' => '', 'description' => 'The date of the statistic in YYYYMM format.', 'type' => 'string', 'example' => '202401', 'visibility' => 'Public', 'backendName' => 'Date'], + ], + 'example' => '', + 'visibility' => 'Public', + ], + 'LifecycleResource' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'LifecycleRuleBizId' => ['title' => '生命周期规则id', 'type' => 'string'], + 'DatabaseName' => ['title' => '数据库名称', 'type' => 'string'], + 'TableName' => ['title' => '表名称', 'type' => 'string'], + 'GmtCreate' => ['title' => '创建时间', 'type' => 'string'], + 'TableProfile' => ['$ref' => '#/components/schemas/TableProfile'], + 'Database' => [ + 'title' => 'Database', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['title' => 'CreateTime', 'type' => 'integer', 'format' => 'int64'], + 'UpdateTime' => ['title' => 'UpdateTime', 'type' => 'integer', 'format' => 'int64'], + 'Description' => ['title' => 'Description', 'type' => 'string'], + 'LocationUri' => ['title' => 'LocationUri', 'type' => 'string'], + 'Name' => ['title' => 'Name', 'type' => 'string'], + ], ], - 'Date' => [ - 'title' => '', - 'description' => 'Detail Date'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '202401', - 'backendName' => 'Date', + 'Table' => [ + 'title' => 'Table', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['title' => 'CreateTime', 'type' => 'integer', 'format' => 'int64'], + 'Parameters' => [ + 'title' => 'Parameters', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'DatabaseName' => ['title' => 'DatabaseName', 'type' => 'string'], + 'TableName' => ['title' => 'TableName', 'type' => 'string'], + 'TableType' => ['title' => 'TableType', 'type' => 'string'], + 'Sd' => [ + 'title' => 'Sd', + 'type' => 'object', + 'properties' => [ + 'BucketCols' => [ + 'title' => 'BucketCols', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'InputFormat' => ['title' => 'InputFormat', 'type' => 'string'], + 'Location' => ['title' => 'Location', 'type' => 'string'], + 'OutputFormat' => ['title' => 'OutputFormat', 'type' => 'string'], + 'Parameters' => [ + 'title' => 'Parameters', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'SerDeInfo' => [ + 'title' => 'SerDeInfo', + 'type' => 'object', + 'properties' => [ + 'Parameters' => [ + 'title' => 'Parameters', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'SerializationLib' => ['title' => 'SerializationLib', 'type' => 'string'], + 'Name' => ['title' => 'Name', 'type' => 'string'], + ], + ], + ], + ], + ], ], + 'DatabaseProfile' => ['title' => 'DatabaseProfile', '$ref' => '#/components/schemas/DatabaseProfile'], + 'Owner' => ['title' => 'Owner', 'type' => 'integer', 'format' => 'int64'], + 'BizId' => ['title' => 'BizId', 'type' => 'string'], + 'CatalogId' => ['title' => '目录名称', 'type' => 'string'], ], ], 'LifecycleRule' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The information about the lifecycle rule.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'BizId' => [ - 'title' => 'bizId', - 'description' => 'The business ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'bizId', - ], - 'GmtCreate' => [ - 'title' => '', - 'description' => 'The time when the tunnel was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'gmtCreate', - ], - 'GmtModified' => [ - 'title' => '', - 'description' => 'The time when the data address was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'gmtModified', - ], - 'Name' => [ - 'title' => 'name', - 'description' => 'The rule name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'name', - ], - 'ResourceType' => [ - 'title' => 'resourceType', - 'description' => 'The resource type that supports the drift detection feature.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'resourceType', - ], - 'BindCount' => [ - 'title' => 'bindCount', - 'description' => 'The number of resources bound to the lifecycle rule.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'bindCount', - ], - 'Description' => [ - 'title' => 'description', - 'description' => 'The description of the synchronization task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'description', - ], - 'RuleType' => [ - 'title' => 'ruleType', - 'description' => 'The WAF rule type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'ruleType', - ], - 'Config' => [ - 'title' => 'Config', - 'description' => 'The configuration of the data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'config', - ], - 'IaDays' => [ - 'title' => 'iaDays', - 'description' => 'The number of days in which the lifecycle is set.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'iaDays', - ], - 'ArchiveDays' => [ - 'title' => 'archiveDays', - 'description' => 'The number of days to archive in the lifecycle settings.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'archiveDays', - ], - 'ColdArchiveDays' => [ - 'title' => 'coldArchiveDays', - 'description' => 'The number of days to transfer to Cold Archive.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'coldArchiveDays', - ], - 'ScheduleStatus' => [ - 'title' => 'scheduleStatus', - 'description' => 'The scheduling status.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'scheduleStatus', - ], - 'Workflow' => [ - 'title' => '', - 'description' => 'The workflow.'."\n", - 'visibility' => 'Public', - 'backendName' => 'workflow', - '$ref' => '#/components/schemas/Workflow', - ], - 'WorkflowId' => [ - 'title' => '', - 'description' => 'The workflow ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'workflowId', - ], - 'WorkflowInstance' => [ - 'title' => '', - 'description' => 'The workflow instance.'."\n", - 'visibility' => 'Public', - 'backendName' => 'workflowInstance', - '$ref' => '#/components/schemas/WorkflowInstance', - ], - 'CatalogId' => [ - 'title' => '', - 'description' => 'The ID of the data directory.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'catalogName', - ], + 'BizId' => ['title' => '', 'description' => 'The business ID.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'bizId', 'example' => ''], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the tunnel was created.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'gmtCreate', 'example' => ''], + 'GmtModified' => ['title' => '', 'description' => 'The time when the data address was last modified.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'gmtModified', 'example' => ''], + 'Name' => ['title' => '', 'description' => 'The rule name.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'name', 'example' => ''], + 'ResourceType' => ['title' => '', 'description' => 'The resource type that supports the drift detection feature.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'resourceType', 'example' => ''], + 'BindCount' => ['title' => '', 'description' => 'The number of resources bound to the lifecycle rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'visibility' => 'Public', 'backendName' => 'bindCount', 'example' => ''], + 'Description' => ['title' => '', 'description' => 'The description of the synchronization task.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'description', 'example' => ''], + 'RuleType' => ['title' => '', 'description' => 'The WAF rule type.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'ruleType', 'example' => ''], + 'Config' => ['title' => '', 'description' => 'The configuration of the data.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'config', 'example' => ''], + 'IaDays' => ['title' => '', 'description' => 'The number of days in which the lifecycle is set.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'iaDays'], + 'ArchiveDays' => ['title' => '', 'description' => 'The number of days to archive in the lifecycle settings.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'archiveDays'], + 'ColdArchiveDays' => ['title' => '', 'description' => 'The number of days to transfer to Cold Archive.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'coldArchiveDays'], + 'ScheduleStatus' => ['title' => '', 'description' => 'The scheduling status.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'scheduleStatus', 'example' => ''], + 'Workflow' => ['title' => '', 'description' => 'The workflow.'."\n", '$ref' => '#/components/schemas/Workflow', 'visibility' => 'Public', 'backendName' => 'workflow', 'example' => ''], + 'WorkflowId' => ['title' => '', 'description' => 'The workflow ID.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'workflowId', 'example' => ''], + 'WorkflowInstance' => ['title' => '', 'description' => 'The workflow instance.'."\n", '$ref' => '#/components/schemas/WorkflowInstance', 'visibility' => 'Public', 'backendName' => 'workflowInstance', 'example' => ''], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data directory.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'catalogName', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'ListFieldSchema' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'ListFieldSchema array'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The definitions of table fields.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchema', - ], + 'items' => ['description' => 'The definitions of table fields.'."\n", '$ref' => '#/components/schemas/FieldSchema', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'parseType' => 'json', + 'example' => '', ], 'ListResourceUri' => [ 'title' => 'ResourceUri', 'description' => 'Resource URI list'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Resource URI'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ResourceType' => [ - 'title' => 'ResourceType', - 'description' => 'resource type, the enumeration includes JAR FILE ARCHIVE'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'JAR', - ], - 'Uri' => [ - 'title' => 'Uri', - 'description' => 'URI resource address'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'hdfs:///tmp/jar1.jar', - ], + 'ResourceType' => ['title' => 'ResourceType', 'description' => 'resource type, the enumeration includes JAR FILE ARCHIVE'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'JAR'], + 'Uri' => ['title' => 'Uri', 'description' => 'URI resource address'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'hdfs:///tmp/jar1.jar'], ], 'extendType' => 'true', ], @@ -1434,2650 +597,1286 @@ 'itemName' => 'ResourceUri', ], 'ListString' => [ - 'title' => 'ListString Object', + 'title' => '', 'description' => 'ListString'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The key value.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2010', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The key value.'."\n", 'type' => 'string', 'example' => '2010', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'parseType' => 'json', + 'example' => '', + ], + 'LocationStorageRankDTO' => [ + 'title' => 'Location存储排名', + 'description' => 'location存储量排名', + 'type' => 'object', + 'properties' => [ + 'Location' => ['title' => 'oss路径', 'type' => 'string'], + 'Storage' => ['title' => '存储量', 'type' => 'integer', 'format' => 'int64'], + 'FileCnt' => ['title' => '文件数量', 'type' => 'integer', 'format' => 'int64'], + ], ], 'LockObj' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'LockObj'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1344371', - 'backendName' => 'CatalogId', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'DatabaseName', - ], - 'PartitionName' => [ - 'title' => 'PartitionName', - 'description' => 'The name of the partition. This parameter is optional.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'dt', - 'backendName' => 'PartitionName', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the metadata table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_table', - 'backendName' => 'TableName', - ], + 'CatalogId' => ['title' => '', 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n", 'type' => 'string', 'example' => '1344371', 'visibility' => 'Public', 'backendName' => 'CatalogId'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'PartitionName' => ['title' => '', 'description' => 'The name of the partition. This parameter is optional.'."\n", 'type' => 'string', 'example' => 'dt', 'visibility' => 'Public', 'backendName' => 'PartitionName'], + 'TableName' => ['title' => '', 'description' => 'The name of the metadata table.'."\n", 'type' => 'string', 'example' => 'test_table', 'visibility' => 'Public', 'backendName' => 'TableName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'LockStatus' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'LockStatus'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'LockId' => [ - 'title' => 'LockId', - 'description' => 'Unique lock ID'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'LockId', - ], - 'LockState' => [ - 'title' => 'ACQUIRED/NOT_ACQUIRED', - 'description' => 'The status of the lock. Valid values: ACQUIRED and NOT_ACQUIRED.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ACQUIRED', - 'backendName' => 'LockState', - ], + 'LockId' => ['title' => '', 'description' => 'Unique lock ID'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'LockId'], + 'LockState' => ['title' => '', 'description' => 'The status of the lock. Valid values: ACQUIRED and NOT_ACQUIRED.'."\n", 'type' => 'string', 'example' => 'ACQUIRED', 'visibility' => 'Public', 'backendName' => 'LockState'], ], + 'visibility' => 'Public', + 'example' => '', ], 'LogInfo' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'View logs.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'title' => '', - 'description' => 'The time when the data address was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'gmtCreate', - ], - 'InstanceId' => [ - 'title' => '', - 'description' => 'The instance ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'instanceId', - ], - 'BizTime' => [ - 'title' => '', - 'description' => 'Business up time'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'bizTime', - ], - 'LogType' => [ - 'title' => '', - 'description' => 'The log level.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'logType', - ], - 'LogId' => [ - 'title' => '', - 'description' => 'log id'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'logId', - ], - 'LogSummary' => [ - 'title' => '', - 'description' => 'Log Summary'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'logSummary', - ], - 'LogContent' => [ - 'title' => '', - 'description' => 'The returned entries.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'logContent', - ], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the data address was created.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'gmtCreate', 'example' => ''], + 'InstanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'instanceId', 'example' => ''], + 'BizTime' => ['title' => '', 'description' => 'Business up time'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'bizTime', 'example' => ''], + 'LogType' => ['title' => '', 'description' => 'The log level.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'logType', 'example' => ''], + 'LogId' => ['title' => '', 'description' => 'log id'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'logId', 'example' => ''], + 'LogSummary' => ['title' => '', 'description' => 'Log Summary'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'logSummary', 'example' => ''], + 'LogContent' => ['title' => '', 'description' => 'The returned entries.'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'logContent', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'MetaResource' => [ - 'title' => 'A short description of struct', - 'description' => 'Authentication resource structure'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The resource structure for authentication.', 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'title' => '', - 'description' => 'Metadata resource object type'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TABLE: metadata table.'."\n" - .'* DATABASE: metabase.'."\n" - .'* COLUMN: field.'."\n" - .'* CATALOG: the metadata directory.'."\n" - .'* FUNCTION: function.'."\n", - 'visibility' => 'public', + 'description' => 'The object type of the metadata resource.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'TABLE' => 'TABLE', - 'DATABASE' => 'DATABASE', - 'COLUMN' => 'COLUMN', - ' CATALOG' => ' CATALOG', - ' FUNCTION' => ' FUNCTION', - ], + 'enumValueTitles' => ['TABLE' => '元数据表', 'DATABASE' => '元数据库', 'COLUMN' => '字段', ' CATALOG' => ' 元数据目录', ' FUNCTION' => ' 函数'], 'example' => 'TABLE', + 'visibility' => 'Public', 'backendName' => 'ResourceType', ], - 'CatalogResource' => [ - 'title' => 'catalog resource', - 'description' => 'Catalog resources'."\n", - 'visibility' => 'public', - 'example' => '', - 'backendName' => 'CatalogResource', - '$ref' => '#/components/schemas/CatalogResource', - ], - 'DatabaseResource' => [ - 'title' => 'database resource', - 'description' => 'Database resources'."\n", - 'visibility' => 'public', - 'example' => '', - 'backendName' => 'DatabaseResource', - '$ref' => '#/components/schemas/DatabaseResource', - ], - 'TableResource' => [ - 'title' => 'table resource', - 'description' => 'Table resources'."\n", - 'visibility' => 'public', - 'example' => '', - 'backendName' => 'TableResource', - '$ref' => '#/components/schemas/TableResource', - ], - 'FunctionResource' => [ - 'title' => 'function resource', - 'description' => 'Function resources'."\n", - 'visibility' => 'public', - 'example' => '', - 'backendName' => 'FunctionResource', - '$ref' => '#/components/schemas/FunctionResource', - ], - 'ColumnResource' => [ - 'title' => 'column resource', - 'description' => 'Column resources'."\n", - 'visibility' => 'public', - 'example' => '', - 'backendName' => 'ColumnResource', - '$ref' => '#/components/schemas/ColumnResource', - ], + 'CatalogResource' => ['title' => '', 'description' => 'The catalog resource.', '$ref' => '#/components/schemas/CatalogResource', 'example' => '参看字段结构', 'visibility' => 'Public', 'backendName' => 'CatalogResource'], + 'DatabaseResource' => ['title' => '', 'description' => 'The database resource.', '$ref' => '#/components/schemas/DatabaseResource', 'example' => '参看字段结构', 'visibility' => 'Public', 'backendName' => 'DatabaseResource'], + 'TableResource' => ['title' => '', 'description' => 'The table resource.', '$ref' => '#/components/schemas/TableResource', 'example' => '参看字段结构', 'visibility' => 'Public', 'backendName' => 'TableResource'], + 'FunctionResource' => ['title' => '', 'description' => 'The function resource.', '$ref' => '#/components/schemas/FunctionResource', 'example' => '参看字段结构', 'visibility' => 'Public', 'backendName' => 'FunctionResource'], + 'ColumnResource' => ['title' => '', 'description' => 'The column resource.', '$ref' => '#/components/schemas/ColumnResource', 'example' => '参看字段结构', 'visibility' => 'Public', 'backendName' => 'ColumnResource'], ], + 'example' => '', + 'visibility' => 'Public', ], 'Order' => [ - 'title' => 'Order Object', + 'title' => '', 'description' => 'Order'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Col' => [ - 'title' => 'Col', - 'description' => 'The name of the field.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'col1', - ], - 'Order' => [ - 'title' => 'Order', - 'description' => '1 indicates ascending order, 0 indicates descending order'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Col' => ['title' => '', 'description' => 'The name of the field.'."\n", 'type' => 'string', 'example' => 'col1', 'visibility' => 'Public'], + 'Order' => ['title' => '', 'description' => '1 indicates ascending order, 0 indicates descending order'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Parameters' => [ - 'title' => 'parameter map', + 'title' => '', 'description' => 'Parameters'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Parameter key/value'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key', - ], + 'additionalProperties' => ['description' => 'Parameter key/value'."\n", 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'title' => ''], + 'visibility' => 'Public', 'parseType' => 'json', + 'example' => '', ], 'Partition' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Partition'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'title' => 'CreateTime', - 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608730999', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - ], - 'LastAccessTime' => [ - 'title' => 'LastAccessTime', - 'description' => 'The time when the partition was last accessed. The value is in the UNIX timestamp format. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608730999', - ], - 'LastAnalyzedTime' => [ - 'title' => 'LastAnalyzedTime', - 'description' => 'The time when the last statistical operation was performed. The value is in the UNIX timestamp format. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608730999', - ], + 'CreateTime' => ['title' => '', 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608730999', 'visibility' => 'Public'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public'], + 'LastAccessTime' => ['title' => '', 'description' => 'The time when the partition was last accessed. The value is in the UNIX timestamp format. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608730999', 'visibility' => 'Public'], + 'LastAnalyzedTime' => ['title' => '', 'description' => 'The time when the last statistical operation was performed. The value is in the UNIX timestamp format. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608730999', 'visibility' => 'Public'], 'Parameters' => [ - 'title' => 'Parameters', + 'title' => '', 'description' => 'The KVPs that are related to the partition.'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Key-value pair'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key', - ], - ], - 'Privileges' => [ - 'description' => 'The configurations of permissions. This parameter can be left empty.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/PrincipalPrivilegeSet', - ], - 'Sd' => [ - 'description' => 'The descriptor of the storage.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/StorageDescriptor', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the metadata table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_table_20201223', + 'additionalProperties' => ['description' => 'Key-value pair'."\n", 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'title' => ''], + 'visibility' => 'Public', + 'example' => '', ], + 'Privileges' => ['description' => 'The configurations of permissions. This parameter can be left empty.'."\n", '$ref' => '#/components/schemas/PrincipalPrivilegeSet', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'Sd' => ['description' => 'The descriptor of the storage.'."\n", '$ref' => '#/components/schemas/StorageDescriptor', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the metadata table.'."\n", 'type' => 'string', 'example' => 'test_table_20201223', 'visibility' => 'Public'], 'Values' => [ - 'title' => 'Values', + 'title' => '', 'description' => 'The values in the partition.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The values in the partition.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'part1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The values in the partition.'."\n", 'type' => 'string', 'example' => 'part1', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'PartitionError' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'PartitionError'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'ErrorDetail' => [ - 'description' => 'Error message'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/ErrorDetail', - ], - 'PartitionValues' => [ - 'description' => 'The value in a partition key column.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/ListString', - ], + 'ErrorDetail' => ['description' => 'Error message'."\n", '$ref' => '#/components/schemas/ErrorDetail', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'PartitionValues' => ['description' => 'The value in a partition key column.'."\n", '$ref' => '#/components/schemas/ListString', 'visibility' => 'Public', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'PartitionInput' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Partition'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'DatabaseName', - ], - 'LastAccessTime' => [ - 'title' => 'LastAccessTime', - 'description' => 'The time when the partition was last accessed. The value is a UNIX timestamp. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608730999', - 'backendName' => 'LastAccessTime', - ], - 'LastAnalyzedTime' => [ - 'title' => 'LastAnalyzedTime', - 'description' => 'The time when the statistical operation was last performed. The value is a UNIX timestamp. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608730999', - 'backendName' => 'LastAnalyzedTime', - ], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'LastAccessTime' => ['title' => '', 'description' => 'The time when the partition was last accessed. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608730999', 'visibility' => 'Public', 'backendName' => 'LastAccessTime'], + 'LastAnalyzedTime' => ['title' => '', 'description' => 'The time when the statistical operation was last performed. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608730999', 'visibility' => 'Public', 'backendName' => 'LastAnalyzedTime'], 'Parameters' => [ - 'title' => 'Parameters', + 'title' => '', 'description' => 'The KVPs that are related to the partition.'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Key-value pair'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key', - ], + 'additionalProperties' => ['description' => 'Key-value pair'."\n", 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'Parameters', + 'example' => '', ], - 'Privileges' => [ - 'description' => 'The configurations of permissions. This parameter can be left empty.'."\n", - 'visibility' => 'public', - 'backendName' => 'Privileges', - '$ref' => '#/components/schemas/PrincipalPrivilegeSet', - ], - 'Sd' => [ - 'description' => 'The descriptor of the storage.'."\n", - 'visibility' => 'public', - 'backendName' => 'Sd', - '$ref' => '#/components/schemas/StorageDescriptor', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the metadata table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_table_20201223', - 'backendName' => 'TableName', - ], + 'Privileges' => ['description' => 'The configurations of permissions. This parameter can be left empty.'."\n", '$ref' => '#/components/schemas/PrincipalPrivilegeSet', 'visibility' => 'Public', 'backendName' => 'Privileges', 'title' => '', 'example' => ''], + 'Sd' => ['description' => 'The descriptor of the storage.'."\n", '$ref' => '#/components/schemas/StorageDescriptor', 'visibility' => 'Public', 'backendName' => 'Sd', 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the metadata table.'."\n", 'type' => 'string', 'example' => 'test_table_20201223', 'visibility' => 'Public', 'backendName' => 'TableName'], 'Values' => [ - 'title' => 'Values', + 'title' => '', 'description' => 'The values in the partition.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The values in the partition.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'part1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The values in the partition.'."\n", 'type' => 'string', 'example' => 'part1', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'Values', + 'example' => '', ], - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'The time when the rule was created.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1635147901', - 'backendName' => 'CreateTime', - ], + 'CreateTime' => ['title' => '', 'description' => 'The time when the rule was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1635147901', 'visibility' => 'Public', 'backendName' => 'CreateTime'], ], + 'visibility' => 'Public', + 'example' => '', ], 'PartitionProfile' => [ 'title' => '', - 'description' => 'Partition data profile'."\n", - 'visibility' => 'public', + 'description' => 'The data profile of a partition.', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => '', - 'description' => 'The library name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_db', - 'backendName' => 'databaseName', - ], - 'TableName' => [ - 'title' => '', - 'description' => 'The name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_tbl', - 'backendName' => 'tableName', - ], - 'PartitionName' => [ - 'title' => '', - 'description' => 'The name of the partition.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'year=2023/month=1', - 'backendName' => 'partitionName', - ], - 'ArchiveStatus' => [ - 'title' => '', - 'description' => 'oss storage type'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'STANDARD', - 'backendName' => 'archiveStatus', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the data address was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-08-16 18:02:22', - 'backendName' => 'createTime', - ], - 'LastModifyTime' => [ - 'title' => '', - 'description' => 'The time when the configurations of the domain name were updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-08-16 18:02:25', - 'backendName' => 'lastModifyTime', - ], - 'LastAccessTime' => [ - 'title' => '', - 'description' => 'last access time (from oss or oss-hdfs audit logs)'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-08-22 12:14:42', - 'backendName' => 'lastAccessTime', - ], - 'LastAccessNumTime' => [ - 'title' => '', - 'description' => 'Last Access Time (Discarded)'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'lastAccessNumTime', - ], - 'Location' => [ - 'title' => '', - 'description' => 'The location where the sample is stored.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1', - 'backendName' => 'location', - ], - 'FileSize' => [ - 'title' => '', - 'description' => 'Partition size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - 'backendName' => 'fileSize', - ], - 'ObjectSize' => [ - 'title' => '', - 'description' => 'partition size (from oss or oss-hdfs inventory)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - 'backendName' => 'objectSize', - ], - 'FileCnt' => [ - 'title' => '', - 'description' => 'Number of local files to synchronize'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'fileCnt', - ], - 'ObjectCnt' => [ - 'title' => '', - 'description' => 'Number of files (from oss or oss-hdfs list)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'objectCnt', - ], - 'AccessNum' => [ - 'title' => '', - 'description' => 'Visits of the Day (Deprecated)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'accessNum', - ], - 'AccessNumWeekly' => [ - 'title' => '', - 'description' => 'Visits in Last 7 Days (Deprecated)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'accessNumWeekly', - ], - 'AccessNumMonthly' => [ - 'title' => '', - 'description' => 'Visits in Last 30 Days (Deprecated)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'accessNumMonthly', - ], - 'ObjectAccessNum' => [ - 'title' => '', - 'description' => 'Number of file accesses in the last day (from oss-hdfs audit logs)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'objectAccessNum', - ], - 'ObjectAccessNumWeekly' => [ - 'title' => '', - 'description' => 'Number of file accesses in the last seven days (from oss-hdfs audit logs)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - 'backendName' => 'objectAccessNumWeekly', - ], - 'ObjectAccessNumMonthly' => [ - 'title' => '', - 'description' => 'Number of file accesses in the last 30 days (from oss-hdfs audit logs)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - 'backendName' => 'objectAccessNumMonthly', - ], - 'DataSourceType' => [ - 'title' => '', - 'description' => 'The type of the source from which storage is collected.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'OSS_HDFS', - 'backendName' => 'dataSourceType', - ], - ], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'example' => 'test_db', 'visibility' => 'Public', 'backendName' => 'databaseName'], + 'TableName' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'example' => 'test_tbl', 'visibility' => 'Public', 'backendName' => 'tableName'], + 'PartitionName' => ['title' => '', 'description' => 'The name of the partition.', 'type' => 'string', 'example' => 'year=2023/month=1', 'visibility' => 'Public', 'backendName' => 'partitionName'], + 'ArchiveStatus' => ['title' => '', 'description' => 'The OSS storage class.', 'type' => 'string', 'example' => 'STANDARD', 'visibility' => 'Public', 'backendName' => 'archiveStatus'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the partition was created, in `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'example' => '2023-08-16 18:02:22', 'visibility' => 'Public', 'backendName' => 'createTime'], + 'LastModifyTime' => ['title' => '', 'description' => 'The time when the partition was last modified, in `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'example' => '2023-08-16 18:02:25', 'visibility' => 'Public', 'backendName' => 'lastModifyTime'], + 'LastAccessTime' => ['title' => '', 'description' => 'The last access time of the partition. This is collected from OSS or OSS-HDFS audit logs.', 'type' => 'string', 'example' => '2023-08-22 12:14:42', 'visibility' => 'Public', 'backendName' => 'lastAccessTime'], + 'LastAccessNumTime' => ['title' => '', 'description' => '(Deprecated) The last access time.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'lastAccessNumTime'], + 'Location' => ['title' => '', 'description' => 'The storage location.', 'type' => 'string', 'example' => 'oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/year=2023/month=1', 'visibility' => 'Public', 'backendName' => 'location'], + 'FileSize' => ['title' => '', 'description' => 'The partition size in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'visibility' => 'Public', 'backendName' => 'fileSize'], + 'ObjectSize' => ['title' => '', 'description' => 'The partition size in bytes. This is reported by an OSS or OSS-HDFS inventory.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'visibility' => 'Public', 'backendName' => 'objectSize'], + 'FileCnt' => ['title' => '', 'description' => 'The number of files.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'fileCnt'], + 'ObjectCnt' => ['title' => '', 'description' => 'The number of files. This is reported by an OSS or OSS-HDFS inventory.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'objectCnt'], + 'AccessNum' => ['title' => '', 'description' => '(Deprecated) The number of access requests on the current day.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'accessNum'], + 'AccessNumWeekly' => ['title' => '', 'description' => '(Deprecated) The total number of access requests in the last 7 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'accessNumWeekly'], + 'AccessNumMonthly' => ['title' => '', 'description' => '(Deprecated) The total number of access requests in the last 30 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'accessNumMonthly'], + 'ObjectAccessNum' => ['title' => '', 'description' => 'The number of file access requests in the last 24 hours. This is collected from OSS-HDFS audit logs.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'objectAccessNum'], + 'ObjectAccessNumWeekly' => ['title' => '', 'description' => 'The total number of file access requests in the last 7 days. This is collected from OSS-HDFS audit logs.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'visibility' => 'Public', 'backendName' => 'objectAccessNumWeekly'], + 'ObjectAccessNumMonthly' => ['title' => '', 'description' => 'The total number of file access requests in the last 30 days. This is collected from OSS-HDFS audit logs.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'visibility' => 'Public', 'backendName' => 'objectAccessNumMonthly'], + 'DataSourceType' => ['title' => '', 'description' => 'The type of data source from which storage metrics are collected.', 'type' => 'string', 'example' => 'OSS_HDFS', 'visibility' => 'Public', 'backendName' => 'dataSourceType'], + ], + 'example' => '', + 'visibility' => 'Public', ], 'PartitionSpec' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Partition structure of shared sd'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'SharedSDPartitions' => [ - 'title' => 'SharedSDPartitions', + 'title' => '', 'description' => 'Shared partition list, which indicates the common parts of multiple partitions'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Shard'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Partition', - ], + 'items' => ['description' => 'Shard'."\n", '$ref' => '#/components/schemas/Partition', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'SharedSDPartitions', + 'example' => '', ], 'SharedStorageDescriptor' => [ - 'title' => 'SharedStorageDescriptor', + 'title' => '', 'description' => 'Shared SD information, indicating that multiple partitions share the same SD'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'Cols' => [ - 'title' => 'Cols', + 'title' => '', 'description' => 'The column content.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Details of each column'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchema', - ], + 'items' => ['description' => 'Details of each column'."\n", '$ref' => '#/components/schemas/FieldSchema', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'Cols', - ], - 'Location' => [ - 'title' => 'Location', - 'description' => 'The location of the data.'."\n", - 'visibility' => 'public', - 'type' => 'string', 'example' => '', - 'backendName' => 'Location', ], + 'Location' => ['title' => '', 'description' => 'The location of the data.'."\n", 'type' => 'string', 'example' => '相对路径', 'visibility' => 'Public', 'backendName' => 'Location'], ], + 'visibility' => 'Public', 'backendName' => 'SharedStorageDescriptor', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'PartitionValueList' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'PartitionValueList'."\n", - 'visibility' => 'public', 'type' => 'array', 'items' => [ 'description' => 'Object of partition value'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Values' => [ - 'description' => 'Partition value'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/ListString', - ], + 'Values' => ['description' => 'Partition value'."\n", '$ref' => '#/components/schemas/ListString', 'visibility' => 'Public', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', 'extendType' => 'true', + 'title' => '', + 'example' => '', ], + 'visibility' => 'Public', 'parseType' => 'json', + 'example' => '', ], 'Principal' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The ARN of the unique identity.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'PrincipalArn' => [ - 'title' => '', - 'description' => 'ram user/ram role principal, in the format of acs:ram::\\[accountId]:user/userName, acs:ram::\\[accountId]:role/roleName'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs:ram::[AliyunAccountId]:user/username_abc', - 'backendName' => 'PrincipalArn', - ], + 'PrincipalArn' => ['title' => '', 'description' => 'ram user/ram role principal, in the format of acs:ram::\\[accountId]:user/userName, acs:ram::\\[accountId]:role/roleName'."\n", 'type' => 'string', 'example' => 'acs:ram::[AliyunAccountId]:user/username_abc', 'visibility' => 'Public', 'backendName' => 'PrincipalArn'], ], + 'visibility' => 'Public', + 'example' => '', ], 'PrincipalPrivilegeSet' => [ - 'title' => 'PrincipalPrivilegeSet Object', + 'title' => '', 'description' => 'The set of permissions owned by the principal.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'GroupPrivileges' => [ - 'description' => 'The permission set of the user group.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/Privileges', - ], - 'RolePrivileges' => [ - 'description' => 'The permission set of the role.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/Privileges', - ], - 'UserPrivileges' => [ - 'description' => 'The permission set of the user.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/Privileges', - ], + 'GroupPrivileges' => ['description' => 'The permission set of the user group.'."\n", '$ref' => '#/components/schemas/Privileges', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'RolePrivileges' => ['description' => 'The permission set of the role.'."\n", '$ref' => '#/components/schemas/Privileges', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'UserPrivileges' => ['description' => 'The permission set of the user.'."\n", '$ref' => '#/components/schemas/Privileges', 'visibility' => 'Public', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', 'parseType' => 'json', + 'example' => '', + ], + 'PrincipalResourcePermissions' => [ + 'title' => 'Principal和资源的权限信息', + 'type' => 'object', + 'properties' => [ + 'Principal' => ['title' => '权限信息所属的Principal', 'required' => true, '$ref' => '#/components/schemas/Principal'], + 'MetaResource' => ['title' => '权限信息所属的Hive元数据资源', 'required' => true, '$ref' => '#/components/schemas/MetaResource'], + 'Accesses' => ['title' => '权限', '$ref' => '#/components/schemas/Accesses'], + 'DelegateAccesses' => ['title' => 'grantable权限', '$ref' => '#/components/schemas/Accesses'], + ], + ], + 'PrincipalResourcePermissionsList' => [ + 'title' => 'A short description of struct', + 'description' => '权限列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/PrincipalResourcePermissions'], ], 'Principals' => [ 'title' => '', 'description' => 'Principal list'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Principal'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Principal', - ], + 'items' => ['description' => 'Principal'."\n", '$ref' => '#/components/schemas/Principal', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'parseType' => 'struct', + 'example' => '', ], 'PrivilegeGrantInfo' => [ - 'title' => 'PrivilegeGrantInfo', + 'title' => '', 'description' => 'The information about permissions.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'title' => 'createTime', - 'description' => 'The time when the instance was created. The value is a UNIX timestamp. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1606226844', - ], - 'GrantOption' => [ - 'title' => 'grantOption', - 'description' => 'Whether to grant the authorization permission.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Grantor' => [ - 'title' => 'grantor', - 'description' => 'The subject of the authorization.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Grantor', - ], - 'GrantorType' => [ - 'title' => 'grantorType', - 'description' => 'The type of the authorization principal.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'GrantorType', - ], - 'Privilege' => [ - 'title' => 'privilege', - 'description' => 'The permission information.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Privilege', - ], + 'CreateTime' => ['title' => '', 'description' => 'The time when the instance was created. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1606226844', 'visibility' => 'Public'], + 'GrantOption' => ['title' => '', 'description' => 'Whether to grant the authorization permission.'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], + 'Grantor' => ['title' => '', 'description' => 'The subject of the authorization.'."\n", 'type' => 'string', 'example' => 'Grantor', 'visibility' => 'Public'], + 'GrantorType' => ['title' => '', 'description' => 'The type of the authorization principal.'."\n", 'type' => 'string', 'example' => 'GrantorType', 'visibility' => 'Public'], + 'Privilege' => ['title' => '', 'description' => 'The permission information.'."\n", 'type' => 'string', 'example' => 'Privilege', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'PrivilegeResource' => [ - 'title' => 'A short description of struct', - 'description' => 'Privilege Resource'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'Resource permission information.', 'type' => 'object', 'properties' => [ - 'MetaResource' => [ - 'title' => 'resource', - 'description' => 'Metadata resources.'."\n", - 'visibility' => 'public', - 'backendName' => 'MetaResource', - '$ref' => '#/components/schemas/MetaResource', - ], - 'Access' => [ - 'title' => 'Access type', - 'description' => 'Access type'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Drop', - 'backendName' => 'Access', - ], + 'MetaResource' => ['title' => '', 'description' => 'The metadata resource.', '$ref' => '#/components/schemas/MetaResource', 'example' => '', 'visibility' => 'Public', 'backendName' => 'MetaResource'], + 'Access' => ['title' => '', 'description' => 'The access type.', 'type' => 'string', 'example' => 'Drop', 'visibility' => 'Public', 'backendName' => 'Access'], ], + 'example' => '', + 'visibility' => 'Public', ], 'PrivilegeResources' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Authentication resource list'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The information about resource permissions.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/PrivilegeResource', - ], + 'items' => ['description' => 'The information about resource permissions.'."\n", '$ref' => '#/components/schemas/PrivilegeResource', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'parseType' => 'struct', 'itemName' => 'PrivilegeResource', + 'example' => '', ], 'Privileges' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The permission information.'."\n", - 'visibility' => 'public', 'type' => 'object', 'additionalProperties' => [ 'description' => 'The permissions.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The information about permissions.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/PrivilegeGrantInfo', - ], + 'items' => ['description' => 'The information about permissions.'."\n", '$ref' => '#/components/schemas/PrivilegeGrantInfo', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', + 'title' => '', + 'example' => '', ], + 'visibility' => 'Public', 'parseType' => 'json', + 'example' => '', ], 'ResourceUri' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'ResourceUri'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'ResourceType' => [ - 'title' => 'ResourceType', - 'description' => 'resource type, the enumeration includes JAR FILE ARCHIVE'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'JAR', - ], - 'Uri' => [ - 'title' => 'Uri', - 'description' => 'URI resource address'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'hdfs:///tmp/jar1.jar', - ], + 'ResourceType' => ['title' => '', 'description' => 'resource type, the enumeration includes JAR FILE ARCHIVE'."\n", 'type' => 'string', 'example' => 'JAR', 'visibility' => 'Public'], + 'Uri' => ['title' => '', 'description' => 'URI resource address'."\n", 'type' => 'string', 'example' => 'hdfs:///tmp/jar1.jar', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Role' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Data Lake Metadata Role'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'name', - 'description' => 'The name of the role.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'role_name', - 'backendName' => 'Name', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the role.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'role description', - 'backendName' => 'Description', - ], - 'Users' => [ - 'description' => 'The ram user/ram role principal list, in the format of acs:ram::\\[accountId]:user/userName, acs:ram::\\[accountId]:role/roleName'."\n", - 'visibility' => 'public', - 'example' => '["acs:ram::111:role/role_name", "acs:ram::111:role/role_name"]', - 'backendName' => 'Users', - '$ref' => '#/components/schemas/Principals', - ], - 'DisplayName' => [ - 'title' => 'DisplayName', - 'description' => 'Role display name'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'DisplayName', - ], - 'PrincipalArn' => [ - 'title' => 'PrincipalArn', - 'description' => 'The principal ARN of the data lake role, in the format of acs:dlf::\\[accountId]:role/\\[roleName]'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs:dlf::111:role/role_name', - 'backendName' => 'PrincipalArn', - ], - 'CreateTime' => [ - 'title' => 'CreateTime', - 'description' => 'The time when the role was created.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1647323053', - 'backendName' => 'CreateTime', - ], - 'UpdateTime' => [ - 'title' => 'UpdateTime', - 'description' => 'The time when the role was updated.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1647323053', - 'backendName' => 'UpdateTime', - ], - 'IsPredefined' => [ - 'title' => 'IsPredefined', - 'description' => 'Built-in role'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'IsPredefined', - ], + 'Name' => ['title' => '', 'description' => 'The name of the role.'."\n", 'type' => 'string', 'example' => 'role_name', 'visibility' => 'Public', 'backendName' => 'Name'], + 'Description' => ['title' => '', 'description' => 'The description of the role.'."\n", 'type' => 'string', 'example' => 'role description', 'visibility' => 'Public', 'backendName' => 'Description'], + 'Users' => ['description' => 'The ram user/ram role principal list, in the format of acs:ram::\\[accountId]:user/userName, acs:ram::\\[accountId]:role/roleName'."\n", 'example' => '["acs:ram::111:role/role_name", "acs:ram::111:role/role_name"]', '$ref' => '#/components/schemas/Principals', 'visibility' => 'Public', 'backendName' => 'Users', 'title' => ''], + 'DisplayName' => ['title' => '', 'description' => 'Role display name'."\n", 'type' => 'string', 'example' => '显示名称，允许中文', 'visibility' => 'Public', 'backendName' => 'DisplayName'], + 'PrincipalArn' => ['title' => '', 'description' => 'The principal ARN of the data lake role, in the format of acs:dlf::\\[accountId]:role/\\[roleName]'."\n", 'type' => 'string', 'example' => 'acs:dlf::111:role/role_name', 'visibility' => 'Public', 'backendName' => 'PrincipalArn'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the role was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1647323053', 'visibility' => 'Public', 'backendName' => 'CreateTime'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the role was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1647323053', 'visibility' => 'Public', 'backendName' => 'UpdateTime'], + 'IsPredefined' => ['title' => '', 'description' => 'Built-in role'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'IsPredefined'], ], + 'visibility' => 'Public', + 'example' => '', ], 'RoleInput' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'role input'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'name', - 'description' => 'Data Lake Role Name'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'Name', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the role.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'Description', - ], - 'DisplayName' => [ - 'title' => 'DisplayName', - 'description' => 'Role Display Name'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'DisplayName', - ], + 'Name' => ['title' => '', 'description' => 'Data Lake Role Name'."\n", 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'Name'], + 'Description' => ['title' => '', 'description' => 'The description of the role.'."\n", 'type' => 'string', 'example' => '注释', 'visibility' => 'Public', 'backendName' => 'Description'], + 'DisplayName' => ['title' => '', 'description' => 'Role Display Name'."\n", 'type' => 'string', 'example' => '显示名称，允许中文', 'visibility' => 'Public', 'backendName' => 'DisplayName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Roles' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'A short description of struct'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The role.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Role', - ], + 'items' => ['description' => 'The role.'."\n", '$ref' => '#/components/schemas/Role', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'parseType' => 'struct', 'itemName' => 'Role', + 'example' => '', ], 'SerDeInfo' => [ - 'title' => 'SerDeInfo Object', + 'title' => '', 'description' => 'SerDeInfo'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'Name', - 'description' => 'The name of the data.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'name', - ], - 'Parameters' => [ - 'description' => 'The request parameters. Key-value pair form'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/Parameters', - ], - 'SerializationLib' => [ - 'title' => 'SerializationLib', - 'description' => 'Implementation class of SerDe'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.serde2.OpenCSVSerde', - ], + 'Name' => ['title' => '', 'description' => 'The name of the data.'."\n", 'type' => 'string', 'example' => 'name', 'visibility' => 'Public'], + 'Parameters' => ['description' => 'The request parameters. Key-value pair form'."\n", '$ref' => '#/components/schemas/Parameters', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'SerializationLib' => ['title' => '', 'description' => 'Implementation class of SerDe'."\n", 'type' => 'string', 'example' => 'org.apache.hadoop.hive.serde2.OpenCSVSerde', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'SingleIndicatorDTO' => [ 'title' => '', 'description' => 'Statistical results of indicators'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'DayOnDay' => [ - 'title' => '', - 'description' => 'Compare (Day to Day)'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'double', - 'backendName' => 'DayOnDay', - ], - 'MonthOnMonth' => [ - 'title' => '', - 'description' => 'Compare (Month to Month)'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'double', - 'backendName' => 'MonthOnMonth', - ], - 'DayIncrement' => [ - 'title' => '', - 'description' => 'Daily Add'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'DayIncrement', - ], - 'MonthIncrement' => [ - 'title' => '', - 'description' => 'Month Added'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'MonthIncrement', - ], - 'Total' => [ - 'title' => '', - 'description' => 'Total storage capacity'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Total', - ], + 'DayOnDay' => ['title' => '', 'description' => 'Compare (Day to Day)'."\n", 'type' => 'number', 'format' => 'double', 'visibility' => 'Public', 'backendName' => 'DayOnDay', 'example' => ''], + 'MonthOnMonth' => ['title' => '', 'description' => 'Compare (Month to Month)'."\n", 'type' => 'number', 'format' => 'double', 'visibility' => 'Public', 'backendName' => 'MonthOnMonth', 'example' => ''], + 'DayIncrement' => ['title' => '', 'description' => 'Daily Add'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'DayIncrement', 'example' => ''], + 'MonthIncrement' => ['title' => '', 'description' => 'Month Added'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'MonthIncrement', 'example' => ''], + 'Total' => ['title' => '', 'description' => 'Total storage capacity'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Total', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'SkewedInfo' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'SkewedInfo'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'SkewedColNames' => [ - 'title' => 'SkewedColNames', + 'title' => '', 'description' => 'List of fields that contain skewed values'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The names of the skewed fields.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'col1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The names of the skewed fields.'."\n", 'type' => 'string', 'example' => 'col1', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', + 'example' => '', ], 'SkewedColValueLocationMaps' => [ - 'title' => 'SkewedColValueLocationMaps', + 'title' => '', 'description' => 'Mapping Map of skew values and fields'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Mapping Map of skew values and fields'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '{“col1”:"val1"}', - ], + 'additionalProperties' => ['description' => 'Mapping Map of skew values and fields'."\n", 'type' => 'string', 'example' => '{“col1”:"val1"}', 'visibility' => 'Public', 'title' => ''], + 'visibility' => 'Public', + 'example' => '', ], 'SkewedColValues' => [ - 'title' => 'SkewedColValueLocationMaps', + 'title' => '', 'description' => 'Tilt Value List'."\n", - 'visibility' => 'public', 'type' => 'array', 'items' => [ 'description' => 'The values of the skewed fields.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The values of the skewed fields.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '"123"', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The values of the skewed fields.'."\n", 'type' => 'string', 'example' => '"123"', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'extendType' => 'true', + 'title' => '', + 'example' => '', ], + 'visibility' => 'Public', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'SmallFileCntRank' => [ 'title' => '', 'description' => 'Small File Quantity Ranking'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'TableName' => [ - 'title' => '', - 'description' => 'The name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'delta_partition_1', - 'backendName' => 'TableName', - ], - 'Quantity' => [ - 'title' => '', - 'description' => 'Number of small documents'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52250', - 'backendName' => 'Quantity', - ], - 'DbName' => [ - 'title' => '', - 'description' => 'The library name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'qingwei_repo', - 'backendName' => 'DbName', - ], - 'Location' => [ - 'title' => '', - 'description' => 'Table storage location'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss://qingwei-hz/repo/delta_partition_1', - 'backendName' => 'Location', - ], + 'TableName' => ['title' => '', 'description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'delta_partition_1', 'visibility' => 'Public', 'backendName' => 'TableName'], + 'Quantity' => ['title' => '', 'description' => 'Number of small documents'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '52250', 'visibility' => 'Public', 'backendName' => 'Quantity'], + 'DbName' => ['title' => '', 'description' => 'The library name.'."\n", 'type' => 'string', 'example' => 'qingwei_repo', 'visibility' => 'Public', 'backendName' => 'DbName'], + 'Location' => ['title' => '', 'description' => 'Table storage location'."\n", 'type' => 'string', 'example' => 'oss://qingwei-hz/repo/delta_partition_1', 'visibility' => 'Public', 'backendName' => 'Location'], ], + 'visibility' => 'Public', + 'example' => '', ], 'SortCriterion' => [ 'title' => '', 'description' => 'Search sort structure'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'title' => '', - 'description' => 'The column name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'name', - 'backendName' => 'FieldName', - ], - 'Sort' => [ - 'title' => '', - 'description' => 'The order in which you want to sort the queried instances. Default value desc'."\n" - ."\n" - .'Type: asc: ascending order. desc: reverse order'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'asc/desc', - 'backendName' => 'Sort', - ], + 'FieldName' => ['title' => '', 'description' => 'The column name.'."\n", 'type' => 'string', 'example' => 'name', 'visibility' => 'Public', 'backendName' => 'FieldName'], + 'Sort' => ['title' => '', 'description' => 'The order in which you want to sort the queried instances. Default value desc'."\n" + ."\n" + .'Type: asc: ascending order. desc: reverse order'."\n", 'type' => 'string', 'example' => 'asc/desc', 'visibility' => 'Public', 'backendName' => 'Sort'], ], + 'visibility' => 'Public', + 'example' => '', ], 'StorageCollectTaskOperationResult' => [ 'title' => '', - 'description' => 'Modifies the result of a collection task.'."\n", - 'visibility' => 'public', + 'description' => 'The result of modifying a collection task.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'success', - ], - 'TaskId' => [ - 'title' => '', - 'description' => 'The task ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'taskId', - ], - 'TaskType' => [ - 'title' => '', - 'description' => 'The job type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'taskType', - ], - 'DlfCreated' => [ - 'title' => '', - 'description' => 'Whether the DLF is automatically created.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'backendName' => 'dlfCreated', - ], - 'ErrCode' => [ - 'title' => '', - 'description' => 'The error code returned if the call failed.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'errCode', - ], - 'ErrMessage' => [ - 'title' => '', - 'description' => 'The error message.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'errMessage', - ], - ], + 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'success'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'taskId'], + 'TaskType' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'taskType'], + 'DlfCreated' => ['title' => '', 'description' => 'Indicates whether DLF automatically created the associated metadata.', 'type' => 'boolean', 'example' => '', 'visibility' => 'Public', 'backendName' => 'dlfCreated'], + 'ErrCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'errCode'], + 'ErrMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'errMessage'], + ], + 'example' => '', + 'visibility' => 'Public', ], 'StorageDescriptor' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'StorageDescriptor'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'BucketCols' => [ - 'description' => 'The array of bucket fields.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/ListString', - ], + 'BucketCols' => ['description' => 'The array of bucket fields.'."\n", '$ref' => '#/components/schemas/ListString', 'visibility' => 'Public', 'title' => '', 'example' => ''], 'Cols' => [ - 'title' => 'Cols', + 'title' => '', 'description' => 'All the fields in a table.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The definitions of table fields.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldSchema', - ], - ], - 'Compressed' => [ - 'title' => 'Compressed', - 'description' => 'Specifies whether to enable compression.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'InputFormat' => [ - 'title' => 'InputFormat', - 'description' => 'The input format. For more information, see the API description of CreateTable.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat', - ], - 'Location' => [ - 'title' => 'Location', - 'description' => 'The physical location of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'file:///tmp/table', - ], - 'NumBuckets' => [ - 'title' => 'NumBuckets', - 'description' => 'The number of buckets to be split. This field is required if BucketCols is set.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'OutputFormat' => [ - 'title' => 'OutputFormat', - 'description' => 'The output format. For more information, see the API description of CreateTable.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat', + 'items' => ['description' => 'The definitions of table fields.'."\n", '$ref' => '#/components/schemas/FieldSchema', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', + 'example' => '', ], + 'Compressed' => ['title' => '', 'description' => 'Specifies whether to enable compression.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'InputFormat' => ['title' => '', 'description' => 'The input format. For more information, see the API description of CreateTable.'."\n", 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat', 'visibility' => 'Public'], + 'Location' => ['title' => '', 'description' => 'The physical location of the table.'."\n", 'type' => 'string', 'example' => 'file:///tmp/table', 'visibility' => 'Public'], + 'NumBuckets' => ['title' => '', 'description' => 'The number of buckets to be split. This field is required if BucketCols is set.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'visibility' => 'Public'], + 'OutputFormat' => ['title' => '', 'description' => 'The output format. For more information, see the API description of CreateTable.'."\n", 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat', 'visibility' => 'Public'], 'Parameters' => [ - 'title' => 'Parameters', + 'title' => '', 'description' => 'The mapping array of KVPs.'."\n", - 'visibility' => 'public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Key-value pair'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'key', - ], - ], - 'SerDeInfo' => [ - 'description' => 'The information about serialization and deserialization.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/SerDeInfo', - ], - 'SkewedInfo' => [ - 'description' => 'The duplicate values or skewed values in a field.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/SkewedInfo', + 'additionalProperties' => ['description' => 'Key-value pair'."\n", 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'title' => ''], + 'visibility' => 'Public', + 'example' => '', ], + 'SerDeInfo' => ['description' => 'The information about serialization and deserialization.'."\n", '$ref' => '#/components/schemas/SerDeInfo', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'SkewedInfo' => ['description' => 'The duplicate values or skewed values in a field.'."\n", '$ref' => '#/components/schemas/SkewedInfo', 'visibility' => 'Public', 'title' => '', 'example' => ''], 'SortCols' => [ - 'title' => 'SortCols', + 'title' => '', 'description' => 'The sort fields.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The field based on which the categories are sorted.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Order', - ], - ], - 'StoredAsSubDirectories' => [ - 'title' => 'StoredAsSubDirectories', - 'description' => 'Specifies whether table data is stored in a subdirectory.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', + 'items' => ['description' => 'The field based on which the categories are sorted.'."\n", '$ref' => '#/components/schemas/Order', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', + 'example' => '', ], + 'StoredAsSubDirectories' => ['title' => '', 'description' => 'Specifies whether table data is stored in a subdirectory.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'StorageFormat' => [ 'title' => '', 'description' => 'Storage format distribution information'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Parquet' => [ - 'title' => 'Parquet', - 'description' => 'Number of Parquet format files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Parquet', - ], - 'Orc' => [ - 'title' => 'Orc', - 'description' => 'Number of Orc format files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Orc', - ], - 'Delta' => [ - 'title' => 'Delta', - 'description' => 'Number of Delta format files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Delta', - ], - 'Csv' => [ - 'title' => 'Csv', - 'description' => 'Number of files in Csv format'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Csv', - ], - 'Iceberg' => [ - 'title' => 'Iceberg', - 'description' => 'Number of Iceberg format files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Iceberg', - ], - 'Uncategorized' => [ - 'title' => 'Uncategorized', - 'description' => 'Format Unclassified File Quantity'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Uncategorized', - ], - 'Json' => [ - 'title' => 'Json', - 'description' => 'Number of JSON format files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Json', - ], - 'Avro' => [ - 'title' => 'Avro', - 'description' => 'Number of Avro format files'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Avro', - ], - 'Hudi' => [ - 'title' => 'Hudi', - 'description' => 'Number of files in Hudi format'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'Hudi', - ], + 'Parquet' => ['title' => '', 'description' => 'Number of Parquet format files'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Parquet', 'example' => ''], + 'Orc' => ['title' => '', 'description' => 'Number of Orc format files'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Orc', 'example' => ''], + 'Delta' => ['title' => '', 'description' => 'Number of Delta format files'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Delta', 'example' => ''], + 'Csv' => ['title' => '', 'description' => 'Number of files in Csv format'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Csv', 'example' => ''], + 'Iceberg' => ['title' => '', 'description' => 'Number of Iceberg format files'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Iceberg', 'example' => ''], + 'Uncategorized' => ['title' => '', 'description' => 'Format Unclassified File Quantity'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Uncategorized', 'example' => ''], + 'Json' => ['title' => '', 'description' => 'Number of JSON format files'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Json', 'example' => ''], + 'Avro' => ['title' => '', 'description' => 'Number of Avro format files'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Avro', 'example' => ''], + 'Hudi' => ['title' => '', 'description' => 'Number of files in Hudi format'."\n", 'type' => 'integer', 'format' => 'int64', 'visibility' => 'Public', 'backendName' => 'Hudi', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'StorageLayer' => [ 'title' => '', 'description' => 'Storage Tiering Distribution Information'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Archive' => [ - 'title' => '', - 'description' => 'Archive File Size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'Archive', - ], - 'ColdArchive' => [ - 'title' => '', - 'description' => 'Size of a Cold Archive file'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'ColdArchive', - ], - 'Standard' => [ - 'title' => '', - 'description' => 'Standard file size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'Standard', - ], - 'Infrequent' => [ - 'title' => '', - 'description' => 'Low-frequency file size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1,099,511', - 'backendName' => 'Infrequent', - ], - 'Unknown' => [ - 'title' => '', - 'description' => 'The file status.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'Unknown', - ], + 'Archive' => ['title' => '', 'description' => 'Archive File Size'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'Archive'], + 'ColdArchive' => ['title' => '', 'description' => 'Size of a Cold Archive file'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'ColdArchive'], + 'Standard' => ['title' => '', 'description' => 'Standard file size'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'Standard'], + 'Infrequent' => ['title' => '', 'description' => 'Low-frequency file size'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1,099,511', 'visibility' => 'Public', 'backendName' => 'Infrequent'], + 'Unknown' => ['title' => '', 'description' => 'The file status.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'Unknown'], ], + 'visibility' => 'Public', + 'example' => '', ], 'StorageRankDTO' => [ 'title' => '', 'description' => 'Storage ranking'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'dbStorageRank' => [ 'title' => '', 'description' => 'Library storage ranking list'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Library storage ranking'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/DbStorageRank', - ], + 'items' => ['description' => 'Library storage ranking'."\n", '$ref' => '#/components/schemas/DbStorageRank', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], 'required' => false, + 'visibility' => 'Public', 'backendName' => 'dbStorageRank', + 'example' => '', ], 'tableStorageRank' => [ 'title' => '', 'description' => 'Table storage ranking list'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Table Storage Ranking'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TableStorageRank', - ], + 'items' => ['description' => 'Table Storage Ranking'."\n", '$ref' => '#/components/schemas/TableStorageRank', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'tableStorageRank', + 'example' => '', ], 'smallFileCntRank' => [ 'title' => '', 'description' => 'Small file quantity ranking list'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'Small File Quantity Ranking'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/SmallFileCntRank', - ], + 'items' => ['description' => 'Small File Quantity Ranking'."\n", '$ref' => '#/components/schemas/SmallFileCntRank', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'smallFileCntRank', + 'example' => '', ], ], 'required' => false, + 'visibility' => 'Public', 'parseType' => 'struct', + 'example' => '', + ], + 'StrogeCollectTask' => [ + 'title' => '采集任务', + 'description' => '采集任务', + 'type' => 'object', + 'properties' => [ + 'GmtModified' => ['title' => '修改时间', 'type' => 'string'], + 'GmtCreate' => ['title' => '创建时间', 'type' => 'string'], + 'Id' => ['title' => '任务Id', 'type' => 'string'], + 'Location' => ['title' => 'OSS路径', 'type' => 'string'], + 'DestinationBucketName' => ['title' => '目标Bucket', 'type' => 'string'], + 'DestinationPrefix' => ['title' => '目标Prefix', 'type' => 'string'], + 'Status' => ['title' => '任务状态', 'type' => 'string'], + 'DlfCreated' => ['title' => '是否DLF自动创建', 'type' => 'boolean'], + 'TaskType' => ['title' => '任务类型', 'type' => 'string'], + 'InventoryId' => ['title' => '清单Id', 'type' => 'string'], + ], ], 'Table' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Table'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Cascade' => [ - 'title' => 'Cascade', - 'description' => 'Specifies whether to perform cascade deletion.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'Cascade', - ], - 'CreateTime' => [ - 'title' => 'CreateTime', - 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'CreateTime', - ], - 'CreatedBy' => [ - 'title' => 'CreatedBy', - 'description' => 'The name of the user who created the version.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'CreatedBy', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'DatabaseName', - ], - 'LastAccessTime' => [ - 'title' => 'LastAccessTime', - 'description' => 'The timestamp of the last access to this table.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'LastAccessTime', - ], - 'LastAnalyzedTime' => [ - 'title' => 'LastAnalyzedTime', - 'description' => 'The time when the last statistical operation was performed on columns. The value is in the UNIX timestamp format. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'LastAnalyzedTime', - ], - 'Owner' => [ - 'title' => 'Owner', - 'description' => 'The name of the owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'Owner', - ], - 'OwnerType' => [ - 'title' => 'OwnerType', - 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'OwnerType', - ], - 'Parameters' => [ - 'description' => 'The KVPs that define the attributes related to the table.'."\n", - 'visibility' => 'public', - 'backendName' => 'Parameters', - '$ref' => '#/components/schemas/Parameters', - ], - 'PartitionKeys' => [ - 'description' => 'List of partition table'."\n", - 'visibility' => 'public', - 'backendName' => 'PartitionKeys', - '$ref' => '#/components/schemas/ListFieldSchema', - ], - 'Privileges' => [ - 'description' => 'Permission Settings'."\n", - 'visibility' => 'public', - 'backendName' => 'Privileges', - '$ref' => '#/components/schemas/PrincipalPrivilegeSet', - ], - 'Retention' => [ - 'title' => 'Retention', - 'description' => 'The retention time of the table.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30000', - 'backendName' => 'Retention', - ], - 'RewriteEnabled' => [ - 'title' => 'RewriteEnabled', - 'description' => 'Whether the view can be used by overridden queries'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'RewriteEnabled', - ], - 'Sd' => [ - 'description' => 'The descriptor of the storage, which contains physical storage information about this table.'."\n", - 'visibility' => 'public', - 'backendName' => 'Sd', - '$ref' => '#/components/schemas/StorageDescriptor', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'table_name', - 'backendName' => 'TableName', - ], - 'TableType' => [ - 'title' => 'TableType', - 'description' => 'The type of the metadata table. Example: MANAGED_TABLE,EXTERNAL_TABLE,VIRTUAL_VIEW,INDEX_TABLE,MATERIALIZED_VIEW.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'MANAGED_TABLE', - 'backendName' => 'TableType', - ], - 'Temporary' => [ - 'title' => 'Temporary', - 'description' => 'Specifies whether the table is a temporary table.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'Temporary', - ], - 'UpdateTime' => [ - 'title' => 'UpdateTime', - 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'UpdateTime', - ], - 'ViewExpandedText' => [ - 'title' => 'ViewExpandedText', - 'description' => 'The expanded text of the view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '\'\'', - 'backendName' => 'ViewExpandedText', - ], - 'ViewOriginalText' => [ - 'title' => 'ViewOriginalText', - 'description' => 'The original text of the view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '\'\'', - 'backendName' => 'ViewOriginalText', - ], - 'TableId' => [ - 'title' => 'TableId', - 'description' => 'TableId'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '59c6c8fefeaa46d8b599c1f790c59a19', - 'backendName' => 'TableId', - ], - 'TableVersion' => [ - 'title' => 'TableVersion', - 'description' => 'TableVersion'."\n", - 'visibility' => 'public', - 'backendName' => 'TableVersion', - '$ref' => '#/components/schemas/TableVersion', - ], + 'Cascade' => ['title' => '', 'description' => 'Specifies whether to perform cascade deletion.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Cascade'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'visibility' => 'Public', 'backendName' => 'CreateTime'], + 'CreatedBy' => ['title' => '', 'description' => 'The name of the user who created the version.'."\n", 'type' => 'string', 'example' => 'zhangsan', 'visibility' => 'Public', 'backendName' => 'CreatedBy'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'LastAccessTime' => ['title' => '', 'description' => 'The timestamp of the last access to this table.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'visibility' => 'Public', 'backendName' => 'LastAccessTime'], + 'LastAnalyzedTime' => ['title' => '', 'description' => 'The time when the last statistical operation was performed on columns. The value is in the UNIX timestamp format. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'visibility' => 'Public', 'backendName' => 'LastAnalyzedTime'], + 'Owner' => ['title' => '', 'description' => 'The name of the owner.'."\n", 'type' => 'string', 'example' => 'zhangsan', 'visibility' => 'Public', 'backendName' => 'Owner'], + 'OwnerType' => ['title' => '', 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", 'type' => 'string', 'example' => 'USER', 'visibility' => 'Public', 'backendName' => 'OwnerType'], + 'Parameters' => ['description' => 'The KVPs that define the attributes related to the table.'."\n", '$ref' => '#/components/schemas/Parameters', 'visibility' => 'Public', 'backendName' => 'Parameters', 'title' => '', 'example' => ''], + 'PartitionKeys' => ['description' => 'List of partition table'."\n", '$ref' => '#/components/schemas/ListFieldSchema', 'visibility' => 'Public', 'backendName' => 'PartitionKeys', 'title' => '', 'example' => ''], + 'Privileges' => ['description' => 'Permission Settings'."\n", '$ref' => '#/components/schemas/PrincipalPrivilegeSet', 'visibility' => 'Public', 'backendName' => 'Privileges', 'title' => '', 'example' => ''], + 'Retention' => ['title' => '', 'description' => 'The retention time of the table.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30000', 'visibility' => 'Public', 'backendName' => 'Retention'], + 'RewriteEnabled' => ['title' => '', 'description' => 'Whether the view can be used by overridden queries'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'RewriteEnabled'], + 'Sd' => ['description' => 'The descriptor of the storage, which contains physical storage information about this table.'."\n", '$ref' => '#/components/schemas/StorageDescriptor', 'visibility' => 'Public', 'backendName' => 'Sd', 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'table_name', 'visibility' => 'Public', 'backendName' => 'TableName'], + 'TableType' => ['title' => '', 'description' => 'The type of the metadata table. Example: MANAGED_TABLE,EXTERNAL_TABLE,VIRTUAL_VIEW,INDEX_TABLE,MATERIALIZED_VIEW.'."\n", 'type' => 'string', 'example' => 'MANAGED_TABLE', 'visibility' => 'Public', 'backendName' => 'TableType'], + 'Temporary' => ['title' => '', 'description' => 'Specifies whether the table is a temporary table.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Temporary'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'visibility' => 'Public', 'backendName' => 'UpdateTime'], + 'ViewExpandedText' => ['title' => '', 'description' => 'The expanded text of the view.'."\n", 'type' => 'string', 'example' => '\'\'', 'visibility' => 'Public', 'backendName' => 'ViewExpandedText'], + 'ViewOriginalText' => ['title' => '', 'description' => 'The original text of the view.'."\n", 'type' => 'string', 'example' => '\'\'', 'visibility' => 'Public', 'backendName' => 'ViewOriginalText'], + 'TableId' => ['title' => '', 'description' => 'TableId'."\n", 'type' => 'string', 'example' => '59c6c8fefeaa46d8b599c1f790c59a19', 'visibility' => 'Public', 'backendName' => 'TableId'], + 'TableVersion' => ['title' => '', 'description' => 'TableVersion'."\n", '$ref' => '#/components/schemas/TableVersion', 'visibility' => 'Public', 'backendName' => 'TableVersion', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'TableError' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'TableError'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'ErrorDetail' => [ - 'description' => 'The information about the error.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/ErrorDetail', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the table in which the error occurs.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test', - ], + 'ErrorDetail' => ['description' => 'The information about the error.'."\n", '$ref' => '#/components/schemas/ErrorDetail', 'visibility' => 'Public', 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the table in which the error occurs.'."\n", 'type' => 'string', 'example' => 'test', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], - 'TableInput' => [ + 'TableExtended' => [ 'title' => 'A short description of struct', - 'description' => 'Table'."\n", - 'visibility' => 'public', + 'description' => 'TableExtended', 'type' => 'object', 'properties' => [ - 'Cascade' => [ - 'title' => 'Cascade', - 'description' => 'Specifies whether to perform cascade deletion.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'Cascade', - ], - 'CreatedBy' => [ - 'title' => 'CreatedBy', - 'description' => 'The name of the user who created the version.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'CreatedBy', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'DatabaseName', - ], - 'LastAccessTime' => [ - 'title' => 'LastAccessTime', - 'description' => 'The timestamp of the last access to this table.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'LastAccessTime', - ], - 'LastAnalyzedTime' => [ - 'title' => 'LastAnalyzedTime', - 'description' => 'The time when the last statistical operation was performed on columns. The value is in the UNIX timestamp format. Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1608707407', - 'backendName' => 'LastAnalyzedTime', - ], - 'Owner' => [ - 'title' => 'Owner', - 'description' => 'The name of the owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'zhangsan', - 'backendName' => 'Owner', - ], - 'OwnerType' => [ - 'title' => 'OwnerType', - 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'OwnerType', - ], - 'Parameters' => [ - 'description' => 'The KVPs that define the attributes related to the table.'."\n", - 'visibility' => 'public', - 'backendName' => 'Parameters', - '$ref' => '#/components/schemas/Parameters', - ], - 'PartitionKeys' => [ - 'description' => 'List of partition table. Only the partition keys of the basic types are supported. If no partitionKeys is specified, you need to set the value of partitionKeys to an empty list.'."\n", - 'visibility' => 'public', - 'backendName' => 'PartitionKeys', - '$ref' => '#/components/schemas/ListFieldSchema', - ], + 'Cascade' => ['title' => 'Cascade', 'type' => 'boolean'], + 'CreateTime' => ['title' => 'CreateTime', 'type' => 'integer', 'format' => 'int32'], + 'CreatedBy' => ['title' => 'CreatedBy', 'type' => 'string'], + 'DatabaseName' => ['title' => 'DatabaseName', 'type' => 'string'], + 'LastAccessTime' => ['title' => 'LastAccessTime', 'type' => 'integer', 'format' => 'int32'], + 'LastAnalyzedTime' => ['title' => 'LastAnalyzedTime', 'type' => 'integer', 'format' => 'int32'], + 'Owner' => ['title' => 'Owner', 'type' => 'string'], + 'OwnerType' => ['title' => 'OwnerType', 'type' => 'string'], + 'Parameters' => ['$ref' => '#/components/schemas/Parameters'], + 'PartitionKeys' => ['$ref' => '#/components/schemas/ListFieldSchema'], 'Privileges' => [ - 'description' => 'The configurations of permissions. This parameter can be left empty.'."\n", - 'visibility' => 'public', - 'backendName' => 'Privileges', - '$ref' => '#/components/schemas/PrincipalPrivilegeSet', - ], - 'Retention' => [ - 'title' => 'Retention', - 'description' => 'The retention time of the table.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30000', - 'backendName' => 'Retention', - ], - 'RewriteEnabled' => [ - 'title' => 'RewriteEnabled', - 'description' => 'Whether the view can be used by overridden queries'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'RewriteEnabled', + 'title' => 'privileges', + 'type' => 'object', + 'properties' => [ + 'groupPrivileges' => [ + 'title' => 'groupPrivileges', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['title' => 'CreateTime', 'type' => 'integer', 'format' => 'int32'], + 'GrantOption' => ['title' => 'GrantOption', 'type' => 'boolean'], + 'Grantor' => ['title' => 'Grantor', 'type' => 'string'], + 'GrantorType' => ['title' => 'GrantorType', 'type' => 'string'], + 'Privilege' => ['title' => 'Privilege', 'type' => 'string'], + ], + ], + ], + ], + 'RolePrivileges' => [ + 'title' => 'rolePrivileges', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['title' => 'CreateTime', 'type' => 'integer', 'format' => 'int32'], + 'GrantOption' => ['title' => 'GrantOption', 'type' => 'boolean'], + 'Grantor' => ['title' => 'Grantor', 'type' => 'string'], + 'GrantorType' => ['title' => 'GrantorType', 'type' => 'string'], + 'Privilege' => ['title' => 'Privilege', 'type' => 'string'], + ], + ], + ], + ], + 'UserPrivileges' => [ + 'title' => 'userPrivileges', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['title' => 'CreateTime', 'type' => 'integer', 'format' => 'int32'], + 'GrantOption' => ['title' => 'GrantOption', 'type' => 'boolean'], + 'Grantor' => ['title' => 'Grantor', 'type' => 'string'], + 'GrantorType' => ['title' => 'GrantorType', 'type' => 'string'], + 'Privilege' => ['title' => 'Privilege', 'type' => 'string'], + ], + ], + ], + ], + ], ], + 'Retention' => ['title' => 'Retention', 'type' => 'integer', 'format' => 'int32'], + 'RewriteEnabled' => ['title' => 'RewriteEnabled', 'type' => 'boolean'], 'Sd' => [ - 'description' => 'The descriptor of the storage, which contains physical storage information about this table.'."\n", - 'visibility' => 'public', - 'backendName' => 'Sd', - '$ref' => '#/components/schemas/StorageDescriptor', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'table_name', - 'backendName' => 'TableName', - ], - 'TableType' => [ - 'title' => 'TableType', - 'description' => 'The type of the metadata table. Example: MANAGED_TABLE,EXTERNAL_TABLE,VIRTUAL_VIEW,INDEX_TABLE,MATERIALIZED_VIEW.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'MANAGED_TABLE', - 'backendName' => 'TableType', - ], - 'Temporary' => [ - 'title' => 'Temporary', - 'description' => 'Specifies whether the table is a temporary table.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'Temporary', - ], - 'ViewExpandedText' => [ - 'title' => 'ViewExpandedText', - 'description' => 'The expanded text of the view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '\'\'', - 'backendName' => 'ViewExpandedText', - ], - 'ViewOriginalText' => [ - 'title' => 'ViewOriginalText', - 'description' => 'The original text of the view.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '\'\'', - 'backendName' => 'ViewOriginalText', - ], - 'CreateTime' => [ - 'title' => 'CreateTime', - 'description' => 'The time when the rule was created.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1645437703000', - 'backendName' => 'CreateTime', + 'title' => 'sd', + 'type' => 'object', + 'properties' => [ + 'BucketCols' => [ + 'title' => 'bucketCols', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'Cols' => [ + 'title' => 'Cols', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/FieldSchema'], + ], + 'Compressed' => ['title' => 'Compressed', 'type' => 'boolean'], + 'InputFormat' => ['title' => 'InputFormat', 'type' => 'string'], + 'Location' => ['title' => 'Location', 'type' => 'string'], + 'NumBuckets' => ['title' => 'NumBuckets', 'type' => 'integer', 'format' => 'int32'], + 'OutputFormat' => ['title' => 'OutputFormat', 'type' => 'string'], + 'Parameters' => [ + 'title' => 'Parameters', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'SerDeInfo' => [ + 'title' => 'SerDeInfo', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Name', 'type' => 'string'], + 'Parameters' => [ + 'title' => 'Parameters', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'SerializationLib' => ['title' => 'SerializationLib', 'type' => 'string'], + ], + ], + 'SkewedInfo' => [ + 'title' => 'SkewedInfo', + 'type' => 'object', + 'properties' => [ + 'SkewedColNames' => [ + 'title' => 'SkewedColNames', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'SkewedColValueLocationMaps' => [ + 'title' => 'SkewedColValueLocationMaps', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'SkewedColValues' => [ + 'title' => 'SkewedColValues', + 'type' => 'array', + 'items' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + 'SortCols' => [ + 'title' => 'SortCols', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Order'], + ], + 'StoredAsSubDirectories' => ['title' => 'StoredAsSubDirectories', 'type' => 'boolean'], + ], ], + 'TableName' => ['title' => 'TableName', 'type' => 'string'], + 'TableType' => ['title' => 'TableType', 'type' => 'string'], + 'Temporary' => ['title' => 'Temporary', 'type' => 'boolean'], + 'UpdateTime' => ['title' => 'UpdateTime', 'type' => 'integer', 'format' => 'int32'], + 'ViewExpandedText' => ['title' => 'ViewExpandedText', 'type' => 'string'], + 'ViewOriginalText' => ['title' => 'ViewOriginalText', 'type' => 'string'], + 'TableFormat' => ['title' => 'TableFormat', 'type' => 'string'], ], ], - 'TableProfile' => [ - 'title' => 'A short description of struct', - 'description' => 'Table Data Overview'."\n", - 'visibility' => 'public', + 'TableInput' => [ + 'title' => '', + 'description' => 'Table'."\n", 'type' => 'object', 'properties' => [ - 'PartitionCnt' => [ - 'title' => '', - 'description' => 'Number of Partitions'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'partitionCnt', - ], - 'FileCnt' => [ - 'title' => '', - 'description' => 'Number of local files to synchronize'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'backendName' => 'fileCnt', - ], - 'ObjectCnt' => [ - 'title' => '', - 'description' => 'Number of files (from oss or oss-hdfs list)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'backendName' => 'objectCnt', - ], - 'FileSize' => [ - 'title' => '', - 'description' => 'File-related parameters'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '192841', - 'backendName' => 'fileSize', - ], - 'ObjectSize' => [ - 'title' => '', - 'description' => 'file size (from oss or oss-hdfs manifest)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '31', - 'backendName' => 'objectSize', - ], - 'RecordCnt' => [ - 'title' => '', - 'description' => 'Records'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'recordCnt', - ], - 'IsPartitioned' => [ - 'title' => '', - 'description' => 'Whether partition table'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'isPartitioned', - ], - 'LastModifyTime' => [ - 'title' => '', - 'description' => 'The time when the configurations of the domain name were updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-02-01 19:33:00', - 'backendName' => 'lastModifiedTime', - ], - 'LastAccessTime' => [ - 'title' => '', - 'description' => 'Lifecycle rules based on the last access time'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-02-02 19:00:00', - 'backendName' => 'lastAccessTime', - ], - 'DatabaseName' => [ - 'title' => '', - 'description' => 'The library name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '530_db', - 'backendName' => 'databaseName', - ], - 'TableName' => [ - 'title' => '', - 'description' => 'The name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_table_20201223', - 'backendName' => 'tableName', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time when the data address was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-02-01 19:29:12', - 'backendName' => 'createTime', - ], - 'Location' => [ - 'title' => '', - 'description' => 'The location where the sample is stored.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'oss://opg211-prod-ds-lake/datalake/tvapp_push_content/_delta_log/00000000000000000005.json', - 'backendName' => 'location', - ], - 'AccessNum' => [ - 'title' => '', - 'description' => 'Visits of the Day (Deprecated)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - 'backendName' => 'accessNum', - ], - 'AccessNumWeekly' => [ - 'title' => '', - 'description' => 'Visits per week (obsolete)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'backendName' => 'accessNumWeekly', - ], - 'AccessNumMonthly' => [ - 'title' => '', - 'description' => 'Number of visits in the current month (obsolete)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'backendName' => 'accessNumMonthly', - ], - 'LastAccessNumTime' => [ - 'title' => '', - 'description' => 'Last Access Time (Discarded)'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'lastAccessNumTime', - ], - 'LatestDate' => [ - 'title' => '', - 'description' => 'The time when the metadata warehouse was updated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-03-13', - 'backendName' => 'latestDate', - ], - 'LatestAccessNumDate' => [ - 'title' => '', - 'description' => 'The time when the access frequency is updated. This parameter is obsolete.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'latestAccessNumDate', - ], - 'LastDdlTime' => [ - 'title' => '', - 'description' => 'Last DDL update time'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2023-08-16 18:02:24', - 'backendName' => 'lastDdlTime', - ], - 'ObjectAccessNum' => [ - 'title' => '', - 'description' => 'Number of file accesses in the last day (from oss-hdfs audit logs)'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'objectAccessNum', - ], - 'ObjectAccessNumWeekly' => [ - 'title' => '', - 'description' => 'Number of file accesses in the last seven days (from oss-hdfs audit logs)'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - 'backendName' => 'objectAccessNumWeekly', - ], - 'ObjectAccessNumMonthly' => [ - 'title' => '', - 'description' => 'Number of file accesses in the last 30 days (from oss-hdfs audit logs)'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - 'backendName' => 'objectAccessNumMonthly', - ], - 'DataSourceType' => [ - 'title' => '', - 'description' => 'The type of the source from which storage is collected.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OSS_HDFS', - 'backendName' => 'dataSourceType', - ], + 'Cascade' => ['title' => '', 'description' => 'Specifies whether to perform cascade deletion.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Cascade'], + 'CreatedBy' => ['title' => '', 'description' => 'The name of the user who created the version.'."\n", 'type' => 'string', 'example' => 'zhangsan', 'visibility' => 'Public', 'backendName' => 'CreatedBy'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'LastAccessTime' => ['title' => '', 'description' => 'The timestamp of the last access to this table.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'visibility' => 'Public', 'backendName' => 'LastAccessTime'], + 'LastAnalyzedTime' => ['title' => '', 'description' => 'The time when the last statistical operation was performed on columns. The value is in the UNIX timestamp format. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'visibility' => 'Public', 'backendName' => 'LastAnalyzedTime'], + 'Owner' => ['title' => '', 'description' => 'The name of the owner.'."\n", 'type' => 'string', 'example' => 'zhangsan', 'visibility' => 'Public', 'backendName' => 'Owner'], + 'OwnerType' => ['title' => '', 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n", 'type' => 'string', 'example' => 'USER', 'visibility' => 'Public', 'backendName' => 'OwnerType'], + 'Parameters' => ['description' => 'The KVPs that define the attributes related to the table.'."\n", '$ref' => '#/components/schemas/Parameters', 'visibility' => 'Public', 'backendName' => 'Parameters', 'title' => '', 'example' => ''], + 'PartitionKeys' => ['description' => 'List of partition table. Only the partition keys of the basic types are supported. If no partitionKeys is specified, you need to set the value of partitionKeys to an empty list.'."\n", '$ref' => '#/components/schemas/ListFieldSchema', 'visibility' => 'Public', 'backendName' => 'PartitionKeys', 'title' => '', 'example' => ''], + 'Privileges' => ['description' => 'The configurations of permissions. This parameter can be left empty.'."\n", '$ref' => '#/components/schemas/PrincipalPrivilegeSet', 'visibility' => 'Public', 'backendName' => 'Privileges', 'title' => '', 'example' => ''], + 'Retention' => ['title' => '', 'description' => 'The retention time of the table.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30000', 'visibility' => 'Public', 'backendName' => 'Retention'], + 'RewriteEnabled' => ['title' => '', 'description' => 'Whether the view can be used by overridden queries'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'RewriteEnabled'], + 'Sd' => ['description' => 'The descriptor of the storage, which contains physical storage information about this table.'."\n", '$ref' => '#/components/schemas/StorageDescriptor', 'visibility' => 'Public', 'backendName' => 'Sd', 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'table_name', 'visibility' => 'Public', 'backendName' => 'TableName'], + 'TableType' => ['title' => '', 'description' => 'The type of the metadata table. Example: MANAGED_TABLE,EXTERNAL_TABLE,VIRTUAL_VIEW,INDEX_TABLE,MATERIALIZED_VIEW.'."\n", 'type' => 'string', 'example' => 'MANAGED_TABLE', 'visibility' => 'Public', 'backendName' => 'TableType'], + 'Temporary' => ['title' => '', 'description' => 'Specifies whether the table is a temporary table.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'Temporary'], + 'ViewExpandedText' => ['title' => '', 'description' => 'The expanded text of the view.'."\n", 'type' => 'string', 'example' => '\'\'', 'visibility' => 'Public', 'backendName' => 'ViewExpandedText'], + 'ViewOriginalText' => ['title' => '', 'description' => 'The original text of the view.'."\n", 'type' => 'string', 'example' => '\'\'', 'visibility' => 'Public', 'backendName' => 'ViewOriginalText'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the rule was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1645437703000', 'visibility' => 'Public', 'backendName' => 'CreateTime'], ], + 'visibility' => 'Public', + 'example' => '', + ], + 'TableProfile' => [ + 'title' => '', + 'description' => 'The data profile of the table.', + 'type' => 'object', + 'properties' => [ + 'PartitionCnt' => ['title' => '', 'description' => 'The partition count.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'visibility' => 'Public', 'backendName' => 'partitionCnt'], + 'FileCnt' => ['title' => '', 'description' => 'The file count.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'visibility' => 'Public', 'backendName' => 'fileCnt'], + 'ObjectCnt' => ['title' => '', 'description' => 'The object count, obtained from an OSS or OSS-HDFS inventory.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'visibility' => 'Public', 'backendName' => 'objectCnt'], + 'FileSize' => ['title' => '', 'description' => 'The file size.', 'type' => 'integer', 'format' => 'int64', 'example' => '31', 'visibility' => 'Public', 'backendName' => 'fileSize'], + 'ObjectSize' => ['title' => '', 'description' => 'The object size, obtained from an OSS or OSS-HDFS inventory.', 'type' => 'integer', 'format' => 'int64', 'example' => '31', 'visibility' => 'Public', 'backendName' => 'objectSize'], + 'RecordCnt' => ['title' => '', 'description' => 'The record count.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'recordCnt'], + 'IsPartitioned' => ['title' => '', 'description' => 'Indicates whether the table is partitioned.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'isPartitioned'], + 'LastModifyTime' => ['title' => '', 'description' => 'The last modified time.', 'type' => 'string', 'example' => '2023-08-16 18:02:25', 'visibility' => 'Public', 'backendName' => 'lastModifiedTime'], + 'LastAccessTime' => ['title' => '', 'description' => 'The last access time.', 'type' => 'string', 'example' => '2023-08-22 12:14:42', 'visibility' => 'Public', 'backendName' => 'lastAccessTime'], + 'DatabaseName' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'example' => 'test_db', 'visibility' => 'Public', 'backendName' => 'databaseName'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'test_tbl', 'visibility' => 'Public', 'backendName' => 'tableName'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2023-08-14 10:44:13', 'visibility' => 'Public', 'backendName' => 'createTime'], + 'Location' => ['title' => '', 'description' => 'The storage location.', 'type' => 'string', 'example' => 'oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/', 'visibility' => 'Public', 'backendName' => 'location'], + 'AccessNum' => ['title' => '', 'description' => 'The number of daily accesses. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'accessNum'], + 'AccessNumWeekly' => ['title' => '', 'description' => 'The number of accesses in the last 7 days. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'accessNumWeekly'], + 'AccessNumMonthly' => ['title' => '', 'description' => 'The number of accesses in the last 30 days. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'accessNumMonthly'], + 'LastAccessNumTime' => ['title' => '', 'description' => 'The last access time. This parameter is deprecated.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'lastAccessNumTime'], + 'LatestDate' => ['title' => '', 'description' => 'The metastore update time.', 'type' => 'string', 'example' => '2023-08-30 19:16:10', 'visibility' => 'Public', 'backendName' => 'latestDate'], + 'LatestAccessNumDate' => ['title' => '', 'description' => 'The time of the last access frequency update. This parameter is deprecated.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestAccessNumDate'], + 'LastDdlTime' => ['title' => '', 'description' => 'The last DDL update time.', 'type' => 'string', 'example' => '2023-08-16 18:02:24', 'visibility' => 'Public', 'backendName' => 'lastDdlTime'], + 'ObjectAccessNum' => ['title' => '', 'description' => 'The number of object accesses in the last day, obtained from the OSS-HDFS audit log.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'objectAccessNum'], + 'ObjectAccessNumWeekly' => ['title' => '', 'description' => 'The number of object accesses in the last 7 days, obtained from the OSS-HDFS audit log.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'visibility' => 'Public', 'backendName' => 'objectAccessNumWeekly'], + 'ObjectAccessNumMonthly' => ['title' => '', 'description' => 'The number of object accesses in the last 30 days, obtained from the OSS-HDFS audit log.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'visibility' => 'Public', 'backendName' => 'objectAccessNumMonthly'], + 'DataSourceType' => ['title' => '', 'description' => 'The type of data source that provides the storage metrics.', 'type' => 'string', 'example' => 'OSS_HDFS', 'visibility' => 'Public', 'backendName' => 'dataSourceType'], + ], + 'example' => '', + 'visibility' => 'Public', ], 'TableResource' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'Authentication resource structure-Table'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => 'database name', - 'description' => 'The database name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'DatabaseName', - ], - 'TableName' => [ - 'title' => 'tablename', - 'description' => 'The name of the queried table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_parquet', - 'backendName' => 'TableName', - ], + 'DatabaseName' => ['title' => '', 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'TableName' => ['title' => '', 'description' => 'The name of the queried table.'."\n", 'type' => 'string', 'example' => 'test_parquet', 'visibility' => 'Public', 'backendName' => 'TableName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'TableStorageRank' => [ 'title' => '', 'description' => 'Table Storage Ranking'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'TableName' => [ - 'title' => '', - 'description' => 'The name of the table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'store_sales', - 'backendName' => 'TableName', - ], - 'Quantity' => [ - 'title' => '', - 'description' => 'Size'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4277873188582', - 'backendName' => 'Quantity', - ], - 'DbName' => [ - 'title' => '', - 'description' => 'The library name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tpcds_text_parquet_10000', - 'backendName' => 'DbName', - ], + 'TableName' => ['title' => '', 'description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'store_sales', 'visibility' => 'Public', 'backendName' => 'TableName'], + 'Quantity' => ['title' => '', 'description' => 'Size'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4277873188582', 'visibility' => 'Public', 'backendName' => 'Quantity'], + 'DbName' => ['title' => '', 'description' => 'The library name.'."\n", 'type' => 'string', 'example' => 'tpcds_text_parquet_10000', 'visibility' => 'Public', 'backendName' => 'DbName'], ], + 'visibility' => 'Public', + 'example' => '', ], 'TableVersion' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The schema of a table version.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Table' => [ - 'description' => 'The details about the metadata table.'."\n", - 'visibility' => 'public', - 'backendName' => 'Table', - '$ref' => '#/components/schemas/Table', - ], - 'VersionId' => [ - 'title' => 'table version', - 'description' => 'The version number.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'VersionId', - ], + 'Table' => ['description' => 'The details about the metadata table.'."\n", '$ref' => '#/components/schemas/Table', 'visibility' => 'Public', 'backendName' => 'Table', 'title' => '', 'example' => ''], + 'VersionId' => ['title' => '', 'description' => 'The version number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'visibility' => 'Public', 'backendName' => 'VersionId'], ], + 'visibility' => 'Public', + 'example' => '', ], 'TaskStatus' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'status and message'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => 'status of the task', - 'description' => 'The state of the task.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'KILLED', - 'backendName' => 'Status', - ], - 'Message' => [ - 'title' => 'message of the task', - 'description' => 'Task status messages.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'successful', - 'backendName' => 'Message', - ], + 'Status' => ['title' => '', 'description' => 'The state of the task.'."\n", 'type' => 'string', 'example' => 'KILLED', 'visibility' => 'Public', 'backendName' => 'Status'], + 'Message' => ['title' => '', 'description' => 'Task status messages.'."\n", 'type' => 'string', 'example' => 'successful', 'visibility' => 'Public', 'backendName' => 'Message'], ], + 'visibility' => 'Public', + 'example' => '', ], - 'UpdateTablePartitionColumnStatisticsRequest' => [ + 'UnarchiveDetail' => [ 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'ApiCallTimes' => ['title' => 'api调用次数', 'type' => 'integer', 'format' => 'int64'], + 'StorageSize' => ['title' => '存储大小', 'type' => 'integer', 'format' => 'int64'], + 'Cost' => ['title' => '成本', 'type' => 'integer', 'format' => 'int64'], + 'StorageType' => ['title' => '存储类型', 'type' => 'string'], + 'UnarchiveTaskStatus' => ['title' => '解冻状态', 'type' => 'string'], + ], + ], + 'UpdateTablePartitionColumnStatisticsRequest' => [ + 'title' => '', 'description' => 'UpdateTableColumnStatistics'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1344371', - 'backendName' => 'CatalogId', - ], + 'CatalogId' => ['title' => '', 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n", 'type' => 'string', 'example' => '1344371', 'visibility' => 'Public', 'backendName' => 'CatalogId'], 'ColumnStatisticsList' => [ - 'title' => 'ColumnStatisticsList', + 'title' => '', 'description' => 'The list of field statistics.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The statistics on the field.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ColumnStatistics', - ], + 'items' => ['description' => 'The statistics on the field.'."\n", '$ref' => '#/components/schemas/ColumnStatistics', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'ColumnStatisticsList', + 'example' => '', ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'database_test', - 'backendName' => 'DatabaseName', - ], - 'Engine' => [ - 'title' => 'Engine', - 'description' => 'Engine'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'MySQL', - 'backendName' => 'Engine', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the metadata table.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tabletest', - 'backendName' => 'TableName', - ], - 'ValidWriteIdList' => [ - 'title' => 'ValidWriteIdList, optional', - 'description' => 'This parameter is not supported and can be left empty.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'ValidWriteIdList', - ], - 'WriteId' => [ - 'title' => 'WriteId, optional', - 'description' => 'This parameter is not supported and can be left empty.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'WriteId', - ], - 'IsStatsCompliant' => [ - 'title' => 'IsStatsCompliant', - 'description' => 'IsStatsCompliant'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'IsStatsCompliant', - ], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'database_test', 'visibility' => 'Public', 'backendName' => 'DatabaseName'], + 'Engine' => ['title' => '', 'description' => 'Engine'."\n", 'type' => 'string', 'example' => 'MySQL', 'visibility' => 'Public', 'backendName' => 'Engine'], + 'TableName' => ['title' => '', 'description' => 'The name of the metadata table.'."\n", 'type' => 'string', 'example' => 'tabletest', 'visibility' => 'Public', 'backendName' => 'TableName'], + 'ValidWriteIdList' => ['title' => '', 'description' => 'This parameter is not supported and can be left empty.'."\n", 'type' => 'string', 'example' => '""', 'visibility' => 'Public', 'backendName' => 'ValidWriteIdList'], + 'WriteId' => ['title' => '', 'description' => 'This parameter is not supported and can be left empty.'."\n", 'type' => 'string', 'example' => '""', 'visibility' => 'Public', 'backendName' => 'WriteId'], + 'IsStatsCompliant' => ['title' => '', 'description' => 'IsStatsCompliant'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'IsStatsCompliant'], ], + 'visibility' => 'Public', + 'example' => '', ], 'UserRole' => [ 'description' => 'Data Lake Metadata Role'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'title' => '', - 'description' => 'The role.'."\n", - 'visibility' => 'public', - 'backendName' => 'Role', - '$ref' => '#/components/schemas/Role', - ], - 'GrantTime' => [ - 'title' => '', - 'description' => 'The grant time.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'DatabaseWildcard', - 'backendName' => 'GrantTime', - ], - 'User' => [ - 'title' => '', - 'description' => 'The identity of the user.'."\n", - 'visibility' => 'public', - 'backendName' => 'User', - '$ref' => '#/components/schemas/Principal', - ], + 'Role' => ['title' => '', 'description' => 'The role.'."\n", '$ref' => '#/components/schemas/Role', 'visibility' => 'Public', 'backendName' => 'Role', 'example' => ''], + 'GrantTime' => ['title' => '', 'description' => 'The grant time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'GrantTime'], + 'User' => ['title' => '', 'description' => 'The identity of the user.'."\n", '$ref' => '#/components/schemas/Principal', 'visibility' => 'Public', 'backendName' => 'User', 'example' => ''], ], + 'visibility' => 'Public', 'parseType' => 'struct', + 'title' => '', + 'example' => '', ], 'UserRoles' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'The list of metadata roles and user relationships in the data lake.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The information about the user role.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/UserRole', - ], + 'items' => ['description' => 'The information about the user role.'."\n", '$ref' => '#/components/schemas/UserRole', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'parseType' => 'struct', 'itemName' => 'UserRoles', + 'example' => '', ], 'Workflow' => [ 'title' => '', - 'description' => 'The workflow.'."\n", - 'visibility' => 'Public', + 'description' => 'Contains the details of a workflow.', 'type' => 'object', 'properties' => [ - 'LatestInstanceId' => [ - 'title' => '', - 'description' => 'The ID of the instance.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'latestInstanceId', - ], - 'LatestInstanceStatus' => [ - 'title' => '', - 'description' => 'The status of the last running instance.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'latestInstanceStatus', - ], - 'LatestStartTime' => [ - 'title' => '', - 'description' => 'The start time of the last run.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'latestStartTime', - ], - 'LatestEndTime' => [ - 'title' => '', - 'description' => 'The end time of the most recent run.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'latestEndTime', - ], + 'LatestInstanceId' => ['title' => '', 'description' => 'The ID of the latest instance.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestInstanceId'], + 'LatestInstanceStatus' => ['title' => '', 'description' => 'The status of the latest instance.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestInstanceStatus'], + 'LatestStartTime' => ['title' => '', 'description' => 'The start time of the latest instance.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestStartTime'], + 'LatestEndTime' => ['title' => '', 'description' => 'The end time of the latest instance.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestEndTime'], ], + 'example' => '', + 'visibility' => 'Public', 'parseType' => 'struct', ], 'WorkflowInstance' => [ - 'title' => 'A short description of struct', - 'description' => 'The workflow running instance.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'Represents a single run of a workflow.', 'type' => 'object', 'properties' => [ - 'DlfWorkflowId' => [ - 'title' => '', - 'description' => 'The workflow ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'dlfWorkflowId', - ], - 'ExternalInstanceId' => [ - 'title' => '', - 'description' => 'The ID of the workflow instance.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'externalInstanceId', - ], - 'StartTime' => [ - 'title' => '', - 'description' => 'The beginning of the date range within which data is queried.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'startTime', - ], - 'EndTime' => [ - 'title' => '', - 'description' => 'The time when the DAG finished running.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'endTime', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The execution state of the query. Valid values:'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'status', - ], + 'DlfWorkflowId' => ['title' => '', 'description' => 'The ID of the workflow.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'dlfWorkflowId'], + 'ExternalInstanceId' => ['title' => '', 'description' => 'The ID of the associated business process.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'externalInstanceId'], + 'StartTime' => ['title' => '', 'description' => 'The time when the workflow instance started.', 'type' => 'integer', 'format' => 'int64', 'example' => '', 'visibility' => 'Public', 'backendName' => 'startTime'], + 'EndTime' => ['title' => '', 'description' => 'The time when the workflow instance ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '', 'visibility' => 'Public', 'backendName' => 'endTime'], + 'Status' => ['title' => '', 'description' => 'The execution status of the workflow instance.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'], 'RuntimeLogs' => [ 'title' => '', - 'description' => 'Run logs.'."\n", - 'visibility' => 'Public', + 'description' => 'The runtime logs for the workflow instance.', 'type' => 'array', - 'items' => [ - 'description' => 'The log information.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/LogInfo', - ], - 'backendName' => 'runtimeLogs', - ], - 'BatchProgress' => [ - 'title' => '', - 'description' => 'The progress of the de-identification task.'."\n", + 'items' => ['description' => 'Details of a single log entry.', '$ref' => '#/components/schemas/LogInfo', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'batchProgress', + 'backendName' => 'runtimeLogs', ], + 'BatchProgress' => ['title' => '', 'description' => 'The progress of the batch execution.', 'type' => 'integer', 'format' => 'int32', 'example' => '', 'visibility' => 'Public', 'backendName' => 'batchProgress'], ], + 'example' => '', + 'visibility' => 'Public', ], ], ], 'apis' => [ - 'CreateCatalog' => [ - 'summary' => 'Create a Data Catalog for Data Lake.', - 'path' => '/api/metastore/catalogs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AbortLock' => [ + 'path' => '/api/metastore/catalogs/databases/tables/locks/abort', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'CatalogInput' => [ - 'description' => 'The structure that is used to create or update the catalog.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/CatalogInput', - ], - ], - 'required' => false, - ], + 'name' => 'LockId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The lock ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16530'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Response Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BA84F8D4-5160-5544-BE76-3A306CD3A7B0', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '01D8DD6B-4929-5999-9BB3-950AA30E3BD0'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"BA84F8D4-5160-5544-BE76-3A306CD3A7B0\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateCatalog', - ], - 'DeleteCatalog' => [ - 'summary' => 'Deletes a data directory.', - 'path' => '/api/metastore/catalogs', - 'methods' => [ - 'delete', + 'title' => 'AbortLock', + 'summary' => 'Aborts the specified metadata lock.', + 'requestParamsDescription' => 'The ID of the lock. This ID is returned by the CreateLock operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortLock'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:AbortLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"01D8DD6B-4929-5999-9BB3-950AA30E3BD0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'BatchCreatePartitions' => [ + 'summary' => 'Creates multiple partitions for a data lake table in a batch.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchcreate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'catalog_test', - ], - ], - [ - 'name' => 'IsAsync', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '是否异步，默认同步', - 'description' => 'Whether asynchronous, synchronous by default.'."\n", - 'type' => 'boolean', + 'title' => '', + 'description' => 'The request body in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'IfNotExists' => ['title' => '', 'description' => 'Specifies whether to ignore the error if a partition with the same name already exists.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'NeedResult' => ['title' => '', 'description' => 'Specifies whether to return partition information. If this parameter is set to \\`true\\`, the response includes the \\`Partitions\\` parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'PartitionInputs' => [ + 'title' => '', + 'description' => 'A list of partition inputs.', + 'type' => 'array', + 'items' => ['description' => 'A partition input.', '$ref' => '#/components/schemas/PartitionInput', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], + ], 'required' => false, - 'example' => 'true', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Response Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Request is success or not', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => '.'], + 'PartitionErrors' => [ + 'title' => '', + 'description' => 'A list of error messages.', + 'type' => 'array', + 'items' => ['description' => 'An error message.', '$ref' => '#/components/schemas/PartitionError', 'title' => '', 'example' => ''], + 'example' => '', ], - 'TaskId' => [ - 'title' => '异步删除Catalog的taskId', - 'description' => 'The ID of the task for asynchronously deleting a catalog.'."\n", - 'type' => 'string', - 'example' => 'c38206c3aca0c41332ffe49294243009', + 'Partitions' => [ + 'title' => '', + 'description' => 'A list of partition results. This parameter is returned only if \\`NeedResult\\` is set to \\`true\\`.', + 'type' => 'array', + 'items' => ['description' => 'A partition result.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Code', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","type":"json"}]', - 'title' => 'DeleteCatalog', - ], - 'UpdateCatalog' => [ - 'summary' => 'Updates the contents of the Data Catalog.', - 'path' => '/api/metastore/catalogs', - 'methods' => [ - 'put', + 'title' => 'BatchCreatePartitions', + 'responseParamsDescription' => 'Descriptions of \\`Code\\` values:'."\n" + ."\n" + .'- InvalidObject: The specified table or database was not found.'."\n" + ."\n" + .'- AlreadyExists: The specified partition already exists.'."\n" + ."\n" + .'- InternalError: An internal error occurred. See the \\`Message\\` parameter for more information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreatePartitions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchCreatePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"PartitionValues\\": [\\n \\"2010\\"\\n ]\\n }\\n ],\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchCreateTables' => [ + 'path' => '/api/metastore/catalogs/databases/tables/batchcreate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -4085,323 +1884,322 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The request body. The value must be in the JSON format.', 'type' => 'object', 'properties' => [ - 'CatalogInput' => [ - 'description' => 'The structure that is used to create or update the catalog.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/CatalogInput', + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'IfNotExists' => ['title' => '', 'description' => 'Specifies whether to ignore an error if a table with the same name already exists.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'TableInputs' => [ + 'title' => '', + 'description' => 'The list of tables.', + 'type' => 'array', + 'items' => ['description' => 'The details of a table.', '$ref' => '#/components/schemas/TableInput', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', ], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response encoding.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Response Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '64E46067-49EA-5A91-A7B1-E812E18FC243', - ], - 'Success' => [ - 'title' => 'Request is success or not', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => '.'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'TableErrors' => [ + 'title' => '', + 'description' => 'A list of error messages for the tables that failed to be created.', + 'type' => 'array', + 'items' => ['description' => 'The error message for a table that failed to be created.', '$ref' => '#/components/schemas/TableError', 'title' => '', 'example' => ''], + 'example' => '["ErrorDetail":{},"TableName":"test"]', ], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Response', + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"64E46067-49EA-5A91-A7B1-E812E18FC243\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateCatalog', - ], - 'ListCatalogs' => [ - 'summary' => 'You can call this operation to query the list of metabase namespaces (catalogs).', - 'path' => '/api/metastore/catalogs/list', - 'methods' => [ - 'get', + 'title' => 'BatchCreateTables', + 'summary' => 'Creates multiple tables in a data lake.', + 'responseParamsDescription' => 'Error codes<br>InvalidObject: The name, partition, column, or skewCol parameter is invalid.<br>AlreadyExists: The metadata table already exists.<br>NoSuchObject: The specified metadatabase does not exist.<br>InternalError: An internal error occurred. For more information, see the Message parameter.<br><br><br><br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateTables'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchCreateTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"TableName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchDeletePartitions' => [ + 'summary' => 'Deletes specified partitions from a data lake table.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchdelete', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'IdPattern', - 'in' => 'query', - 'schema' => [ - 'title' => 'catalogId', - 'description' => 'Regular matching of CatalogId'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*', - ], - ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'namePattern', - 'description' => 'The page turning token, which is returned from the returned result. If none is returned, an empty string or\'\''."\n", - 'type' => 'string', - 'required' => false, - 'example' => '‘’', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'pageSize', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The request body. The value must be in the JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'IfExists' => ['title' => '', 'description' => 'Specifies whether to ignore an error if you try to delete a partition that does not exist.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'PartitionValueList' => ['description' => 'The list of partition values to delete.', '$ref' => '#/components/schemas/PartitionValueList', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201225'], + ], 'required' => false, - 'maximum' => '1000000', - 'minimum' => '-2', - 'example' => '10', - 'default' => '1000', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Catalog Response', - 'description' => 'The returned result.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Catalogs' => [ - 'title' => 'Catalogs', - 'description' => 'The catalogs.'."\n", + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'PartitionErrors' => [ + 'title' => '', + 'description' => 'The list of error messages.', 'type' => 'array', - 'items' => [ - 'description' => 'The catalog details.'."\n", - '$ref' => '#/components/schemas/Catalog', - ], - 'example' => '[{"CatalogId":"xx"}]', - ], - 'Code' => [ - 'title' => 'Code', - 'description' => 'Status Code Description'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'Page Flip token'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the test feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'items' => ['description' => 'The error message.', '$ref' => '#/components/schemas/PartitionError', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Code', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], - '5XX' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Catalogs\\": [\\n {\\n \\"CatalogId\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"CreatedBy\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CatalogType\\": \\"\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListCatalogs', - 'requestParamsDescription' => '* IdPattern: the name of the catalog to be queried. \\*\\*.\\*\\*\\* matching is supported. indicates that one character is matched, and \\* indicates that n characters are matched.'."\n" - .'* NextPageToken: the start position of the page. You can enter an empty string for the first time, and then enter the NextPageToken returned in the previous response. If the returned NextPageToken is an empty string, no data is found.'."\n" - .'* pagesize: the number of entries returned at a time.'."\n", - 'responseParamsDescription' => 'Code error codes\\'."\n" - .'InternalError: other types of errors. For more information, see Message tips.'."\n", - ], - 'GetCatalog' => [ - 'summary' => 'Obtains the details of a data directory.', - 'path' => '/api/metastore/catalogs', - 'methods' => [ - 'get', + 'title' => 'BatchDeletePartitions', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- UnknownTable: The specified table does not exist.'."\n" + ."\n" + .'- UnknownPartition: The specified partition does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeletePartitions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchDeletePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"PartitionValues\\": [\\n \\"2010\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchDeleteTableVersions' => [ + 'summary' => 'Deletes specified versions of a data lake table in a batch.', + 'path' => '/api/metastore/catalogs/databases/tables/versions/batchdelete', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'catalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The request body. The value must be in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'TableName' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + 'VersionIds' => [ + 'title' => '', + 'description' => 'A list of version numbers.', + 'type' => 'array', + 'items' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'catalog_test', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Databases Response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Catalog' => [ - 'description' => 'The catalog details.'."\n", - 'example' => '', - '$ref' => '#/components/schemas/Catalog', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Code', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85\\",\\n \\"Success\\": true,\\n \\"Catalog\\": {\\n \\"CatalogId\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"CreatedBy\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CatalogType\\": \\"\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetCatalog', - ], - 'CreateDatabase' => [ - 'summary' => 'Create a metadabase in the data lake metadata.', - 'path' => '/api/metastore/catalogs/databases', - 'methods' => [ - 'post', + 'title' => 'BatchDeleteTableVersions', + 'responseParamsDescription' => 'Code: The error code.<br>'."\n" + .'NoSuchObject: The specified table does not exist.<br>'."\n" + .'InternalError: An internal error occurred. See the Message parameter for details.<br><br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteTableVersions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchDeleteTableVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchDeleteTables' => [ + 'summary' => 'Deletes multiple tables in a data lake by name.', + 'path' => '/api/metastore/catalogs/databases/tables/batchdelete', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -4409,260 +2207,212 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The request body in JSON format.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseInput' => [ - 'description' => 'The database details.'."\n", + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'IfExists' => ['title' => '', 'description' => 'Specifies whether to ignore the error if the table does not exist.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'TableNames' => [ + 'title' => '', + 'description' => 'The list of table names.', + 'type' => 'array', + 'items' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223', 'title' => ''], 'required' => false, - '$ref' => '#/components/schemas/DatabaseInput', + 'example' => '', ], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Response Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates success, while \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], + 'TableErrors' => [ + 'title' => '', + 'description' => 'The collection of error messages.', + 'type' => 'array', + 'items' => ['description' => 'The error message.', '$ref' => '#/components/schemas/TableError', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateDatabase', - 'responseParamsDescription' => 'Code error codes\\'."\n" - .'InvalidObject:name/partition/column/skewCol verification fails\\'."\n" - .'AlreadyExists: The corresponding metadase already exists.\\'."\n" - .'InternalError: other types of errors. For more information, see Message tips.'."\n", - ], - 'DeleteDatabase' => [ - 'summary' => 'Deletes a database in the data lake by name.', - 'path' => '/api/metastore/catalogs/databases', - 'methods' => [ - 'delete', + 'title' => 'BatchDeleteTables', + 'responseParamsDescription' => 'NoSuchObject: The specified table does not exist.<br>'."\n" + .'InternalError: An internal error occurred. For more information, refer to the Message parameter.<br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteTables'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchDeleteTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"TableName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchGetPartitionColumnStatistics' => [ + 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics/batchget', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => 'Name', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - ], - [ - 'name' => 'Cascade', - 'in' => 'query', - 'schema' => [ - 'title' => 'Cascade', - 'description' => 'Whether to cascade delete data. Valid values:'."\n" - ."\n" - .'* true: deletes a table from the database.'."\n" - .'* false: does not delete tables from the database. If a table still exists in the database, the deletion fails.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'Async', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Whether to asynchronously execute.'."\n", - 'type' => 'boolean', + 'title' => '', + 'description' => 'The HTTP request body is in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The data catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], + 'PartitionNames' => ['description' => 'The list of partition names for the data table.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + 'ColumnNames' => ['description' => 'The list of fields in the data table.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'true', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'The message body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The description of the distribution status.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Response Message', - 'description' => 'A related error message is displayed.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '73201200-4C1A-4FEF-BD6B-C0DA7994FFA2', - ], - 'Success' => [ - 'title' => 'Request is success or not', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TaskId' => [ - 'description' => 'The ID of the task that is used to asynchronously delete a database.'."\n", - 'type' => 'string', - 'example' => 'c38206c3aca0c41332ffe49294243009', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'PartitionStatisticsMap' => [ + 'title' => '', + 'description' => 'The statistics of the partition.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'The statistics of the partition.', '$ref' => '#/components/schemas/ColumnStatisticsObj', 'title' => '', 'example' => ''], + 'description' => 'A list of partition statistics.', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call succeeded. Valid values:'."\n" + ."\n" + .'- true: The call succeeded.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Response Object', + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"73201200-4C1A-4FEF-BD6B-C0DA7994FFA2\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteDatabase', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database does not exist.'."\n" - .'* InvalidOperation: The table or function still exists in the database and cannot be deleted.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'UpdateDatabase' => [ - 'summary' => 'Update the details of a database in the data lake.', - 'path' => '/api/metastore/catalogs/databases', - 'methods' => [ - 'put', + 'title' => 'BatchGetPartitionColumnStatistics', + 'summary' => 'Retrieves the column statistics of multiple partitions in a data lake table.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetPartitionColumnStatistics'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchGetPartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"PartitionStatisticsMap\\": {\\n \\"key\\": [\\n {\\n \\"ColumnName\\": \\"col1\\",\\n \\"ColumnType\\": \\"int\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"{\\\\\\"numNulls\\\\\\":0,\\\\\\"numTrues\\\\\\":1,\\\\\\"numFalses\\\\\\":5}\\",\\n \\"StatisticsType\\": \\"BOOLEAN_STATS\\"\\n }\\n }\\n ]\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchGetPartitions' => [ + 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchget', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -4670,397 +2420,423 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The HTTP request body. The content must be in JSON format.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseInput' => [ - 'description' => 'The information about the updated database.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/DatabaseInput', - ], - 'Name' => [ - 'title' => 'Name', - 'description' => 'The name of the database before the update. If the database name remains the same after the update, only other information in the DatabaseInput parameter is updated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'PartitionValueList' => ['description' => 'The list of partition values.', '$ref' => '#/components/schemas/PartitionValueList', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + 'IsShareSd' => ['title' => '', 'description' => 'Indicates whether to share the column information in the storage descriptor (SD) of the partitions.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The description of the distribution status.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Response Message', - 'description' => 'A related error message is displayed.'."\n", - 'type' => 'string', - 'example' => '.', + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'PartitionErrors' => [ + 'title' => '', + 'description' => 'A list of error messages.', + 'type' => 'array', + 'items' => ['description' => 'The error message.', '$ref' => '#/components/schemas/PartitionError', 'title' => '', 'example' => ''], + 'example' => '', ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '161F5EFC-E97E-43C0-AACF-FF18FAC912F0', + 'Partitions' => [ + 'title' => '', + 'description' => 'A list of partition details.', + 'type' => 'array', + 'items' => ['description' => 'The partition details.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], + 'example' => '', ], - 'Success' => [ - 'title' => 'Request is success or not', - 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'PartitionSpecs' => [ + 'title' => '', + 'description' => 'A list of partition specifications.', + 'type' => 'array', + 'items' => ['description' => 'The partition specification.', '$ref' => '#/components/schemas/PartitionSpec', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Response', + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"161F5EFC-E97E-43C0-AACF-FF18FAC912F0\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateDatabase', - 'responseParamsDescription' => 'Code error code description:'."\n" + 'title' => 'BatchGetPartitions', + 'summary' => 'Retrieves the details of multiple partitions in a data lake database.', + 'responseParamsDescription' => 'Error codes for the Code parameter:'."\n" ."\n" - .'* AlreadyExists: The new database name already exists.'."\n" - .'* NoSuchObject: The specified database does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'GetDatabase' => [ - 'summary' => 'Obtains the details of a database in a data lake.', - 'path' => '/api/metastore/catalogs/databases', - 'methods' => [ - 'get', + .'- NoSuchObject: The specified database or data table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetPartitions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:BatchGetPartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"PartitionValues\\": [\\n \\"2010\\"\\n ]\\n }\\n ],\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchGetTables' => [ + 'summary' => 'Retrieves details for multiple tables in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/batchget', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'The name of the database to query.', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The request body. The value must be in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'TableNames' => ['description' => 'The names of the data tables.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'database_test', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Database' => [ - 'description' => 'The database object.'."\n", - 'example' => '{"name":"test"}', - '$ref' => '#/components/schemas/Database', - ], - 'Message' => [ - 'title' => 'Response Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D659761F-29C3-409D-805A-0CF33A320128', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. \\`true\\`: The call was successful. \\`false\\`: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'TableErrors' => [ + 'title' => '', + 'description' => 'A list of error messages.', + 'type' => 'array', + 'items' => ['description' => 'The error message.', '$ref' => '#/components/schemas/TableError', 'title' => '', 'example' => ''], + 'example' => '', ], - 'Success' => [ - 'title' => 'API is success or not', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Tables' => [ + 'title' => '', + 'description' => 'A list of data tables.', + 'type' => 'array', + 'items' => ['description' => 'The data table.', '$ref' => '#/components/schemas/Table', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Response', + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Database\\": {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"D659761F-29C3-409D-805A-0CF33A320128\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetDatabase', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'ListDatabases' => [ - 'summary' => 'Obtains a list of databases in the data lake and queries them by page. You can match them based on the database name.', - 'path' => '/api/metastore/catalogs/databases/list', - 'methods' => [ - 'get', + 'title' => 'BatchGetTables', + 'responseParamsDescription' => 'Code: The error code.<br>'."\n" + .'NoSuchObject: The specified data table does not exist.<br>'."\n" + .'InternalError: An internal error occurred. For more information, see the value of the Message parameter.<br><br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetTables'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:BatchGetTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"TableName\\": \\"test\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchGrantPermissions' => [ + 'summary' => 'Grants permissions on resources to DLF users or roles in batches.', + 'path' => '/api/metastore/auth/permissions/batchgrant', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'catalogId', - 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n", - 'type' => 'string', + 'description' => 'The request body, in JSON format.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of authorization. Only Hive is supported.', + 'type' => 'string', + 'required' => true, + 'enum' => ['hive'], + 'title' => '', + 'example' => 'Hive', + ], + 'GrantRevokeEntries' => [ + 'title' => '', + 'description' => 'The permissions to grant.', + 'type' => 'array', + 'items' => ['description' => 'The details of an authorization entry.', '$ref' => '#/components/schemas/GrantRevokeEntry', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'CatalogId' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], 'required' => false, - 'example' => '1344371', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'NamePattern', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'namePattern', - 'description' => 'The regular expression used to match the database name. If all matches are specified, this parameter is specified. \\*'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*', + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'BatchGrantRevokeFailureResult' => ['title' => '', 'description' => 'The result of a failed operation.', '$ref' => '#/components/schemas/BatchGrantRevokeFailureResult', 'example' => '参考BatchGrantRevokeFailureResult结构'], + ], + 'example' => '', ], ], + '5XX' => [], + ], + 'title' => 'BatchGrantPermissions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGrantPermissions'], + ], + ], + 'ramActions' => [ [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'namePattern', - 'description' => 'The paging token, which is returned by the result. For example, you can specify "" for the first page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa!', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:BatchGrantPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"BatchGrantRevokeFailureResult\\": [\\n {\\n \\"GrantRevokeEntry\\": {\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"1344371\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"*\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"TableName\\": \\"test_parquet\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"Id\\": \\"CRW-7A1EC3D73BF419AF\\"\\n },\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'BatchRevokePermissions' => [ + 'path' => '/api/metastore/auth/permissions/batchrevoke', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => 'pageSize', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000000', - 'minimum' => '-2', - 'example' => '10', - 'default' => '1000', - ], + 'AK' => [], ], ], - 'responses' => [ - 200 => [ + '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' => [ - 'title' => 'Databases Response', - 'description' => 'The returned data body.'."\n", + 'description' => 'The request body in the JSON format.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Description'."\n", + 'Type' => [ + 'description' => 'The authorization type. Currently, only Hive is supported.', 'type' => 'string', - 'example' => 'OK', + 'required' => true, + 'enum' => ['hive'], + 'title' => '', + 'example' => 'Hive', ], - 'Databases' => [ - 'title' => 'Database List', - 'description' => 'The list of databases.'."\n", + 'GrantRevokeEntries' => [ + 'title' => '', + 'description' => 'The permissions to revoke.', 'type' => 'array', - 'items' => [ - 'description' => 'The database query results.'."\n", - '$ref' => '#/components/schemas/Database', - ], - 'example' => '[{"name":"test"}]', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'Page Flip token'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the test feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'items' => ['description' => 'The permission to revoke.', '$ref' => '#/components/schemas/GrantRevokeEntry', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', ], + 'CatalogId' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Response', + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'Response Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'The status code of the response.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C9E535E1-F040-56F4-B4EE-592B555DAE19'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'BatchGrantRevokeFailureResult' => ['title' => '', 'description' => 'The details of a failed revocation.', '$ref' => '#/components/schemas/BatchGrantRevokeFailureResult', 'example' => '参考BatchGrantRevokeFailureResult结构'], ], + 'example' => '', ], ], + '5XX' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Databases\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDatabases', - 'requestParamsDescription' => '* NamePattern: the name of the database to be queried. \\*\\*.\\*\\*\\* matching is supported. indicates that one character is matched, and \\* indicates that n characters are matched.'."\n" - .'* NextPageToken: the start position of the page. You can enter an empty string for the first time, and then enter the NextPageToken returned in the previous response. If the returned NextPageToken is an empty string, no data is found.'."\n" - .'* pagesize: the number of entries returned at a time.'."\n", - 'responseParamsDescription' => 'Code error codes\\'."\n" - .'InternalError: other types of errors. For more information, see Message tips.'."\n", - ], - 'CreateTable' => [ - 'summary' => 'Add a data table for the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables', - 'methods' => [ - 'post', + 'title' => 'BatchRevokePermissions', + 'summary' => 'Revokes one or more permissions on resources from DLF users and roles.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchRevokePermissions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:BatchRevokePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"C9E535E1-F040-56F4-B4EE-592B555DAE19\\",\\n \\"Success\\": true,\\n \\"BatchGrantRevokeFailureResult\\": [\\n {\\n \\"GrantRevokeEntry\\": {\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"1344371\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"*\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"TableName\\": \\"test_parquet\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"Id\\": \\"CRW-7A1EC3D73BF419AF\\"\\n },\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'BatchUpdatePartitions' => [ + 'summary' => 'Performs a batch update on multiple partitions for a table in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchupdate', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -5068,518 +2844,652 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The request body in JSON format.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'TableInput' => [ - 'description' => 'The details about the data table.'."\n", + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'PartitionInputs' => [ + 'title' => '', + 'description' => 'The list of partition inputs.', + 'type' => 'array', + 'items' => ['description' => 'The partition input to update.', '$ref' => '#/components/schemas/PartitionInput', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - '$ref' => '#/components/schemas/TableInput', + 'example' => '', ], + 'TableName' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'PartitionErrors' => [ + 'title' => '', + 'description' => 'The list of error messages.', + 'type' => 'array', + 'items' => ['description' => 'The error message.', '$ref' => '#/components/schemas/PartitionError', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'code', - 'description' => 'code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateTable', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* InvalidObject:name/partition/column/skewCol does not pass the verification.'."\n" - .'* AlreadyExists: The specified table already exists.'."\n" - .'* NoSuchObject: The specified database does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'DeleteTable' => [ - 'summary' => 'Deletes a data table in a data lake by name.', - 'path' => '/api/metastore/catalogs/databases/tables', - 'methods' => [ - 'delete', + 'title' => 'BatchUpdatePartitions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdatePartitions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchUpdatePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"PartitionValues\\": [\\n \\"2010\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'BatchUpdateTables' => [ + 'summary' => 'Batch updates the details of tables in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/batchupdate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The request body in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'TableInputs' => [ + 'title' => '', + 'description' => 'The details of the tables to be updated.', + 'type' => 'array', + 'items' => ['description' => 'The details of the tables to be updated.', '$ref' => '#/components/schemas/TableInput', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'IsAsync' => ['description' => 'Specifies whether to update the tables asynchronously. Valid values:'."\n" + ."\n" + .'- true: Asynchronous invocation. The API operation returns a response without waiting for the background task to complete. The response includes a task ID that can be used to query the task status.'."\n" + ."\n" + .'- false: Synchronous call. The operation waits for the background task to finish before it returns a response. The call might time out if the task takes a long time.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'example' => 'test_table_20201223', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => '.'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'TableErrors' => [ + 'title' => '', + 'description' => 'A list of error messages.', + 'type' => 'array', + 'items' => ['description' => 'The error message.', '$ref' => '#/components/schemas/TableError', 'title' => '', 'example' => ''], + 'example' => '{"ErrorDetails":{},"TableName":"test"}', ], + 'TaskId' => ['description' => 'The ID of the asynchronous update task.', 'type' => 'string', 'title' => '', 'example' => 'f8deec55f54ac566e7ec8944fbe01588'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteTable', - 'responseParamsDescription' => 'Code error code description:'."\n" + 'title' => 'BatchUpdateTables', + 'responseParamsDescription' => 'The Code parameter can return the following error codes:'."\n" ."\n" - .'* NoSuchObject: The specified data table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'DeleteTableColumnStatistics' => [ - 'summary' => 'Recycle field statistics for data tables in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics', - 'methods' => [ - 'delete', + .'- InvalidOperation: The specified table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateTables'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchUpdateTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"401\\",\\n \\"Message\\": \\"auth failed\\"\\n },\\n \\"TableName\\": \\"test\\"\\n }\\n ],\\n \\"TaskId\\": \\"f8deec55f54ac566e7ec8944fbe01588\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CancelQuery' => [ + 'summary' => 'Cancels a query.', + 'path' => '/webapi/query/cancelQuery', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', + 'name' => 'QueryId', 'in' => 'query', + 'schema' => ['description' => 'The query ID.'."\n" + ."\n" + .'> Call the SubmitQuery operation to obtain the query ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Q-BCA5E96CB84BB8B8', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The query ID.', 'type' => 'string', 'example' => 'Q-BCA5E96CB84BB8B8', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CancelQuery', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CancelQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"Q-BCA5E96CB84BB8B8\\",\\n \\"RequestId\\": \\"DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CheckPermissions' => [ + 'path' => '/api/metastore/auth/permissions/check', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ [ - 'name' => 'ColumnNames', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', 'style' => 'json', - 'schema' => [ - 'description' => 'The list of column names.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], + 'schema' => ['description' => 'The request body in JSON format.', '$ref' => '#/components/schemas/AccessRequest', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876'], 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" + 'title' => '', + 'description' => 'Indicates whether the call was successful. Valid values:'."\n" ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', + 'enumValueTitles' => [], 'type' => 'boolean', 'example' => 'true', ], ], + 'example' => '', + ], + ], + '5XX' => [], + ], + 'title' => 'CheckPermissions', + 'summary' => 'Checks user permissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckPermissions'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:CheckPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateCatalog' => [ + 'summary' => 'Creates a catalog.', + 'path' => '/api/metastore/catalogs', + 'methods' => ['post'], + 'schemes' => ['http', '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' => [ + 'title' => '', + 'description' => 'The HTTP request body.', + 'type' => 'object', + 'properties' => [ + 'CatalogInput' => ['description' => 'The details of the catalog to create.', '$ref' => '#/components/schemas/CatalogInput', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA84F8D4-5160-5544-BE76-3A306CD3A7B0'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', + 'title' => '', + 'description' => 'Response Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteTableColumnStatistics', - 'responseParamsDescription' => '* code: the error code.'."\n" - .'* message: the error message.'."\n" - .'* requestId: the unique ID of the current request.'."\n" - .'* Success:true/false to determine whether the request is successful.'."\n", - ], - 'DeleteTableVersion' => [ - 'summary' => 'Deletes a specified version of a data table in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/versions', - 'methods' => [ - 'delete', + 'title' => 'CreateCatalog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCatalog'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"BA84F8D4-5160-5544-BE76-3A306CD3A7B0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateDatabase' => [ + 'summary' => 'Creates a metadatabase in the metadata of a data lake.', + 'path' => '/api/metastore/catalogs/databases', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The request body. The value must be in the JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseInput' => ['description' => 'The details of the database.', '$ref' => '#/components/schemas/DatabaseInput', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '1344371', + 'example' => '', ], ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], - [ - 'name' => 'TableName', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', + 'title' => '', + 'description' => 'Response Code', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'title' => 'CreateDatabase', + 'responseParamsDescription' => 'Error codes for the Code parameter<br>'."\n" + .'InvalidObject: The name, partition, column, or skewCol parameter failed validation.<br>'."\n" + .'AlreadyExists: The metadatabase already exists.<br>'."\n" + .'InternalError: An internal error occurred. For more information, see the value of the Message parameter.<br><br><br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatabase'], + ], + ], + 'ramActions' => [ [ - 'name' => 'VersionId', - 'in' => 'query', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateFunction' => [ + 'summary' => 'Creates a user-defined function in a database within a data lake.', + 'path' => '/api/metastore/catalogs/databases/functions', + 'methods' => ['post'], + 'schemes' => ['http', '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' => [ - 'title' => 'table version id', - 'description' => 'The version number.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The request body is in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'FunctionInput' => ['description' => 'The details of the function definition.', '$ref' => '#/components/schemas/FunctionInput', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteTableVersion', - ], - 'UpdateTable' => [ - 'summary' => 'Update the data table information in the data lake based on the name.', - 'path' => '/api/metastore/catalogs/databases/tables', - 'methods' => [ - 'put', + 'title' => 'CreateFunction', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- AlreadyExists: The function already exists.'."\n" + ."\n" + .'- NoSuchObject: The specified database or table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunction'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateLock' => [ + 'path' => '/api/metastore/catalogs/databases/tables/locks', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -5587,2319 +3497,2101 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'SkipArchive' => [ - 'title' => 'SkipArchive', - 'description' => 'By default, if a data table is updated, a backup version of the data table is created. However, if you set the skipArchive parameter to true, no backup version is created.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'TableInput' => [ - 'description' => 'The details about the updated data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TableInput', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], - 'IsAsync' => [ - 'title' => 'IsAsync', - 'description' => 'Specifies whether to synchronously update the data table.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'AllowPartitionKeyChange' => [ - 'title' => 'AllowPartitionKeyChange', - 'description' => 'Specifies whether the partition key can be updated.'."\n", - 'type' => 'boolean', + 'LockObjList' => [ + 'title' => '', + 'description' => 'A list of lock information.', + 'type' => 'array', + 'items' => ['description' => 'The lock information.', '$ref' => '#/components/schemas/LockObj', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'example' => 'false', + 'example' => '{"databaseName":"db","tableName":"test"}', ], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TaskId' => [ - 'title' => 'Async task Id', - 'description' => 'The ID of the asynchronous task.'."\n", - 'type' => 'string', - 'example' => 'aa689782deb97265701f57324fc4ae42', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '73201200-4C1A-4FEF-BD6B-C0DA7994FFA2'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'], + 'LockStatus' => ['description' => 'The lock status information.', '$ref' => '#/components/schemas/LockStatus', 'example' => '{"lockId":12323,"lockStatus":"ACQUIRED"}', 'title' => ''], ], + 'example' => '', ], ], '5XX' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"aa689782deb97265701f57324fc4ae42\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateTable', - 'requestParamsDescription' => 'IsAsync:'."\n" + 'title' => 'CreateLock', + 'summary' => 'Creates a metadata lock.', + 'requestParamsDescription' => '1. The LockObjList parameter can contain only one lock object.'."\n" ."\n" - .'* true: The API operation is called asynchronously and does not wait for the background task to be returned. The response contains a taskid. In this way, the client can query the status of the task by using the taskid.'."\n" - .'* false: indicates a synchronous call. The interface returns results only when the background task is completed. Then the risk of false is that if the background task needs to be done very long, the interface will time out.'."\n", - 'responseParamsDescription' => 'Code error code description:'."\n" + .'2. The LockObj parameter supports only table locks. Partition-level locks are not supported.', + 'responseParamsDescription' => '- Code: The error code.'."\n" ."\n" - .'* InvalidOperation: The database or table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n" - .'* taskid: because the updatetable also updates all partitions information of the table. if the task is submitted asynchronously, a taskid is returned to track the execution status of the asynchronous task. If the data is submitted synchronously, this value is meaningless.'."\n", - ], - 'UpdateTableColumnStatistics' => [ - 'summary' => 'Creates or updates field statistics for a data table.', - 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics', - 'methods' => [ - 'put', + .'- Message: The error message.'."\n" + ."\n" + .'- RequestId: The unique ID of the request.'."\n" + ."\n" + .'- Success: Indicates whether the request is successful. Valid values are true and false.'."\n" + ."\n" + .'- LockStatus: This field is returned only if the request is successful. Otherwise, this field is empty. The LockStatus object contains two fields: LockId and LockState. The LockId field has a value if the value of LockState is ACQUIRED. Otherwise, the LockId field is empty.', + 'extraInfo' => '****获取到lockid之后，如何在createtable、update table使用该lock？**'."\n" + ."\n" + .'下面以CreateTable接口为例，需要在header中把lock获取的lockid传递进去，这样才能使用lock。'."\n" + ."\n" + .'> 另外需要注意，lock有事务语义，只有传入lock，按照事务隔离性才能获取当前事务的状态，否则看到到是事务提交前的状态。'."\n" + ."\n" + .'> 比如一个请求对表已经加了lock，同时delete了改表，但是如果事务没有提交（也就是没有unlock），这个时候又来了一个请求，要去createtable，如果没有带上lock，那么发现表示存在的，因为看到的是事务提交之前的状态，所以创建失败。如果createtable，带上这个lock，那么就进入事务中，就可以看到这个表已经delete了，那么createtable就能创建成功。'."\n" + ."\n\n" + .'```'."\n" + .'CreateTableRequest request = new CreateTableRequest();'."\n" + .'request.catalogId = catalogId;'."\n" + .'request.databaseName = databaseName;'."\n" + .'request.tableInput = table;'."\n" + ."\n" + .'RuntimeOptions runtime = new RuntimeOptions();'."\n" + .'Map<String, String> headers = new HashMap();'."\n" + ."\n" + .'//需要在建表或者update的表中的header中设置lockid'."\n" + .'headers.put("metastore-lock-id", String.valueOf(lockId));'."\n" + ."\n" + .'CreateTableResponseBody response = client.createTableWithOptions(request, headers, runtime).body;'."\n" + .'return new ResultModel<>(response.success, response.code, response.message,'."\n" + .' response.requestId);'."\n" + .'```'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLock'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"73201200-4C1A-4FEF-BD6B-C0DA7994FFA2\\",\\n \\"Success\\": true,\\n \\"LockStatus\\": {\\n \\"LockId\\": 1,\\n \\"LockState\\": \\"ACQUIRED\\"\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreatePartition' => [ + 'summary' => 'Adds a partition to a data table in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'UpdateTablePartitionColumnStatisticsRequest', + 'name' => 'Body', 'in' => 'body', - 'style' => 'flat', + 'style' => 'json', 'schema' => [ - 'description' => 'The request to update statistics.'."\n", + 'title' => '', + 'description' => 'The request body in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'IfNotExists' => ['title' => '', 'description' => 'Specifies whether to ignore the exception if a partition with the same name already exists.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'NeedResult' => ['title' => '', 'description' => 'Specifies whether to return partition information. If you set this parameter to true, the Partition object is returned.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'PartitionInput' => ['description' => 'The partition input.', '$ref' => '#/components/schemas/PartitionInput', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], + ], 'required' => false, - '$ref' => '#/components/schemas/UpdateTablePartitionColumnStatisticsRequest', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'object', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Partition' => ['description' => 'The partition details. This parameter is returned only when NeedResult is set to true.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateTableColumnStatistics', - ], - 'GetTable' => [ - 'summary' => 'Get detailed information about the data tables in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables', - 'methods' => [ - 'get', + 'title' => 'CreatePartition', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- InvalidObject: The specified database or table cannot be found.'."\n" + ."\n" + .'- AlreadyExists: The specified partition already exists.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the value of the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePartition'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreatePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Partition\\": {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n },\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateRole' => [ + 'path' => '/api/metastore/auth/roles', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => ['description' => 'The HTTP request body in JSON format.', '$ref' => '#/components/schemas/RoleInput', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '77BC2016-BA80-570F-BD15-2FB80281FED6'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], + ], + 'title' => 'CreateRole', + 'summary' => 'Creates a DLF role.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRole'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"77BC2016-BA80-570F-BD15-2FB80281FED6\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateTable' => [ + 'summary' => 'Creates a table in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableName', - 'in' => 'query', + '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' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The HTTP request body in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'TableInput' => ['description' => 'The details of the table.', '$ref' => '#/components/schemas/TableInput', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'test_table_20200715162543389', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The message returned.'."\n", + 'title' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Table' => [ - 'description' => 'The details about the data table.'."\n", - '$ref' => '#/components/schemas/Table', - ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetTable', - 'responseParamsDescription' => 'Code: the error code.\\'."\n" - .'NoSuchObject: The specified metadata table does not exist.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'GetTableColumnStatistics' => [ - 'summary' => 'You can call this operation to obtain statistics about a specified field in a data table in a data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'CreateTable', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- InvalidObject: The name, partition, column, or skewCol parameter failed validation.'."\n" + ."\n" + .'- AlreadyExists: The specified table already exists.'."\n" + ."\n" + .'- NoSuchObject: The specified database does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'extraInfo' => '注：表支持的数据格式 '."\n" + .'创建表时用户必须指定数据格式，参数示例如下 '."\n" + .'**avro格式：** '."\n" + .' table.Parameters: {"classification":"avro"} '."\n" + .' table.Sd: '."\n" + .' "InputFormat":"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat" '."\n" + .' "OutputFormat":"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat" '."\n" + .' "SerdeInfo":{"SerializationLib":"org.apache.hadoop.hive.serde2.avro.AvroSerDe","Parameters":{"serialization.format":"1"}} '."\n" + .' **json格式:** '."\n" + .' table.Parameters:{"classification":"json"} '."\n" + .' table.Sd: '."\n" + .' "InputFormat":"org.apache.hadoop.mapred.TextInputFormat" '."\n" + .' "OutputFormat":"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat" '."\n" + .' "SerdeInfo":{"Parameters":{"paths":","},"SerializationLib":"org.apache.hive.hcatalog.data.JsonSerDe"} '."\n" + .' **xml格式** '."\n" + .' table.Parameters:{"classification":"json"} '."\n" + .' "InputFormat":"com.ibm.spss.hive.serde2.xml.XmlInputFormat" '."\n" + .' "OutputFormat":"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat", '."\n" + .' "SerdeInfo":{"Parameters":{"rowTag":""},"SerializationLib":"com.ibm.spss.hive.serde2.xml.XmlSerDe"} '."\n" + .' **parquet格式** '."\n" + .' table.Parameters:{"classification":"parquet"} '."\n" + .' "InputFormat":"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat" '."\n" + .' "OutputFormat":"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat" '."\n" + .' "SerdeInfo":{"Parameters":{"serialization.format":"1"},"SerializationLib":"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe"} '."\n" + .' **csv格式** '."\n" + .' table.Parameters:{"classification":"csv"} '."\n" + .' "InputFormat":"org.apache.hadoop.mapred.TextInputFormat", '."\n" + .' "OutputFormat":"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat", '."\n" + .' "SerdeInfo":{"Parameters":{"separatorChar":","},"SerializationLib":"org.apache.hadoop.hive.serde2.OpenCSVSerde"} '."\n" + .' 注意：separatorChar（分隔符）页面填的,比如“,” 逗号 '."\n" + .' **orc格式** '."\n" + .' table.Parameters:{"classification":"orc"} '."\n" + .' "InputFormat":"org.apache.hadoop.hive.ql.io.orc.OrcInputFormat", '."\n" + .' "OutputFormat":"org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat", '."\n" + .' "SerdeInfo":{"Parameters":{},"SerializationLib":"org.apache.hadoop.hive.ql.io.orc.OrcSerde"}', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTable'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteCatalog' => [ + 'summary' => 'Deletes a catalog.', + 'path' => '/api/metastore/catalogs', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => true, 'example' => 'catalog_test'], ], [ - 'name' => 'DatabaseName', + 'name' => 'IsAsync', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the deletion is asynchronous. By default, the operation is synchronous.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'TaskId' => ['description' => 'The ID of the asynchronous task to delete the catalog.', 'type' => 'string', 'title' => '', 'example' => 'c38206c3aca0c41332ffe49294243009'], + ], + 'example' => '', ], ], + '5XX' => [], + ], + 'title' => 'DeleteCatalog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCatalog'], + ], + ], + 'ramActions' => [ [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteDatabase' => [ + 'summary' => 'Deletes a database from a catalog.', + 'path' => '/api/metastore/catalogs/databases', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ [ - 'name' => 'ColumnNames', + 'name' => 'CatalogId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The names of the columns in the data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], + 'schema' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], + [ + 'name' => 'Cascade', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to perform a cascade delete. Valid values:'."\n" + ."\n" + .'- true: Deletes the tables in the database.'."\n" + ."\n" + .'- false: Does not delete the tables in the database. If the database contains tables, the operation fails.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to execute the operation asynchronously.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'ColumnStatisticsObjList' => [ - 'title' => 'ColumnStatisticsObjList', - 'description' => 'The list of column statistics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The column statistics.'."\n", - '$ref' => '#/components/schemas/ColumnStatisticsObj', - ], - 'example' => '[]', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true and'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code of the request.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '73201200-4C1A-4FEF-BD6B-C0DA7994FFA2'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'TaskId' => ['description' => 'The ID of the asynchronous task to delete the database.', 'type' => 'string', 'example' => 'c38206c3aca0c41332ffe49294243009', 'title' => ''], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', + 'title' => '', + 'description' => 'Response Object', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"ColumnStatisticsObjList\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"ColumnType\\": \\"\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"\\",\\n \\"StatisticsType\\": \\"\\"\\n }\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetTableColumnStatistics', - 'responseParamsDescription' => '* code: the error code.'."\n" - .'* message: the error message.'."\n" - .'* requestId: the unique ID of the current request.'."\n" - .'* Success:true/false to determine whether the request is successful. If true, then the ColumnStatisticsObjList has a value.'."\n", - ], - 'GetTableVersion' => [ - 'summary' => 'Gets a specified version of a data table in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/versions', - 'methods' => [ - 'get', + 'title' => 'DeleteDatabase', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- NoSuchObject: The specified database does not exist.'."\n" + ."\n" + .'- InvalidOperation: The database cannot be deleted because it contains tables or functions.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatabase'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"73201200-4C1A-4FEF-BD6B-C0DA7994FFA2\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteFunction' => [ + 'summary' => 'Deletes a user-defined function from a database in the data lake by name.', + 'path' => '/api/metastore/catalogs/databases/functions', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ - 'name' => 'TableName', + 'name' => 'FunctionName', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the function.', 'type' => 'string', 'required' => false, 'example' => 'func2'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Code', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'title' => 'DeleteFunction', + 'responseParamsDescription' => 'Error code descriptions:'."\n" + ."\n" + .'- NoSuchObject: The specified database, table, or function does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the value of the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunction'], + ], + ], + 'ramActions' => [ [ - 'name' => 'VersionId', - 'in' => 'query', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeletePartition' => [ + 'summary' => 'Deletes a specified partition from a table in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/delete', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Table Version', - 'description' => 'The version number of the data table.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The request body. The content must be in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'IfExists' => ['title' => '', 'description' => 'Specifies whether to ignore an exception if you try to delete a partition that does not exist. Valid values:'."\n" + ."\n" + .'- true: Ignores the exception and does not report an error.'."\n" + ."\n" + .'- false: Does not ignore the exception and reports an error.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'PartitionValues' => ['description' => 'The partition values.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201225'], + ], 'required' => false, - 'example' => '1', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableVersion' => [ - 'description' => 'The information about the data table of the specified version.'."\n", - 'example' => '{"VersionId":123,"Table":{}}', - '$ref' => '#/components/schemas/TableVersion', - ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\"\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetTableVersion', - 'responseParamsDescription' => 'Code: the error code.\\'."\n" - .'NoSuchObject: The specified metadata table does not exist.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'ListTableNames' => [ - 'summary' => 'This function is used only to query the names of data tables in Data Lake.', - 'path' => '/api/metastore/catalogs/databases/tables/names', - 'methods' => [ - 'get', + 'title' => 'DeletePartition', + 'responseParamsDescription' => 'Error codes for the Code parameter:'."\n" + ."\n" + .'- InvalidOperation: The specified table or partition does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePartition'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeletePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeletePartitionColumnStatistics' => [ + 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ - 'name' => 'TableNamePattern', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'TableNamePattern', - 'description' => 'The data table name matches the regular expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'NextPageToken', - 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\'\'', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000000', - 'minimum' => '-1', - 'example' => '10', - 'default' => '1000', - ], + 'schema' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], ], [ - 'name' => 'DatabaseName', + 'name' => 'PartitionNames', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'style' => 'json', + 'schema' => ['description' => 'A list of partition names.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'TableType', + 'name' => 'ColumnNames', 'in' => 'query', - 'schema' => [ - 'title' => 'TableType filter', - 'description' => 'The type of the data table. Valid values:'."\n" - ."\n" - .'MANAGED_TABLE: internal table'."\n" - ."\n" - .'EXTERNAL_TABLE: foreign table'."\n" - ."\n" - .'VIRTUAL_VIEW: virtual view'."\n" - ."\n" - .'INDEX_TABLE: index table'."\n" - ."\n" - .'MATERIALIZED_VIEW: materialized view.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MANAGED_TABLE', - ], + 'style' => 'json', + 'schema' => ['description' => 'A list of column names.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableNames' => [ - 'title' => 'TableNames', - 'description' => 'The names of the data tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'table1', - ], - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableNames\\": [\\n \\"table1\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListTableNames', - 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'ListTables' => [ - 'summary' => 'You can call this operation to obtain a list of data tables in the data lake.', - 'path' => '/api/metastore/databases/tables/list', - 'methods' => [ - 'get', + 'title' => 'DeletePartitionColumnStatistics', + 'summary' => 'Deletes the column statistics of a table partition in a data lake.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePartitionColumnStatistics'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeletePartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteRole' => [ + 'path' => '/api/metastore/auth/roles', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '114162', + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CatalogId', + 'name' => 'RoleName', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the role to delete.', 'type' => 'string', 'example' => 'roleId/roleName至少有一个是非空。', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], + ], + 'title' => 'DeleteRole', + 'summary' => 'Deletes a DLF role.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRole'], + ], + ], + 'ramActions' => [ [ - 'name' => 'TableNamePattern', - 'in' => 'query', - 'schema' => [ - 'title' => 'TableNamePattern', - 'description' => 'The name of the data table, which is matched by a regular expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:DeleteRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteTable' => [ + 'summary' => 'Deletes a data table from a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'NextPageToken', - 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\'\'', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000000', - 'minimum' => '-1', - 'example' => '10', - 'default' => '1000', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ - 'name' => 'TableType', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'title' => 'TableType filter', - 'description' => 'The type of the data table. Valid values:'."\n" - ."\n" - .'* MANAGED_TABLE: internal table'."\n" - .'* EXTERNAL_TABLE: foreign table'."\n" - .'* VIRTUAL_VIEW: virtual view'."\n" - .'* INDEX_TABLE: index table'."\n" - .'* MATERIALIZED_VIEW: materialized view.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MANAGED_TABLE', - ], + 'schema' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'RequestId' => [ - 'title' => ' RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tables' => [ - 'title' => 'Tables', - 'description' => 'The list of data tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about the data table.'."\n", - '$ref' => '#/components/schemas/Table', - ], - 'example' => '[{"TableName":"xx"}]', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"Tables\\": [\\n {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListTables', - 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'ListTableVersions' => [ - 'summary' => 'Queries the list of specified versions of data tables in a data lake by page.', - 'path' => '/api/metastore/catalogs/databases/tables/versions/list', - 'methods' => [ - 'get', + 'title' => 'DeleteTable', + 'responseParamsDescription' => 'Error codes for the Code parameter:'."\n" + ."\n" + .'- NoSuchObject: The specified data table does not exist.'."\n" + ."\n" + .'- InternalError: An unknown error occurred. For more information, see the value of the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTable'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteTableColumnStatistics' => [ + 'summary' => 'Deletes the column statistics of a table in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', - ], - ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\'\'', - ], + 'schema' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], ], [ - 'name' => 'PageSize', + 'name' => 'ColumnNames', 'in' => 'query', - 'schema' => [ - 'title' => 'max result of this query', - 'description' => 'The size of each page. The maximum value is 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'style' => 'json', + 'schema' => ['description' => 'A list of field names.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableVersions' => [ - 'title' => 'table versions', - 'description' => 'The data tables of multiple versions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data table of a specific version.'."\n", - 'example' => '{"table":{},"versionId":123}', - '$ref' => '#/components/schemas/TableVersion', - ], - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableVersions\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\"\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListTableVersions', - 'responseParamsDescription' => 'Code error code description:'."\n" + 'title' => 'DeleteTableColumnStatistics', + 'responseParamsDescription' => '- code: The error code.'."\n" ."\n" - .'* NoSuchObject: The specified data table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'GetTableProfile' => [ - 'summary' => 'Obtains the details of a table data profile.', - 'path' => '/webapi/metastorehouse/catalog/database/tableprofile', - 'methods' => [ - 'get', + .'- message: The error message.'."\n" + ."\n" + .'- requestId: The unique ID of the request.'."\n" + ."\n" + .'- Success: Indicates whether the request is successful. The value is true for success and false for failure.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTableColumnStatistics'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteTableColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteTableVersion' => [ + 'path' => '/api/metastore/catalogs/databases/tables/versions', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory. By default, the ID of the primary account is entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'exp_table', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the metadata table.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'admin_user', - ], + 'schema' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Response'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'None', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C742A04F-F304-5440-9ED8-AD58C36D1915', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableProfile' => [ - 'description' => 'The data profile of the table.'."\n", - '$ref' => '#/components/schemas/TableProfile', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Code', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"97434FA4-A6B2-1AE4-A174-76964F29C759\\",\\n \\"Success\\": true,\\n \\"TableProfile\\": {\\n \\"PartitionCnt\\": 3,\\n \\"FileCnt\\": 5,\\n \\"ObjectCnt\\": 5,\\n \\"FileSize\\": 31,\\n \\"ObjectSize\\": 31,\\n \\"RecordCnt\\": 0,\\n \\"IsPartitioned\\": true,\\n \\"LastModifyTime\\": \\"2023-08-16 18:02:25\\",\\n \\"LastAccessTime\\": \\"2023-08-22 12:14:42\\",\\n \\"DatabaseName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"CreateTime\\": \\"2023-08-14 10:44:13\\",\\n \\"Location\\": \\"oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/\\",\\n \\"AccessNum\\": 0,\\n \\"AccessNumWeekly\\": 0,\\n \\"AccessNumMonthly\\": 0,\\n \\"LastAccessNumTime\\": \\"\\",\\n \\"LatestDate\\": \\"2023-08-30 19:16:10\\",\\n \\"LatestAccessNumDate\\": \\"\\",\\n \\"LastDdlTime\\": \\"2023-08-16 18:02:24\\",\\n \\"ObjectAccessNum\\": 0,\\n \\"ObjectAccessNumWeekly\\": 18,\\n \\"ObjectAccessNumMonthly\\": 18,\\n \\"DataSourceType\\": \\"OSS_HDFS\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTableProfileResponse>\\n <TableProfile>\\n <ObjectCnt>5</ObjectCnt>\\n <AccessNum>0</AccessNum>\\n <ObjectAccessNumMonthly>18</ObjectAccessNumMonthly>\\n <ObjectAccessNumWeekly>0</ObjectAccessNumWeekly>\\n <LastDdlTime>2023-08-16 18:02:24</LastDdlTime>\\n <CreateTime>2023-08-14 10:44:13</CreateTime>\\n <ObjectSize>31</ObjectSize>\\n <DatabaseName>test_db</DatabaseName>\\n <FileCnt>2</FileCnt>\\n <LastModifyTime>2023-08-16 18:02:25</LastModifyTime>\\n <LastAccessTime>2023-08-22 12:14:42</LastAccessTime>\\n <LatestDate>2023-08-30 19:16:10</LatestDate>\\n <ObjectAccessNum>0</ObjectAccessNum>\\n <TableName>test_tbl</TableName>\\n <AccessNumMonthly>0</AccessNumMonthly>\\n <PartitionCnt>3</PartitionCnt>\\n <AccessNumWeekly>0</AccessNumWeekly>\\n <DataSourceType>OSS_HDFS</DataSourceType>\\n <FileSize>31</FileSize>\\n </TableProfile>\\n <RequestId>97434FA4-A6B2-1AE4-A174-76964F29C759</RequestId>\\n <Success>true</Success>\\n</GetTableProfileResponse>","errorExample":""}]', - 'title' => 'GetTableProfile', - 'description' => 'To use a data profile, you must first host the OSS bucket of the table.'."\n", - ], - 'RenameTable' => [ - 'summary' => 'is used only to update the name of a data table in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/rename', - 'methods' => [ - 'put', + 'title' => 'DeleteTableVersion', + 'summary' => 'Deletes a specified version of a table in the data lake.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTableVersion'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteTableVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeregisterLocation' => [ + 'summary' => 'Deregisters a location.', + 'path' => '/webapi/locations', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => [], + 'produces' => [], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'LocationId', + 'in' => 'query', + 'schema' => ['description' => 'The location ID.'."\n" + ."\n" + .'> Call the RegisterLocation operation to obtain the location ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LOC-AB8FBC17F95A4AF5', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The result of the deregistration.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'TableInput' => [ - 'description' => 'The data table object. You need only to specify the TableName parameter in this object.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TableInput', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], - 'IsAsync' => [ - 'title' => 'IsAsync', - 'description' => 'Specifies whether to asynchronously rename the data table. Valid values:'."\n" - ."\n" - .'* false (default): The operation is synchronously called. The update result is returned after the background task is complete. If the execution of the background task requires an extended period of time, a timeout occurs.'."\n" - .'* true: The operation is asynchronously called. The update result is immediately returned. You can query the task status by TaskId in the returned result.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E47920CD-BAE6-1305-88DF-FBDD3D300845'], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'LocationId' => ['description' => 'The location ID.', 'type' => 'string', 'example' => 'LOC-AB8FBC17F95A4AF5', 'title' => ''], + 'StorageCollectTaskOperationResultList' => [ + 'description' => 'The results for the shutdown of collection tasks.', + 'type' => 'array', + 'items' => ['description' => 'The result of the shutdown of a collection task.', '$ref' => '#/components/schemas/StorageCollectTaskOperationResult', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', + ], + ], + ], + 'title' => 'DeregisterLocation', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeregisterLocation'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeregisterLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E47920CD-BAE6-1305-88DF-FBDD3D300845\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": false,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeRegions' => [ + 'summary' => 'Retrieves a list of available regions.', + 'path' => '/webapi/service/describeRegions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86171', + 'abilityTreeNodes' => ['FEATUREdlfSKHNZC'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned result body.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TaskId' => [ - 'title' => 'Async task Id', - 'description' => 'The ID of the asynchronous task.'."\n", - 'type' => 'string', - 'example' => 'c38206c3aca0c41332ffe49294243009', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', 'title' => ''], + 'Regions' => [ + 'description' => 'The list of regions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The region information.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'region', 'title' => ''], + 'ShowName' => ['description' => 'The region display name.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''], + 'Name' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '华东1', 'title' => ''], + ], + 'example' => '{"Type":"region","Description":"华东 1","ShowName":"华东1（杭州）","Name":"cn-hangzhou"}', + 'title' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + ], + 'title' => 'DescribeRegions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:DescribeRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RenameTable', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* InvalidOperation: The corresponding database or table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Regions\\": [\\n {\\n \\"Type\\": \\"region\\",\\n \\"ShowName\\": \\"华东1（杭州）\\",\\n \\"Name\\": \\"cn-hangzhou\\",\\n \\"Description\\": \\"华东1\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'BatchGetTables' => [ - 'summary' => 'Obtain detailed information about data tables in the data lake in batches.', - 'path' => '/api/metastore/catalogs/databases/tables/batchget', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAsyncTaskStatus' => [ + 'summary' => 'Queries the status of an asynchronous task.', + 'path' => '/api/metastore/catalogs/tasks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", - 'type' => 'object', - 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'TableNames' => [ - 'description' => 'The name of the data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - ], - 'required' => false, - ], + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the asynchronous task. Obtain this ID from the result of the asynchronous operation.', 'type' => 'string', 'required' => false, 'example' => 'f546c761570e5efc8146a1986f7890d2'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableErrors' => [ - 'title' => 'TableErrors', - 'description' => 'The returned errors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned error.'."\n", - '$ref' => '#/components/schemas/TableError', - ], - ], - 'Tables' => [ - 'title' => 'Tables', - 'description' => 'The returned data tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data table.'."\n", - '$ref' => '#/components/schemas/Table', - ], - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'TaskStatus' => ['description' => 'The status of the task.', '$ref' => '#/components/schemas/TaskStatus', 'example' => 'Success', 'title' => ''], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchGetTables', - 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n" - .'NoSuchObject: The specified data table does not exist.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'BatchCreateTables' => [ - 'summary' => 'Add data tables to a data lake at a time.', - 'path' => '/api/metastore/catalogs/databases/tables/batchcreate', - 'methods' => [ - 'post', + 'title' => 'GetAsyncTaskStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncTaskStatus'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetAsyncTaskStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskStatus\\": {\\n \\"Status\\": \\"KILLED\\",\\n \\"Message\\": \\"successful\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetCatalog' => [ + 'summary' => 'Retrieves the details of a catalog.', + 'path' => '/api/metastore/catalogs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", - 'type' => 'object', - 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'IfNotExists' => [ - 'title' => 'IfNotExists', - 'description' => 'Specifies whether to ignore errors if the table name already exists.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TableInputs' => [ - 'title' => 'TableInputs', - 'description' => 'The list of data tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data table details.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TableInput', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => false, 'example' => 'catalog_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回结构', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应代码', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '响应消息', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableErrors' => [ - 'title' => '表出错信息', - 'description' => 'The list of errors occurred when you created the data table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The error occurred when you created the data table.'."\n", - '$ref' => '#/components/schemas/TableError', - ], - 'example' => '["ErrorDetail":{},"TableName":"test"]', - ], + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Catalog' => ['description' => 'The details of the catalog.', '$ref' => '#/components/schemas/Catalog', 'example' => '参考Catalog实体', 'title' => ''], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + '5XX' => [], + ], + 'title' => 'GetCatalog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCatalog'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchCreateTables', - 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n" - .'InvalidObject:name/partition/column/skewCol does not pass the verification.\\'."\n" - .'AlreadyExists: The metadata table already exists.\\'."\n" - .'NoSuchObject: The specified metadatabase does not exist.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85\\",\\n \\"Success\\": true,\\n \\"Catalog\\": {\\n \\"CatalogId\\": \\"1344371\\",\\n \\"Description\\": \\"测试\\",\\n \\"LocationUri\\": \\"oss://dlf-test-oss-location/\\",\\n \\"Owner\\": \\"acs:ram::[accountId]:root\\",\\n \\"CreatedBy\\": \\"acs:ram::[accountId]:root\\\\n\\",\\n \\"CreateTime\\": 1640662815,\\n \\"UpdateTime\\": 1640662815,\\n \\"Status\\": \\"CREATED\\",\\n \\"CatalogType\\": \\"HMS\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'BatchDeleteTables' => [ - 'summary' => 'Deletes multiple data tables in a data lake by name.', - 'path' => '/api/metastore/catalogs/databases/tables/batchdelete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCatalogSettings' => [ + 'summary' => 'Retrieves the configuration of a catalog. This operation requires the admin role or a higher role.', + 'path' => '/api/metastore/catalogs/settings', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, which is in the JSON format.'."\n", - 'type' => 'object', - 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'IfExists' => [ - 'title' => 'IfExists', - 'description' => 'Specifies whether to ignore errors if the partition with the specified name has been deleted.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TableNames' => [ - 'title' => 'TableName', - 'description' => 'The list of data table names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableErrors' => [ - 'title' => 'PartitionErrors', - 'description' => 'The collection of error messages.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The error message.'."\n", - '$ref' => '#/components/schemas/TableError', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'CatalogSettings' => ['description' => 'The data lake configurations.', '$ref' => '#/components/schemas/CatalogSettings', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + ], + 'title' => 'GetCatalogSettings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCatalogSettings'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetCatalogSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchDeleteTables', - 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n" - .'NoSuchObject: The specified data table does not exist.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"CatalogSettings\\": {\\n \\"Config\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"auth.permission.check.enable\\\\\\":\\\\n\\\\\\"true\\\\\\",\\\\n\\\\\\"auth.super.principal\\\\\\":\\\\n\\\\\\"acs:ram::[aliyunAccountId]:role/aliyundlfworkflowdefaultrole\\\\\\"\\\\n}\\"\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'BatchDeleteTableVersions' => [ - 'summary' => 'Deletes a specified version of a data table in a data lake at a time.', - 'path' => '/api/metastore/catalogs/databases/tables/versions/batchdelete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDatabase' => [ + 'summary' => 'Retrieves the details of a specific database in a data lake.', + 'path' => '/api/metastore/catalogs/databases', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, which is in the JSON format.'."\n", - 'type' => 'object', - 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', - ], - 'VersionIds' => [ - 'title' => 'Table versionIds', - 'description' => 'The list of version numbers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The version number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Database' => ['description' => 'The database object.', '$ref' => '#/components/schemas/Database', 'example' => '{"name":"test"}', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D659761F-29C3-409D-805A-0CF33A320128'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', + 'title' => '', + 'description' => 'Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchDeleteTableVersions', - 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n" - .'NoSuchObject: The specified data table does not exist.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'BatchUpdateTables' => [ - 'summary' => 'Update the details of data tables in the data lake in batches.', - 'path' => '/api/metastore/catalogs/databases/tables/batchupdate', - 'methods' => [ - 'post', + 'title' => 'GetDatabase', + 'responseParamsDescription' => 'Error codes for Code:'."\n" + ."\n" + .'- NoSuchObject: The specified database does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the value of Message.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabase'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Database\\": {\\n \\"CreateTime\\": 1608707407,\\n \\"Description\\": \\"this is a hive database\\",\\n \\"LocationUri\\": \\"/hdfs/hivedb/data\\",\\n \\"Name\\": \\"database_test\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"root\\"\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"D659761F-29C3-409D-805A-0CF33A320128\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetDatabaseProfile' => [ + 'summary' => 'Retrieves the database profile.', + 'path' => '/webapi/metastorehouse/catalog/database/databaseprofile', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'."\n"], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test_db'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'TableInputs' => [ - 'title' => 'TableInputs', - 'description' => 'The details about the updated data table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about the updated data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/TableInput', - ], - 'required' => false, - ], - 'IsAsync' => [ - 'title' => '是否异步', - 'description' => 'Specifies whether to asynchronously update the data table. Valid values:'."\n" - ."\n" - .'* true: The operation is asynchronously called. The update result is immediately returned. You can query the task status by taskid in the returned results.'."\n" - .'* false: The operation is synchronously called. The update result is returned after the background task is complete. If the execution of the background task requires an extended period of time, a timeout occurs.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '-'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '-'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'DatabaseProfile' => ['description' => 'The database profile.', '$ref' => '#/components/schemas/DatabaseProfile', 'example' => '{'."\n" + .' "FileCnt": 213,'."\n" + .' "FileSize": 34324'."\n" + .'}', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], ], + 'title' => 'GetDatabaseProfile', + 'description' => 'To use the data profile, first register the location of the OSS bucket for the database.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabaseProfile'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetDatabaseProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB\\",\\n \\"Success\\": true,\\n \\"DatabaseProfile\\": {\\n \\"FileCnt\\": 3234,\\n \\"FileSize\\": 1254312,\\n \\"Name\\": \\"test_db\\",\\n \\"CreateTime\\": \\"2023-08-16 18:02:22\\",\\n \\"Location\\": \\"oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/\\",\\n \\"ObjectSize\\": 1254312,\\n \\"ObjectCnt\\": 3234,\\n \\"LatestDate\\": \\"2023-08-30 19:16:10\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetFunction' => [ + 'path' => '/api/metastore/catalogs/databases/functions', + 'methods' => ['get'], + 'schemes' => ['http', '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' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the user-defined function.', 'type' => 'string', 'required' => false, 'example' => 'func2'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回结构', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应代码', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '响应消息', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TableErrors' => [ - 'title' => '表出错信息', - 'description' => 'The returned errors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned error.'."\n", - '$ref' => '#/components/schemas/TableError', - ], - 'example' => '{"ErrorDetails":{},"TableName":"test"}', - ], - 'TaskId' => [ - 'title' => '异步更新 taskId', - 'description' => 'The ID of the asynchronous update task.'."\n", - 'type' => 'string', - 'example' => 'f8deec55f54ac566e7ec8944fbe01588', - ], + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Function' => ['description' => 'The details of the function.', '$ref' => '#/components/schemas/Function', 'example' => '{"FunctionName":test}', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => 'error'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '返回结果', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ],\\n \\"TaskId\\": \\"f8deec55f54ac566e7ec8944fbe01588\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchUpdateTables', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* InvalidOperation: The input data table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'CreatePartition' => [ - 'summary' => 'Add a partition to the data table of the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions', - 'methods' => [ - 'post', + 'title' => 'GetFunction', + 'summary' => 'Retrieves a user-defined function from a database in a data lake.', + 'responseParamsDescription' => 'Error codes for the Code parameter:<br>'."\n" + .'InternalError: See the Message parameter for details.<br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunction'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Function\\": {\\n \\"CatalogId\\": \\"1344371\\",\\n \\"ClassName\\": \\"com.xxx.xxxxFunction\\",\\n \\"CreateTime\\": 1608863962,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"FunctionName\\": \\"function1\\",\\n \\"FunctionType\\": \\"JAVA\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"ResourceUri\\": [\\n {\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Uri\\": \\"hdfs:///tmp/jar1.jar\\"\\n }\\n ],\\n \\"UpdateTime\\": 1608863962,\\n \\"CreatedBy\\": \\"CreatedBy\\"\\n },\\n \\"Message\\": \\"error\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetLifecycleRule' => [ + 'summary' => 'Retrieves the lifecycle rule of a table.', + 'path' => '/webapi/metastorehouse/lifecycle/rule/getLifecycleRule', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'ResourceName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The fully qualified table name.', 'type' => 'string', 'required' => false, 'example' => 'demo_catalog_id.demo_db_name.demo_table_name'], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => ['description' => 'The business ID.', 'type' => 'string', 'required' => false, 'example' => 'LCRU-17E7192705C365C0', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'IfNotExists' => [ - 'title' => 'IfNotExists', - 'description' => 'Specifies whether to ignore errors if the name of the partition to be created already exists.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'NeedResult' => [ - 'title' => 'NeedResult', - 'description' => 'Specifies whether to return partition information. If this parameter is set to true, the Partition parameter is returned.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'PartitionInput' => [ - 'description' => 'The information about the partition to be created.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/PartitionInput', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBC848F-7CC7-52E3-9FBF-924D09B5C27A'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'True'], + 'Data' => ['description' => 'The lifecycle rule.', '$ref' => '#/components/schemas/LifecycleRule', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'GetLifecycleRule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLifecycleRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetLifecycleRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBC848F-7CC7-52E3-9FBF-924D09B5C27A\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BizId\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ResourceType\\": \\"\\",\\n \\"BindCount\\": 0,\\n \\"Description\\": \\"\\",\\n \\"RuleType\\": \\"\\",\\n \\"Config\\": \\"\\",\\n \\"IaDays\\": 0,\\n \\"ArchiveDays\\": 0,\\n \\"ColdArchiveDays\\": 0,\\n \\"ScheduleStatus\\": \\"\\",\\n \\"Workflow\\": {\\n \\"LatestInstanceId\\": \\"\\",\\n \\"LatestInstanceStatus\\": \\"\\",\\n \\"LatestStartTime\\": \\"\\",\\n \\"LatestEndTime\\": \\"\\"\\n },\\n \\"WorkflowId\\": \\"\\",\\n \\"WorkflowInstance\\": {\\n \\"DlfWorkflowId\\": \\"\\",\\n \\"ExternalInstanceId\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"RuntimeLogs\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"InstanceId\\": \\"\\",\\n \\"BizTime\\": \\"\\",\\n \\"LogType\\": \\"\\",\\n \\"LogId\\": \\"\\",\\n \\"LogSummary\\": \\"\\",\\n \\"LogContent\\": \\"\\"\\n }\\n ],\\n \\"BatchProgress\\": 0\\n },\\n \\"CatalogId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetLock' => [ + 'summary' => 'Queries a specified metadata lock.', + 'path' => '/api/metastore/catalogs/databases/tables/locks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'LockId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the lock.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16533'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Partition' => [ - 'description' => 'The partition information. This parameter is returned if the NeedResult parameter is set to true.'."\n", - '$ref' => '#/components/schemas/Partition', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'], + 'LockStatus' => ['description' => 'The status information of the lock.', '$ref' => '#/components/schemas/LockStatus', 'example' => '{"lockId":123,"lockStatus":"Acquired"}', 'title' => ''], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Partition\\": {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n },\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreatePartition', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* InvalidObject: The corresponding database or table cannot be found.'."\n" - .'* AlreadyExists: The corresponding partition already exists.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'DeletePartition' => [ - 'summary' => 'Deletes a specified partition from a data table in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/delete', - 'methods' => [ - 'post', + 'title' => 'GetLock', + 'requestParamsDescription' => 'The ID of the lock. This is the LockId returned by the CreateLock operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLock'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Success\\": true,\\n \\"LockStatus\\": {\\n \\"LockId\\": 1,\\n \\"LockState\\": \\"ACQUIRED\\"\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetPartition' => [ + 'path' => '/api/metastore/catalogs/databases/tables/partitions/get', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -7907,830 +5599,936 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The HTTP request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'IfExists' => [ - 'title' => 'IfExists', - 'description' => 'Specifies whether to ignore errors if the partition that you want to delete does not exist. Valid values:'."\n" - ."\n" - .'* true: ignores errors and no error will be reported.'."\n" - .'* false: does not ignore errors and errors will be reported.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'PartitionValues' => [ - 'description' => 'The values of the partition key columns.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201225', - ], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'PartitionValues' => ['description' => 'The list of partition values.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Partition' => ['description' => 'The details of the partition.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeletePartition', - 'responseParamsDescription' => 'Code error code description:'."\n" + 'title' => 'GetPartition', + 'summary' => 'Retrieves the details of a database partition in a data lake.', + 'responseParamsDescription' => 'Error codes:'."\n" ."\n" - .'* InvalidOperation: The corresponding data table or partition does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'DeletePartitionColumnStatistics' => [ - 'summary' => 'Reclaim the field statistics of data table partitions in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics', - 'methods' => [ - 'delete', + .'- NoSuchObject: The specified database, table, or partition does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the message in the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPartition'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetPartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Partition\\": {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n },\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetPartitionColumnStatistics' => [ + 'summary' => 'Retrieves statistics for specified columns in a data partition of a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], + 'schema' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], ], [ 'name' => 'PartitionNames', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The names of the partitions.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], + 'schema' => ['description' => 'The list of partitions in the data table.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'ColumnNames', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The key columns of the partitions.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], + 'schema' => ['description' => 'The list of columns in the data table.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'PartitionStatisticsMap' => [ + 'title' => '', + 'description' => 'The statistics of the partitions.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'The statistics of a partition.', '$ref' => '#/components/schemas/ColumnStatisticsObj', 'title' => '', 'example' => ''], + 'description' => 'The list of partition statistics.', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeletePartitionColumnStatistics', - ], - 'UpdatePartitionColumnStatistics' => [ - 'summary' => 'Creates or updates the field statistics of a data table partition.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics', - 'methods' => [ - 'put', + 'title' => 'GetPartitionColumnStatistics', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPartitionColumnStatistics'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetPartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"PartitionStatisticsMap\\": {\\n \\"key\\": [\\n {\\n \\"ColumnName\\": \\"col1\\",\\n \\"ColumnType\\": \\"int\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"{\\\\\\"numNulls\\\\\\":0,\\\\\\"numTrues\\\\\\":1,\\\\\\"numFalses\\\\\\":5}\\",\\n \\"StatisticsType\\": \\"BOOLEAN_STATS\\"\\n }\\n }\\n ]\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetQueryResult' => [ + 'path' => '/webapi/query/getQueryResult', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'UpdateTablePartitionColumnStatisticsRequest', - 'in' => 'body', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The request to update partition column statistics in the data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/UpdateTablePartitionColumnStatisticsRequest', - ], + 'name' => 'QueryId', + 'in' => 'query', + 'schema' => ['description' => 'The query ID.'."\n" + ."\n" + .'> Call the SubmitQuery operation to obtain the query ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Q-41676378709440CE', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'object', - 'description' => 'Returns the message body.'."\n", + 'description' => 'The query results.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", + 'Status' => [ + 'description' => 'The query status.', + 'enumValueTitles' => ['AVAILABLE' => 'Available', 'CANCELLED' => 'Canceled', 'RUNNING' => 'Running', 'CANCELLING' => 'Canceling', 'WAITING' => 'Waiting', 'ERROR' => 'Error'], 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'example' => 'AVAILABLE', + 'title' => '', + ], + 'ResultTmpTable' => ['description' => 'The temporary table for the results. This parameter is not in use.', 'type' => 'string', 'example' => 'table', 'title' => ''], + 'Owner' => ['description' => 'The UID of the Alibaba Cloud account that created the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '229167306180609***', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message for the query.', 'type' => 'string', 'example' => 'Table or view not found:', 'title' => ''], + 'Progress' => ['description' => 'The query progress. The value is between 0 and 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '99', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Schema' => ['description' => 'The fields and types in the table header of the query result. This parameter is returned only when the status is AVAILABLE.', 'type' => 'string', 'example' => '[{"name":"id","type":"INT"},{"name":"student_name","type":"VARCHAR"}]', 'title' => ''], + 'ResultTmpDb' => ['description' => 'The temporary database for the results. This parameter is not in use.', 'type' => 'string', 'example' => 'db'."\n", 'title' => ''], + 'GmtModified' => ['description' => 'The time when the query result was updated.', 'type' => 'string', 'example' => '2022-05-09 16:19:09', 'title' => ''], + 'JobCompleted' => ['description' => 'Indicates whether the query is complete. A value of false means you need to continue polling this operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RowCount' => ['description' => 'The total number of rows in the result. This parameter is returned only when the status is AVAILABLE.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'EndTime' => ['description' => 'The time when the query was completed.', 'type' => 'string', 'example' => '2022-05-09 16:19:09', 'title' => ''], + 'StartTime' => ['description' => 'The time when the query started.', 'type' => 'string', 'example' => '2022-05-09 16:18:09', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1D2BCFBA-7639-59A9-817B-944EC1339279', 'title' => ''], + 'Rows' => ['description' => 'The result information. This parameter is returned only when the status is AVAILABLE. The content is represented by a two-dimensional JSON array.', 'type' => 'string', 'example' => '[[10,"Tom"],[11,"Jerry"]]', 'title' => ''], + 'Logs' => ['description' => 'The operational logs.', 'type' => 'string', 'example' => '["this is log"]', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the query was created.', 'type' => 'string', 'example' => '2022-05-09 16:18:09', 'title' => ''], + 'Duration' => ['description' => 'The runtime duration in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '8000', 'title' => ''], + 'Sql' => ['description' => 'The original SQL statement that was executed.', 'type' => 'string', 'example' => 'select * from db.student', 'title' => ''], + 'RowCountOverLimit' => ['description' => 'Indicates whether the total number of rows in the result exceeds the maximum value.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Id' => ['description' => 'The query ID.', 'type' => 'string', 'example' => 'Q-41676378709440CE'."\n", 'title' => ''], + 'TotalBytesProcessed' => ['description' => 'The total volume of data scanned, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], ], + 'example' => '{ "data" : }', + 'title' => '', ], ], - '5XX' => [ + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Query.ResultExpired', 'errorMessage' => 'Query result cache expired, please export result in history query', 'description' => ''], + ], + ], + 'title' => 'GetQueryResult', + 'summary' => 'Retrieves query results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetQueryResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"ResultTmpTable\\": \\"table\\",\\n \\"Owner\\": 0,\\n \\"ErrorMessage\\": \\"Table or view not found:\\",\\n \\"Progress\\": 99,\\n \\"Success\\": true,\\n \\"Schema\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"type\\\\\\":\\\\\\"INT\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"student_name\\\\\\",\\\\\\"type\\\\\\":\\\\\\"VARCHAR\\\\\\"}]\\",\\n \\"ResultTmpDb\\": \\"db\\\\n\\",\\n \\"GmtModified\\": \\"2022-05-09 16:19:09\\",\\n \\"JobCompleted\\": true,\\n \\"RowCount\\": 100,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EndTime\\": \\"2022-05-09 16:19:09\\",\\n \\"StartTime\\": \\"2022-05-09 16:18:09\\",\\n \\"RequestId\\": \\"1D2BCFBA-7639-59A9-817B-944EC1339279\\",\\n \\"Rows\\": \\"[[10,\\\\\\"Tom\\\\\\"],[11,\\\\\\"Jerry\\\\\\"]]\\",\\n \\"Logs\\": \\"[\\\\\\"this is log\\\\\\"]\\",\\n \\"GmtCreate\\": \\"2022-05-09 16:18:09\\",\\n \\"Duration\\": 8000,\\n \\"Sql\\": \\"select * from db.student\\",\\n \\"RowCountOverLimit\\": false,\\n \\"Id\\": \\"Q-41676378709440CE\\\\n\\",\\n \\"TotalBytesProcessed\\": 1024\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetRegionStatus' => [ + 'path' => '/webapi/service/getRegionStatus', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CC58A776-0662-5C6D-B467-FFD4CF7F4C40', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'IsDlfServiceOpen' => ['description' => 'Indicates whether DLF is activated in the region.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'RegionStatus' => ['description' => 'The DLF activation status in the region. Valid values: `SERVICE_INVALID`: The service is unavailable. `UNINITIALIZED`: The service is not initialized. `READY`: The service is running as normal.', 'type' => 'string', 'example' => 'READY', 'title' => ''], + 'AccountStatus' => ['description' => 'The account status. Valid values: `enabled` and `disabled`.', 'type' => 'string', 'example' => 'enabled', 'title' => ''], + 'IsDependencyReady' => ['description' => 'Indicates whether dependencies are ready.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn_hangzhou', 'title' => ''], + ], + 'example' => '{\'RegionId\': \'cn-shanghai\', \'RegionStatus\': \'SERVICE_INVALID\', \'AccountStatus\': \'\', \'IsDlfServiceOpen\': False}', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdatePartitionColumnStatistics', - ], - 'GetPartition' => [ - 'summary' => 'Get details about the database partitions in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/get', - 'methods' => [ - 'post', + 'errorCodes' => [], + 'title' => 'GetRegionStatus', + 'summary' => 'Retrieves the DLF activation status in a region.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetRegionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": \\"true\\",\\n \\"RequestId\\": \\"CC58A776-0662-5C6D-B467-FFD4CF7F4C40\\",\\n \\"Data\\": {\\n \\"IsDlfServiceOpen\\": true,\\n \\"RegionStatus\\": \\"READY\\",\\n \\"AccountStatus\\": \\"enabled\\",\\n \\"IsDependencyReady\\": true,\\n \\"RegionId\\": \\"cn_hangzhou\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetRole' => [ + 'path' => '/api/metastore/auth/roles', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the role.', 'type' => 'string', 'required' => false, 'example' => 'role_name'], ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4316D7DA-9816-596D-A3D7-12676FA59BDA'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'Role' => ['title' => '', 'description' => 'The details about the role.', '$ref' => '#/components/schemas/Role', 'example' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'GetRole', + 'summary' => 'Retrieves a DLF role by its name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRole'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4316D7DA-9816-596D-A3D7-12676FA59BDA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"Role\\": {\\n \\"Name\\": \\"role_name\\",\\n \\"Description\\": \\"role description\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"acs:dlf::111:role/role_name\\",\\n \\"CreateTime\\": 1647323053,\\n \\"UpdateTime\\": 1647323053,\\n \\"IsPredefined\\": 1\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetServiceStatus' => [ + 'path' => '/webapi/service/getServiceStatus', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body.'."\n", 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'PartitionValues' => [ - 'description' => 'The partitions.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', 'title' => ''], + 'Data' => [ + 'description' => 'The service status.', + 'type' => 'object', + 'properties' => [ + 'IsDlfServiceOpen' => ['description' => 'Indicates whether DLF is activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HasRamPermissions' => ['description' => 'Indicates whether RAM authorization is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IsOssOpen' => ['description' => 'Indicates whether OSS is activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '{ "AccountStatus":"", "RegionStatus":"READY", "RegionId":"cn-shanghai", "IsDependencyReady":true, "IsDlfServiceOpen":true }', + 'title' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'errorCodes' => [], + 'title' => 'GetServiceStatus', + 'summary' => 'Retrieves the DLF activation status for a user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetServiceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Data\\": {\\n \\"IsDlfServiceOpen\\": true,\\n \\"HasRamPermissions\\": true,\\n \\"IsOssOpen\\": true\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetTable' => [ + 'summary' => 'Retrieves the details of a table in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables', + 'methods' => ['get'], + 'schemes' => ['http', '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' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Partition' => [ - 'description' => 'The partition details.'."\n", - '$ref' => '#/components/schemas/Partition', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'Table' => ['description' => 'The details of the table.', '$ref' => '#/components/schemas/Table', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Partition\\": {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n },\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetPartition', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database, table, or partition does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'GetPartitionColumnStatistics' => [ - 'summary' => 'Obtains the statistics of a specified field for a data partition in a data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics', - 'methods' => [ - 'get', + 'title' => 'GetTable', + 'responseParamsDescription' => 'Code: The error code.<br>'."\n" + .'NoSuchObject: The specified metadata table does not exist.<br>'."\n" + .'InternalError: An internal error occurred. See the Message field for details.<br><br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTable'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetTableColumnStatistics' => [ + 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], - ], - [ - 'name' => 'PartitionNames', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The names of the partitions in the data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], + 'schema' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], ], [ 'name' => 'ColumnNames', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'description' => 'The names of the fields in the data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], + 'schema' => ['description' => 'A list of table columns.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'PartitionStatisticsMap' => [ - 'title' => 'PartitionStatisticsMap', - 'description' => 'The partition statistics.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/ColumnStatisticsObj', - 'description' => 'The partition statistics.'."\n", - ], - 'description' => 'The list of partition statistics.'."\n", - ], - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'ColumnStatisticsObjList' => [ + 'title' => '', + 'description' => 'A list of column statistics.', + 'type' => 'array', + 'items' => ['description' => 'The column statistics.', '$ref' => '#/components/schemas/ColumnStatisticsObj', 'title' => '', 'example' => ''], + 'example' => '[]', ], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"PartitionStatisticsMap\\": {\\n \\"key\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"ColumnType\\": \\"\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"\\",\\n \\"StatisticsType\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetPartitionColumnStatistics', - ], - 'ListPartitionNames' => [ - 'summary' => 'You can call this operation to obtain a list of partition names of data tables in a data lake. This method is usually used for multi-level partitioning.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/names', - 'methods' => [ - 'post', + 'title' => 'GetTableColumnStatistics', + 'summary' => 'Retrieves statistics for specified columns in a data lake table.', + 'responseParamsDescription' => '- code: The error code.'."\n" + ."\n" + .'- message: The error message.'."\n" + ."\n" + .'- requestId: The unique ID of the request.'."\n" + ."\n" + .'- Success: Indicates whether the request was successful. If the value is true, the requested data is returned in the ColumnStatisticsObjList parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableColumnStatistics'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"ColumnStatisticsObjList\\": [\\n {\\n \\"ColumnName\\": \\"col1\\",\\n \\"ColumnType\\": \\"int\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"{\\\\\\"numNulls\\\\\\":0,\\\\\\"numTrues\\\\\\":1,\\\\\\"numFalses\\\\\\":5}\\",\\n \\"StatisticsType\\": \\"BOOLEAN_STATS\\"\\n }\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetTableProfile' => [ + 'summary' => 'Retrieves the details of a table\'s data profile.', + 'path' => '/webapi/metastorehouse/catalog/database/tableprofile', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test_db'], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'example' => 'test_tbl'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body.'."\n", + 'title' => '', + 'description' => 'Response.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The pagination token. The token is obtained in the returned results. If no pagination token is returned, set this parameter to an empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'PageSize' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Maximum value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'PartialPartValues' => [ - 'description' => 'The values of the partition key columns. You can pass in only the values of specific partition key columns to query the names of all lower-level partitions.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', - ], + 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '-'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '-'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '97434FA4-A6B2-1AE4-A174-76964F29C759'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'TableProfile' => ['description' => 'The data profile of the table.', '$ref' => '#/components/schemas/TableProfile', 'title' => '', 'example' => ''], ], - 'required' => false, + 'example' => '', ], ], ], + 'title' => 'GetTableProfile', + 'description' => 'To use data profiles, you must first host the table\'s OSS bucket on DLF.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableProfile'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"97434FA4-A6B2-1AE4-A174-76964F29C759\\",\\n \\"Success\\": true,\\n \\"TableProfile\\": {\\n \\"PartitionCnt\\": 3,\\n \\"FileCnt\\": 5,\\n \\"ObjectCnt\\": 5,\\n \\"FileSize\\": 31,\\n \\"ObjectSize\\": 31,\\n \\"RecordCnt\\": 2,\\n \\"IsPartitioned\\": true,\\n \\"LastModifyTime\\": \\"2023-08-16 18:02:25\\",\\n \\"LastAccessTime\\": \\"2023-08-22 12:14:42\\",\\n \\"DatabaseName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"CreateTime\\": \\"2023-08-14 10:44:13\\",\\n \\"Location\\": \\"oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/\\",\\n \\"AccessNum\\": 0,\\n \\"AccessNumWeekly\\": 0,\\n \\"AccessNumMonthly\\": 0,\\n \\"LastAccessNumTime\\": \\"\\",\\n \\"LatestDate\\": \\"2023-08-30 19:16:10\\",\\n \\"LatestAccessNumDate\\": \\"\\",\\n \\"LastDdlTime\\": \\"2023-08-16 18:02:24\\",\\n \\"ObjectAccessNum\\": 0,\\n \\"ObjectAccessNumWeekly\\": 18,\\n \\"ObjectAccessNumMonthly\\": 18,\\n \\"DataSourceType\\": \\"OSS_HDFS\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetTableVersion' => [ + 'path' => '/api/metastore/catalogs/databases/tables/versions', + 'methods' => ['get'], + 'schemes' => ['http', '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' => 'query', + 'schema' => ['title' => '', 'description' => 'The catalog ID .', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The version number of the table.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'code', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'PartitionNames' => [ - 'title' => 'PartitionNames', - 'description' => 'The list of partition names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the partition.'."\n", - 'type' => 'string', - 'example' => 'ds=20201124/hour=10', - ], - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'TableVersion' => ['description' => 'The table with version information.', '$ref' => '#/components/schemas/TableVersion', 'example' => '{"VersionId":123,"Table":{}}', 'title' => ''], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'code', - 'description' => 'code', + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'code', - 'description' => 'code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"PartitionNames\\": [\\n \\"ds=20201124/hour=10\\"\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListPartitionNames', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database or table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'ListPartitions' => [ - 'summary' => 'Obtains a list of database partition details in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/list', - 'methods' => [ - 'post', + 'title' => 'GetTableVersion', + 'summary' => 'Retrieves a specific version of a table.', + 'responseParamsDescription' => 'Code: The error code.<br>NoSuchObject: The specified metadata table does not exist.<br>InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableVersion'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\"\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GrantPermissions' => [ + 'summary' => 'Grants permissions on resources to DLF users and roles.', + 'path' => '/api/metastore/auth/permissions/grant', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -8738,996 +6536,693 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body.'."\n", + 'description' => 'The HTTP request body, in the JSON format.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The pagination token. The token is obtained in the return results. If no pagination token is returned, set this parameter to an empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'PageSize' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Maximum value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'PartialPartValues' => [ - 'description' => 'The list of partition values. You can pass in only the values of specific partitions to query the names of all lower-level partitions.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", + 'Type' => [ + 'description' => 'The authorization type. Only Hive is supported.', 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', - ], - 'IsShareSd' => [ - 'title' => 'IsShareSd', - 'description' => 'Specifies whether to share the column information of SD in the partition. Valid values:'."\n" - ."\n" - .'* true: The column information of SD in the partition is shared. In this case, only one copy of data is returned for columns with the same name. This reduces the volume of transferred data and improves the performance of this API operation.'."\n" - .'* false: The column information of SD in the partition is not shared.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'true', + 'required' => true, + 'enum' => ['hive'], + 'title' => '', + 'example' => 'Hive', ], + 'MetaResource' => ['description' => 'The metadata resource to grant permissions.', 'required' => true, '$ref' => '#/components/schemas/MetaResource', 'title' => '', 'example' => ''], + 'Accesses' => ['description' => 'The access permissions to grant.', 'required' => true, '$ref' => '#/components/schemas/Accesses', 'title' => '', 'example' => ''], + 'DelegateAccesses' => ['description' => 'The grantable access permissions.', 'required' => true, '$ref' => '#/components/schemas/Accesses', 'title' => '', 'example' => ''], + 'Principal' => ['description' => 'The user or role to which permissions are granted. The format is as follows:'."\n" + ."\n" + .'- RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" + ."\n" + .'- RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n" + ."\n" + .'- Data lake role: acs:dlf::\\[accountId]:role/\\[roleName].', 'required' => true, '$ref' => '#/components/schemas/Principal', 'title' => '', 'example' => ''], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => false, 'example' => '主账号ID或空字符串'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'code', - 'description' => 'The returned result body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'Partitions' => [ - 'title' => 'Partitions', - 'description' => 'The list of partitions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about the partition.'."\n", - '$ref' => '#/components/schemas/Partition', - ], - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PartitionSpecs' => [ - 'title' => 'PartitionSpecs', - 'description' => 'The list of partition specifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The partition specification.'."\n", - '$ref' => '#/components/schemas/PartitionSpec', - ], - ], + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4912024D-2A06-5E9F-9667-35D9319917D7'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + '5XX' => [], + ], + 'title' => 'GrantPermissions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantPermissions'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:GrantPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListPartitions', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database or table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"4912024D-2A06-5E9F-9667-35D9319917D7\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListPartitionsByFilter' => [ - 'summary' => 'Obtain the list of data table partitions in the data lake and query them by filter condition.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/listbyfilter', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GrantRoleToUsers' => [ + 'summary' => 'Grants a DLF role to multiple users.', + 'path' => '/api/metastore/auth/roles/grantusers', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '114170', + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Body', + 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body.'."\n", + 'title' => '', + 'description' => 'The HTTP request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'Filter' => [ - 'title' => 'Filter', - 'description' => 'The expression of the query condition. The following operators are supported:'."\n" - ."\n" - .'* Comparison operators: =, <>, ! =, <, <=, >, >=. For example: ds > 20240101.'."\n" - .'* Logical operators: AND, OR, and NOT. Example: ds like \'20240%\'.'."\n" - .'* BETWEEN operator: specifies a range. For example: ds BETWEEN 20240101 AND 20241201.'."\n" - .'* IN operator: Used to specify a specific set of values. Example: ds IN (20240101, 20240102).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ds>20201201', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\'\'', - ], - 'PageSize' => [ - 'title' => 'PageSize', - 'description' => 'The size of each page. The maximum size is 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'Indicates the name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', - ], - 'IsShareSd' => [ - 'title' => 'IsShareSd', - 'description' => 'Specifies whether to share the column information in the SD of the partition. Valid values:'."\n" - ."\n" - .'* true: shared'."\n" - .'* false: does not share the data.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'RoleName' => ['title' => '', 'description' => 'The role name.', 'type' => 'string', 'required' => false, 'example' => 'test_role_8'], + 'Users' => ['description' => 'The principal to grant permissions. The format is as follows:'."\n" + ."\n" + .'- RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" + ."\n" + .'- RAM role: acs:ram::\\[accountId]:role/\\[roleName].', '$ref' => '#/components/schemas/Principals', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'code', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'Partitions' => [ - 'title' => 'Partitions', - 'description' => 'The details about the partitions that are queried based on the filter condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about the partition that is queried based on the filter condition.'."\n", - '$ref' => '#/components/schemas/Partition', - ], - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PartitionSpecs' => [ - 'title' => 'PartitionSpecs', - 'description' => 'The partition specifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The partition specification.'."\n", - '$ref' => '#/components/schemas/PartitionSpec', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4316D7DA-9816-596D-A3D7-12676FA59BDA'], + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + ], + 'title' => 'GrantRoleToUsers', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantRoleToUsers'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:GrantRoleToUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListPartitionsByFilter', - 'requestParamsDescription' => 'isShareSd: whether to share the column information in the SD of the partition. In the list of partitions returned by listpartitions, it is more likely that the columns in the sd of different partitions are the same. Therefore, enabling sharing can reduce the amount of data transmitted over the network and help improve performance.'."\n", - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database or table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4316D7DA-9816-596D-A3D7-12676FA59BDA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'BatchCreatePartitions' => [ - 'summary' => 'Add multiple partitions to a data table in a data lake at a time.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchcreate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GrantRolesToUser' => [ + 'path' => '/api/metastore/auth/roles/grantroles', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '114171', + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Body', + 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'IfNotExists' => [ - 'title' => 'IfNotExists', - 'description' => 'Specifies whether to ignore errors if the name of the partition to be created already exists.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'NeedResult' => [ - 'title' => 'NeedResult', - 'description' => 'Specifies whether to return partition information. If the value is true, the partitions are returned.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'PartitionInputs' => [ - 'title' => 'PartitionInputs', - 'description' => 'The information about the partitions to be created.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the partition to be created.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/PartitionInput', - ], - 'required' => false, - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], + 'RoleNames' => ['description' => 'The roles to grant.', 'required' => true, '$ref' => '#/components/schemas/ListString', 'title' => '', 'example' => ''], + 'User' => ['description' => 'The RAM identity to grant the roles. The format:'."\n" + ."\n" + .'- RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n" + ."\n" + .'- RAM user: acs:ram::\\[accountId]:user/\\[userName].', 'required' => true, '$ref' => '#/components/schemas/Principal', 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回结构', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应代码', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '响应消息', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'PartitionErrors' => [ - 'title' => '分区出错信息', - 'description' => 'The returned errors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned error.'."\n", - '$ref' => '#/components/schemas/PartitionError', - ], - ], - 'Partitions' => [ - 'title' => 'Partitions', - 'description' => 'The partitions, which are returned if the NeedResult parameter is set to true.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned partition.'."\n", - '$ref' => '#/components/schemas/Partition', - ], - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => ''], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + ], + 'title' => 'GrantRolesToUser', + 'summary' => 'Grants multiple roles to a user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantRolesToUser'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:GrantRolesToUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchCreatePartitions', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* InvalidObject: The corresponding Table or Database cannot be found.'."\n" - .'* AlreadyExists: The corresponding partition already exists.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'BatchDeletePartitions' => [ - 'summary' => 'Deletes multiple partitions of a data table in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchdelete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListCatalogs' => [ + 'path' => '/api/metastore/catalogs/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'IdPattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'A regular expression to match catalog IDs.', 'type' => 'string', 'required' => false, 'example' => '.*'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The token for the next page of results. This is returned in the previous response. For the first request, pass an empty string (\'\').', 'type' => 'string', 'required' => false, 'example' => '‘’'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000000', 'minimum' => '-2', 'default' => '1000', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'IfExists' => [ - 'title' => 'IfExists', - 'description' => 'Specifies whether to ignore errors if the partition that you want to delete does not exist.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'PartitionValueList' => [ - 'description' => 'The partition key column values of the partitions to be deleted.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/PartitionValueList', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201225', + 'Catalogs' => [ + 'title' => '', + 'description' => 'The catalogs.', + 'type' => 'array', + 'items' => ['description' => 'The details of the catalog.', '$ref' => '#/components/schemas/Catalog', 'title' => '', 'example' => ''], + 'example' => '[{"CatalogId":"xx"}]', ], + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The paging token.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], ], - 'required' => false, + 'example' => '', ], ], + '5XX' => [], + ], + 'title' => 'ListCatalogs', + 'summary' => 'Retrieve catalogs.', + 'requestParamsDescription' => '- IdPattern: A regular expression to match catalog IDs. Wildcard matching is supported. The period (.) matches a single character, and the asterisk (\\*) matches any number of characters.'."\n" + ."\n" + .'- NextPageToken: The token that specifies the starting position for paging. For the first request, pass an empty string. For subsequent requests, use the NextPageToken that is returned in the previous response. If an empty NextPageToken is returned, no more data is available.'."\n" + ."\n" + .'- PageSize: The number of entries to return per request.', + 'responseParamsDescription' => 'Error codes<br>InternalError: An internal error occurred. For details, refer to the Message element.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCatalogs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Catalogs\\": [\\n {\\n \\"CatalogId\\": \\"1344371\\",\\n \\"Description\\": \\"测试\\",\\n \\"LocationUri\\": \\"oss://dlf-test-oss-location/\\",\\n \\"Owner\\": \\"acs:ram::[accountId]:root\\",\\n \\"CreatedBy\\": \\"acs:ram::[accountId]:root\\\\n\\",\\n \\"CreateTime\\": 1640662815,\\n \\"UpdateTime\\": 1640662815,\\n \\"Status\\": \\"CREATED\\",\\n \\"CatalogType\\": \\"HMS\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListDatabases' => [ + 'path' => '/api/metastore/catalogs/databases/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The namespace for database categorization. By default, this is the UID of the Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'NamePattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'A regular expression that matches database names. To match all databases, enter .\\*.', 'type' => 'string', 'required' => false, 'example' => '.*'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The token to retrieve the next page of results. This is returned in the response. For the first page, pass an empty string ("").', 'type' => 'string', 'required' => false, 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa!'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000000', 'minimum' => '-2', 'default' => '1000', 'required' => false, 'example' => '10'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'PartitionErrors' => [ - 'title' => 'PartitionErrors', - 'description' => 'The returned errors.'."\n", + 'Code' => ['title' => '', 'description' => 'The status of the request.', 'type' => 'string', 'example' => 'OK'], + 'Databases' => [ + 'title' => '', + 'description' => 'The list of metadatabases.', 'type' => 'array', - 'items' => [ - 'description' => 'The returned error.'."\n", - '$ref' => '#/components/schemas/PartitionError', - ], - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'items' => ['description' => 'The query result for the metadatabase.', '$ref' => '#/components/schemas/Database', 'title' => '', 'example' => ''], + 'example' => '[{"name":"test"}]', ], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', + 'title' => '', + 'description' => 'Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchDeletePartitions', - 'responseParamsDescription' => 'Code error code description:'."\n" + 'title' => 'ListDatabases', + 'summary' => 'Retrieves a paginated list of databases in a data lake. You can match databases by name.', + 'requestParamsDescription' => '- NamePattern: The name pattern of the databases to query. Wildcard matching is supported. A period (.) matches a single character, and an asterisk (\\*) matches any number of characters.'."\n" ."\n" - .'* UnknownTable: The specified data table does not exist.'."\n" - .'* UnknownPartition: The specified partition does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'BatchGetPartitionColumnStatistics' => [ - 'summary' => 'Obtains the field statistics of data table partitions in a data lake at a time.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics/batchget', - 'methods' => [ - 'post', + .'- NextPageToken: The token used for pagination. Leave this parameter empty for the first request. For subsequent requests, set this parameter to the NextPageToken value from the previous response. An empty string returned for this parameter indicates that all results have been retrieved.'."\n" + ."\n" + .'- PageSize: The number of entries to return in a single response.', + 'responseParamsDescription' => 'Description of error codes for the Code parameter<br>'."\n" + .'InternalError: An internal error occurred. For more information, see the Message parameter.<br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatabases'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Databases\\": [\\n {\\n \\"CreateTime\\": 1608707407,\\n \\"Description\\": \\"this is a hive database\\",\\n \\"LocationUri\\": \\"/hdfs/hivedb/data\\",\\n \\"Name\\": \\"database_test\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"root\\"\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListFunctionNames' => [ + 'summary' => 'Performs a paged query to retrieve a list of function names from a database.', + 'path' => '/api/metastore/catalogs/databases/functions/names', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", - 'type' => 'object', - 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], - 'PartitionNames' => [ - 'description' => 'The names of the partitions in the data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - 'ColumnNames' => [ - 'description' => 'The names of the columns in the data table.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - ], - 'required' => false, - ], + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], + [ + 'name' => 'FunctionNamePattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The regular expression that the function names must match.', 'type' => 'string', 'required' => false, 'example' => '.*'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The token to retrieve the next page of results. It is returned in the response. To retrieve the first page, pass an empty string (\'\') or leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => '\'\''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000000', 'minimum' => '-1', 'default' => '1000', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'PartitionStatisticsMap' => [ - 'title' => 'PartitionStatisticsMap', - 'description' => 'The partition statistics.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/ColumnStatisticsObj', - 'description' => 'The partition statistics.'."\n", - ], - 'description' => 'The list of partition statistics.'."\n", - ], - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'FunctionNames' => [ + 'title' => '', + 'description' => 'A list of function names.', + 'type' => 'array', + 'items' => ['description' => 'The name of the function.', 'type' => 'string', 'example' => 'func2', 'title' => ''], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"PartitionStatisticsMap\\": {\\n \\"key\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"ColumnType\\": \\"\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"\\",\\n \\"StatisticsType\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchGetPartitionColumnStatistics', - ], - 'BatchGetPartitions' => [ - 'summary' => 'Obtains the details of database partitions in a data lake in batches.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchget', - 'methods' => [ - 'post', + 'title' => 'ListFunctionNames', + 'responseParamsDescription' => 'Error codes for the Code parameter:<br>'."\n" + .'InternalError: An internal error occurred. For more information, see the Message parameter.<br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionNames'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListFunctionNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"FunctionNames\\": [\\n \\"func2\\"\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListFunctions' => [ + 'summary' => 'Lists the user-defined functions from a database in a data lake.', + 'path' => '/api/metastore/catalogs/databases/functions/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", - 'type' => 'object', - 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'PartitionValueList' => [ - 'description' => 'The values of the partition key columns.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/PartitionValueList', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20200715162543389', - ], - 'IsShareSd' => [ - 'title' => 'IsShareSd', - 'description' => 'Specifies whether to share the column information of SD in the partition.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], + [ + 'name' => 'FunctionNamePattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'A regular expression that filters user-defined functions by name.', 'type' => 'string', 'required' => false, 'example' => '.*'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The token to retrieve the next page of results. If the response does not provide this token, pass an empty string ("").', 'type' => 'string', 'required' => false, 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000000', 'minimum' => '-1', 'default' => '1000', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'PartitionErrors' => [ - 'title' => 'PartitionErrors', - 'description' => 'The error messages.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The error message.'."\n", - '$ref' => '#/components/schemas/PartitionError', - ], - ], - 'Partitions' => [ - 'title' => 'Partitions', - 'description' => 'The list of partitions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about a partition.'."\n", - '$ref' => '#/components/schemas/Partition', - ], - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PartitionSpecs' => [ - 'title' => 'PartitionSpecs', - 'description' => 'The list of partition specifications.'."\n", + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Functions' => [ + 'title' => '', + 'description' => 'A list of function details.', 'type' => 'array', - 'items' => [ - 'description' => 'The partition specification.'."\n", - '$ref' => '#/components/schemas/PartitionSpec', - ], + 'items' => ['description' => 'The details of a function.', '$ref' => '#/components/schemas/Function', 'title' => '', 'example' => ''], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => ' ', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchGetPartitions', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database or table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'BatchUpdatePartitions' => [ - 'summary' => 'Batch update multiple partitions for a data table in a data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchupdate', - 'methods' => [ - 'put', + 'title' => 'ListFunctions', + 'responseParamsDescription' => 'Error codes for \\`Code\\`:<br>'."\n" + .'\\`InternalError\\`: The request failed due to an internal error. For more information, see the \\`Message\\` parameter.<br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListFunctions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Functions\\": [\\n {\\n \\"CatalogId\\": \\"1344371\\",\\n \\"ClassName\\": \\"com.xxx.xxxxFunction\\",\\n \\"CreateTime\\": 1608863962,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"FunctionName\\": \\"function1\\",\\n \\"FunctionType\\": \\"JAVA\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"ResourceUri\\": [\\n {\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Uri\\": \\"hdfs:///tmp/jar1.jar\\"\\n }\\n ],\\n \\"UpdateTime\\": 1608863962,\\n \\"CreatedBy\\": \\"CreatedBy\\"\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListPartitionNames' => [ + 'summary' => 'Retrieves a list of partition names for a table in a data lake. This operation is typically used for tables with multiple partition levels.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/names', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -9735,141 +7230,108 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The HTTP request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'PartitionInputs' => [ - 'title' => 'PartitionInputs', - 'description' => 'The information about the partitions to be updated.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the partition to be updated.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/PartitionInput', - ], - 'required' => false, - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table_20201223', - ], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'NextPageToken' => ['title' => '', 'description' => 'The token used to retrieve the next page of results. This token is returned in the response to a previous call. If this is your first request, pass an empty string.', 'type' => 'string', 'required' => false, 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'PartialPartValues' => ['description' => 'A list of partition values. You can pass a partial list of partition values to query the names of all sub-partitions.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'object', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'PartitionErrors' => [ - 'title' => 'PartitionErrors', - 'description' => 'The returned errors.'."\n", + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'PartitionNames' => [ + 'title' => '', + 'description' => 'A list of partition names.', 'type' => 'array', - 'items' => [ - 'description' => 'The returned error.'."\n", - '$ref' => '#/components/schemas/PartitionError', - ], - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'items' => ['description' => 'A partition name.', 'type' => 'string', 'example' => 'ds=20201124/hour=10', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', + 'title' => '', + 'description' => 'code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchUpdatePartitions', - ], - 'RenamePartition' => [ - 'summary' => 'Update the partition name of the data table in the data lake.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/rename', - 'methods' => [ - 'post', + 'title' => 'ListPartitionNames', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- NoSuchObject: The specified database or table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the value of the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionNames'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"PartitionNames\\": [\\n \\"ds=20201124/hour=10\\"\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListPartitions' => [ + 'summary' => 'Lists the details of database partitions in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/list', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -9877,135 +7339,190 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'Body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The HTTP request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'PartitionInput' => [ - 'description' => 'The renamed partition information, which is the same as the partition information you specify for the CreatePartition operation.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/PartitionInput', - ], - 'PartitionValues' => [ - 'description' => 'The values of the partition key columns.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - 'TableName' => [ - 'title' => 'TableName', - 'description' => 'The name of the data table.'."\n", - 'type' => 'string', + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'NextPageToken' => ['title' => '', 'description' => 'The token for the next page of results. This token is returned in the response. For the first request, pass an empty string.', 'type' => 'string', 'required' => false, 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'PartialPartValues' => ['description' => 'The list of partition values. You can provide a partial list of values to query the names of all sub-partitions.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + 'IsShareSd' => [ + 'title' => '', + 'description' => 'Specifies whether to share the column information in the storage descriptor (SD) of the partition. Valid values:'."\n" + ."\n" + .'- true: Shares the partition column information in the SD. This way, identical columns are returned only once. This reduces network traffic and improves the performance of this API operation.'."\n" + ."\n" + .'- false: Does not share the information.', + 'enumValueTitles' => [], + 'type' => 'boolean', 'required' => false, - 'example' => 'test_table_20200715162543389', + 'example' => 'true', ], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'Partitions' => [ + 'title' => '', + 'description' => 'The list of partition details.', + 'type' => 'array', + 'items' => ['description' => 'The partition details.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], + 'example' => '', ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'PartitionSpecs' => [ + 'title' => '', + 'description' => 'The list of partition specifications.', + 'type' => 'array', + 'items' => ['description' => 'The partition specification.', '$ref' => '#/components/schemas/PartitionSpec', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RenamePartition', - 'responseParamsDescription' => 'Code error code description:'."\n" + 'title' => 'ListPartitions', + 'responseParamsDescription' => 'Error codes for the Code parameter:'."\n" ."\n" - .'* InvalidOperation: The corresponding database or table cannot be found, or the new partition name already exists.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'CreateFunction' => [ - 'summary' => 'Added user-defined functions for databases in the data lake.', - 'path' => '/api/metastore/catalogs/databases/functions', - 'methods' => [ - 'post', + .'- NoSuchObject: The specified database or table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the error message.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListPartitionsByExpr' => [ + 'summary' => 'Lists partitions of a table based on a conditional query.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/listbyexpr', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], - 'produces' => [ - 'application/json', + 'parameters' => [], + 'responses' => [ + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'operationType' => 'readAndWrite', + 'errorCodes' => [], + 'title' => 'ListPartitionsByExpr', + 'description' => 'To filter partitions using an expression, call the ListPartitionsByFilter operation.', + 'responseParamsDescription' => '- code: The error code.'."\n" + ."\n" + .'- message: The error message.'."\n" + ."\n" + .'- requestId: The unique ID of the request.'."\n" + ."\n" + .'- Success: Indicates whether the request succeeded. Valid values: true and false.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionsByExpr'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionsByExpr', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListPartitionsByFilter' => [ + 'path' => '/api/metastore/catalogs/databases/tables/partitions/listbyfilter', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -10013,249 +7530,243 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'title' => 'DatabaseName', - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'FunctionInput' => [ - 'description' => 'The details about the function definition.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/FunctionInput', - ], + 'CatalogId' => ['title' => '', 'description' => 'The data catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'Filter' => ['title' => '', 'description' => 'A conditional expression for the query. The following operators are supported:'."\n" + ."\n" + .'- Comparison operators: =, <>, !=, <, <=, >, and >=. For example: ds > 20240101.'."\n" + ."\n" + .'- Logical operators: AND, OR, and NOT. For example: ds like \'20240%\'.'."\n" + ."\n" + .'- The BETWEEN operator, which is used to specify a range. For example: ds BETWEEN 20240101 AND 20241201.'."\n" + ."\n" + .'- The IN operator, which is used to specify a set of values. For example: ds IN (20240101, 20240102).', 'type' => 'string', 'required' => false, 'example' => 'ds>20201201'], + 'NextPageToken' => ['title' => '', 'description' => 'The token to retrieve the next page of results. If no token is returned in the response, pass an empty string ("").', 'type' => 'string', 'required' => false, 'example' => '\'\''], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + 'IsShareSd' => ['title' => '', 'description' => 'Specifies whether to share column information in the storage descriptor (SD) of the partition. Valid values:'."\n" + ."\n" + .'- true: The information is shared.'."\n" + ."\n" + .'- false: The information is not shared.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'Partitions' => [ + 'title' => '', + 'description' => 'A list of partition details.', + 'type' => 'array', + 'items' => ['description' => 'The details of a partition.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], + 'example' => '', ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'PartitionSpecs' => [ + 'title' => '', + 'description' => 'A list of partition specifications.', + 'type' => 'array', + 'items' => ['description' => 'A partition specification.', '$ref' => '#/components/schemas/PartitionSpec', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateFunction', - 'responseParamsDescription' => 'Code error code description:'."\n" + 'title' => 'ListPartitionsByFilter', + 'summary' => 'Retrieves a list of partitions for a data table in a data lake based on a filter condition.', + 'requestParamsDescription' => 'IsShareSd: Specifies whether to share column information in the storage descriptor (SD) of a partition. In the list of partitions returned by this operation, the columns in the SDs of different partitions are often identical. Enabling this option reduces the amount of data transferred over the network and improves performance.', + 'responseParamsDescription' => 'The following error codes are returned for the Code parameter:'."\n" ."\n" - .'* AlreadyExists: The same function already exists.'."\n" - .'* NoSuchObject: The specified database or table does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'DeleteFunction' => [ - 'summary' => 'Deletes a user-defined function for a database in the data lake by name.', - 'path' => '/api/metastore/catalogs/databases/functions', - 'methods' => [ - 'delete', + .'- NoSuchObject: The specified database or table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionsByFilter'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionsByFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 1608730999,\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608730999,\\n \\"LastAnalyzedTime\\": 1608730999,\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"test_table_20201223\\",\\n \\"Values\\": [\\n \\"part1\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListPartitionsProfile' => [ + 'summary' => 'Obtains the details of a partition data profile.', + 'path' => '/webapi/metastorehouse/catalog/database/tableprofile/partitionprofile/listPartitionsProfile', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '139289', + 'abilityTreeNodes' => ['FEATUREdlfTGKBOY'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data directory. By default, the ID of the primary account is entered.'."\n", 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_db'], ], [ - 'name' => 'FunctionName', + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metadata table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_tbl', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Page number'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PartitionNames', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'title' => 'FunctionName', - 'description' => 'The function name.'."\n", - 'type' => 'string', + 'description' => 'The names of partitions.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the partition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'year=3/month=1', 'title' => ''], 'required' => false, - 'example' => 'func2', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The information returned.'."\n", + 'title' => '', + 'description' => 'Response'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '-'], + 'Message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => '-'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '97434FA4-A6B2-1AE4-A174-76964F29C759'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Data' => [ + 'description' => 'The partition data profiles.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The partition data profile.'."\n", '$ref' => '#/components/schemas/PartitionProfile', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'LatestDate' => ['description' => 'The time when the metadata warehouse was updated.'."\n", 'type' => 'string', 'example' => '2023-08-30 19:16:10', 'title' => ''], + 'LatestAccessNumDate' => ['description' => 'The time when the access frequency is updated. This parameter is obsolete.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + ], + 'title' => 'ListPartitionsProfile', + 'description' => 'To use a data profile, you must first host the OSS bucket of the table.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionsProfile'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionsProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteFunction', - 'responseParamsDescription' => 'Code error code description:'."\n" - ."\n" - .'* NoSuchObject: The specified database, table, or function does not exist.'."\n" - .'* InternalError: Other types of errors. For more information, see Message tips.'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"97434FA4-A6B2-1AE4-A174-76964F29C759\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"DatabaseName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"PartitionName\\": \\"year=2023/month=1\\",\\n \\"ArchiveStatus\\": \\"STANDARD\\",\\n \\"CreateTime\\": \\"2023-08-16 18:02:22\\",\\n \\"LastModifyTime\\": \\"2023-08-16 18:02:25\\",\\n \\"LastAccessTime\\": \\"2023-08-22 12:14:42\\",\\n \\"LastAccessNumTime\\": \\"\\",\\n \\"Location\\": \\"oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/year=2023/month=1\\",\\n \\"FileSize\\": 13,\\n \\"ObjectSize\\": 13,\\n \\"FileCnt\\": 1,\\n \\"ObjectCnt\\": 1,\\n \\"AccessNum\\": 0,\\n \\"AccessNumWeekly\\": 0,\\n \\"AccessNumMonthly\\": 0,\\n \\"ObjectAccessNum\\": 0,\\n \\"ObjectAccessNumWeekly\\": 4,\\n \\"ObjectAccessNumMonthly\\": 4,\\n \\"DataSourceType\\": \\"OSS_HDFS\\"\\n }\\n ],\\n \\"LatestDate\\": \\"2023-08-30 19:16:10\\",\\n \\"LatestAccessNumDate\\": \\"-\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPartitionsProfileResponse>\\n <Code>-</Code>\\n <Message>-</Message>\\n <RequestId>97434FA4-A6B2-1AE4-A174-76964F29C759</RequestId>\\n <Success>true</Success>\\n <Total>1</Total>\\n <Data>\\n <DatabaseName>test_db</DatabaseName>\\n <TableName>test_tbl</TableName>\\n <PartitionName>year=2023/month=1</PartitionName>\\n <ArchiveStatus>STANDARD</ArchiveStatus>\\n <CreateTime>2023-08-16 18:02:22</CreateTime>\\n <LastModifyTime>2023-08-16 18:02:25</LastModifyTime>\\n <LastAccessTime>2023-08-22 12:14:42</LastAccessTime>\\n <Location>oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1</Location>\\n <FileSize>13</FileSize>\\n <ObjectSize>13</ObjectSize>\\n <FileCnt>1</FileCnt>\\n <ObjectCnt>1</ObjectCnt>\\n <ObjectAccessNum>0</ObjectAccessNum>\\n <ObjectAccessNumWeekly>4</ObjectAccessNumWeekly>\\n <ObjectAccessNumMonthly>4</ObjectAccessNumMonthly>\\n <DataSourceType>OSS_HDFS</DataSourceType>\\n </Data>\\n <LatestDate>2023-08-30 19:16:10</LatestDate>\\n</ListPartitionsProfileResponse>","errorExample":""}]', ], - 'UpdateFunction' => [ - 'summary' => 'Updates the user-defined function information for a database in the data lake by name.', - 'path' => '/api/metastore/catalogs/databases/functions', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPermissions' => [ + 'summary' => 'Queries permissions.', + 'path' => '/api/metastore/auth/permissions/list', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlfT96YCV'], ], 'parameters' => [ [ @@ -10263,530 +7774,577 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body', 'description' => 'The HTTP request body, in the JSON format.'."\n", 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'DatabaseName' => [ - 'description' => 'The database name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], - 'FunctionInput' => [ - 'description' => 'The details about the function to be updated.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/FunctionInput', - ], - 'FunctionName' => [ - 'description' => 'The function name.'."\n", + 'Principal' => ['title' => '', 'description' => 'The principle based on which permission information is filtered.'."\n", 'required' => false, '$ref' => '#/components/schemas/Principal', 'example' => ''], + 'NextPageToken' => ['title' => '', 'description' => 'A pagination token, which is used to obtain data on the next page. If no pagination token is returned in the response, set this parameter to an empty string ("") or an empty character (\'\').'."\n", 'type' => 'string', 'required' => false, 'example' => 'token!'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries to return on each page. Maximum value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'Type' => [ + 'title' => '', + 'description' => 'The type of permission information to be obtained. Only Hive is supported.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'func2', + 'required' => true, + 'example' => 'Hive', + 'enum' => ['hive'], ], + 'MetaResource' => ['title' => '', 'description' => 'The resource based on which permission information is filtered.'."\n", 'required' => false, '$ref' => '#/components/schemas/MetaResource', 'example' => ''], + 'IsListUserRolePermissions' => ['title' => '', 'description' => 'Specifies whether to obtain the permissions of the role to which the user belongs. This parameter takes effect only when you specify a specific resource object.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'MetaResourceType' => ['title' => '', 'description' => 'The type of the resource based on which permission information is filtered, such as database or table. If you do not specify this parameter, permission information is filtered based on both databases and tables.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DATABASE'], + 'CatalogId' => ['title' => '', 'description' => 'The catalog ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1344371'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Respones', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The returned message body.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The response message.'."\n", 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '745EAAE2-5010-5C9F-A95C-B8FC5C1B03BF'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'NextPageToken' => ['title' => '', 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n", 'type' => 'string', 'example' => 'token!'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '暂不支持'], + 'PrincipalResourcePermissionsList' => ['description' => 'The permissions.'."\n", 'example' => '[]', '$ref' => '#/components/schemas/PrincipalResourcePermissionsList', 'title' => ''], ], + 'example' => '', ], ], - '5XX' => [ + '5XX' => [], + ], + 'title' => 'ListPermissions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPermissions'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:ListPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"745EAAE2-5010-5C9F-A95C-B8FC5C1B03BF\\",\\n \\"Success\\": true,\\n \\"NextPageToken\\": \\"token!\\",\\n \\"TotalCount\\": 0,\\n \\"PrincipalResourcePermissionsList\\": [\\n {\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"1344371\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"*\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"TableName\\": \\"test_parquet\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRoleUsers' => [ + 'path' => '/api/metastore/auth/roles/roleusers', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the role.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], + ], + [ + 'name' => 'UserNamePattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'A regular expression that the username must match.', 'type' => 'string', 'required' => false, 'example' => '.*user.*'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The pagination token from the previous response. If this is your first request, leave this parameter empty or pass an empty string.', 'type' => 'string', 'required' => false, 'example' => 'token!'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => '.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'UserRoles' => ['title' => '', 'description' => 'The users for a role.', '$ref' => '#/components/schemas/UserRoles', 'example' => 'UserRole列表'], + 'NextPageToken' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'token!'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateFunction', - 'responseParamsDescription' => 'Code: the error code.\\'."\n" - .'InvalidObject: The corresponding metabase, table, or function does not exist, or the function parameter is empty.\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'ListFunctionNames' => [ - 'summary' => 'Paged query to obtain the list of function names of the database.', - 'path' => '/api/metastore/catalogs/databases/functions/names', - 'methods' => [ - 'get', + 'title' => 'ListRoleUsers', + 'summary' => 'Lists the users for a specific role.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoleUsers'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:ListRoleUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"UserRoles\\": [\\n {\\n \\"Role\\": {\\n \\"Name\\": \\"role_name\\",\\n \\"Description\\": \\"role description\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"acs:dlf::111:role/role_name\\",\\n \\"CreateTime\\": 1647323053,\\n \\"UpdateTime\\": 1647323053,\\n \\"IsPredefined\\": 1\\n },\\n \\"GrantTime\\": 0,\\n \\"User\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"token!\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListRoles' => [ + 'path' => '/api/metastore/auth/roles/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '115466', + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CatalogId', + 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The pagination token used to retrieve the next page of results. If a NextPageToken is not returned in the response, pass an empty string ("").', 'type' => 'string', 'required' => false, 'example' => 'token!'], ], [ - 'name' => 'DatabaseName', + 'name' => 'RoleNamePattern', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['description' => 'A regular expression that the role name must match. Fuzzy search is supported. For example, .\\*test.\\*.', 'type' => 'string', 'required' => false, 'example' => '.*test.*', 'title' => ''], ], [ - 'name' => 'FunctionNamePattern', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page. The maximum value is 1,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'FunctionNamePattern', - 'description' => 'The regular expression that matches the function name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*', + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The message returned.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'True'], + 'NextPageToken' => ['title' => '', 'description' => 'The pagination token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'Roles' => ['title' => '', 'description' => 'The roles.', '$ref' => '#/components/schemas/Roles', 'example' => '['."\n" + .' {'."\n" + .' "Description":"reserved by the system",'."\n" + .' "DisplayName":"admin",'."\n" + .' "UpdateTime":0,'."\n" + .' "IsPredefined":1,'."\n" + .' "Name":"admin"'."\n" + .' }'."\n" + .']'], + ], + 'example' => '', + ], + ], + ], + 'title' => 'ListRoles', + 'summary' => 'Retrieves DLF roles.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:ListRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Roles\\": [\\n {\\n \\"Name\\": \\"role_name\\",\\n \\"Description\\": \\"role description\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"acs:dlf::111:role/role_name\\",\\n \\"CreateTime\\": 1647323053,\\n \\"UpdateTime\\": 1647323053,\\n \\"IsPredefined\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListTableNames' => [ + 'summary' => 'Lists the names of tables in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables/names', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'TableNamePattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The regular expression that is used to match table names.', 'type' => 'string', 'required' => false, 'example' => '.*'], + ], [ 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'title' => 'NextPageToken', - 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\'\'', - ], + 'schema' => ['title' => '', 'description' => 'The token that is used to retrieve the next page of results. This value is returned in the response of a previous request. For the first request, pass an empty string (\'\').', 'type' => 'string', 'required' => false, 'example' => '\'\''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Maximum value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000000', - 'minimum' => '-1', - 'example' => '10', - 'default' => '1000', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000000', 'minimum' => '-1', 'default' => '1000', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The type of the table. Valid values:'."\n" + ."\n" + .'MANAGED\\_TABLE: internal table.'."\n" + ."\n" + .'EXTERNAL\\_TABLE: foreign table.'."\n" + ."\n" + .'VIRTUAL\\_VIEW: virtual view.'."\n" + ."\n" + .'INDEX\\_TABLE: index table.'."\n" + ."\n" + .'MATERIALIZED\\_VIEW: materialized view.', 'type' => 'string', 'required' => false, 'example' => 'MANAGED_TABLE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'FunctionNames' => [ - 'title' => 'FunctionNames', - 'description' => 'The list of function names.'."\n", + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], + 'TableNames' => [ + 'title' => '', + 'description' => 'A list of table names.', 'type' => 'array', - 'items' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'example' => 'func2', - ], - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'items' => ['description' => 'The name of a table.', 'type' => 'string', 'example' => 'table1', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'code', - 'description' => 'code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"FunctionNames\\": [\\n \\"func2\\"\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListFunctionNames', - 'responseParamsDescription' => 'Code error code description:\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'ListFunctions' => [ - 'summary' => 'Obtains a list of user-defined functions for databases in the data lake in bulk.', - 'path' => '/api/metastore/catalogs/databases/functions/list', - 'methods' => [ - 'get', + 'title' => 'ListTableNames', + 'responseParamsDescription' => 'Code: The error code.<br>'."\n" + .'InternalError: An internal error occurred. For more information, see the value of the Message parameter.<br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTableNames'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListTableNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableNames\\": [\\n \\"table1\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTableVersions' => [ + 'path' => '/api/metastore/catalogs/databases/tables/versions/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ - 'name' => 'FunctionNamePattern', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'title' => 'FunctionNamePattern', - 'description' => 'The regular match expression for the user-defined function name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*', - ], + 'schema' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], ], [ 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], + 'schema' => ['title' => '', 'description' => 'The token for the next page of results. If the response does not include this token, pass an empty string ("").', 'type' => 'string', 'required' => false, 'example' => '\'\''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The number of entries per page. Maximum value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000000', - 'minimum' => '-1', - 'example' => '10', - 'default' => '1000', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Functions' => [ - 'title' => 'Functions', - 'description' => 'The details of the functions.'."\n", + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'TableVersions' => [ + 'title' => '', + 'description' => 'The table versions.', 'type' => 'array', - 'items' => [ - 'description' => 'The details about the function.'."\n", - '$ref' => '#/components/schemas/Function', - ], - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'items' => ['description' => 'A table with a version.', '$ref' => '#/components/schemas/TableVersion', 'example' => '{"table":{},"versionId":123}', 'title' => ''], + 'example' => '', ], ], - 'example' => ' ', + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Functions\\": [\\n {\\n \\"CatalogId\\": \\"\\",\\n \\"ClassName\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"FunctionName\\": \\"\\",\\n \\"FunctionType\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ResourceUri\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"CreatedBy\\"\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListFunctions', - 'responseParamsDescription' => 'Code error code description:\\'."\n" - .'InternalError: Other types of errors. For more information, see Message tips.'."\n", - ], - 'GetFunction' => [ - 'summary' => 'Obtain the user-defined function of the database in the data lake based on the function name.', - 'path' => '/api/metastore/catalogs/databases/functions', - 'methods' => [ - 'get', + 'title' => 'ListTableVersions', + 'summary' => 'Performs the versions of a table.', + 'responseParamsDescription' => 'Error codes for the Code parameter:'."\n" + ."\n" + .'- NoSuchObject: The table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message element.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTableVersions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListTableVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableVersions\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\"\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListTables' => [ + 'summary' => 'Retrieves a list of data tables in a data lake.', + 'path' => '/api/metastore/databases/tables/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + [ + 'name' => 'TableNamePattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The table name, which is matched using a regular expression.', 'type' => 'string', 'required' => false, 'example' => '.*'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The pagination token that is returned in the response. To retrieve the first page of results, pass an empty string (\'\').', 'type' => 'string', 'required' => false, 'example' => '\'\''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000000', 'minimum' => '-1', 'default' => '1000', 'required' => false, 'example' => '10'], ], [ 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of a database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database_test', - ], + 'schema' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], ], [ - 'name' => 'FunctionName', + 'name' => 'TableType', 'in' => 'query', - 'schema' => [ - 'title' => 'FunctionName', - 'description' => 'The name of the user-defined function.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'func2', - ], + 'schema' => ['title' => '', 'description' => 'The type of the data table. Valid values:'."\n" + ."\n" + .'- MANAGED\\_TABLE: internal table.'."\n" + ."\n" + .'- EXTERNAL\\_TABLE: external table.'."\n" + ."\n" + .'- VIRTUAL\\_VIEW: virtual view.'."\n" + ."\n" + .'- INDEX\\_TABLE: index table.'."\n" + ."\n" + .'- MATERIALIZED\\_VIEW: materialized view.', 'type' => 'string', 'required' => false, 'example' => 'MANAGED_TABLE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'The returned results.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Function' => [ - 'description' => 'The details about the function.'."\n", - 'example' => '{"FunctionName":test}', - '$ref' => '#/components/schemas/Function', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'NextPageToken' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'Tables' => [ + 'title' => '', + 'description' => 'A list of data tables.', + 'type' => 'array', + 'items' => ['description' => 'The details of a data table.', '$ref' => '#/components/schemas/Table', 'title' => '', 'example' => ''], + 'example' => '[{"TableName":"xx"}]', ], ], 'example' => '', @@ -10794,616 +8352,620 @@ ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Function\\": {\\n \\"CatalogId\\": \\"\\",\\n \\"ClassName\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"FunctionName\\": \\"\\",\\n \\"FunctionType\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ResourceUri\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"CreatedBy\\"\\n },\\n \\"Message\\": \\"error\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetFunction', - 'responseParamsDescription' => 'Code error code description:\\'."\n" - .'InternalError: For more information, see the message prompt.'."\n", - ], - 'CreateLock' => [ - 'summary' => 'Creates a specified metadata lock.', - 'path' => '/api/metastore/catalogs/databases/tables/locks', - 'methods' => [ - 'post', + 'title' => 'ListTables', + 'responseParamsDescription' => 'Code: The description of the error code.<br>InternalError: An internal error occurred. For more information, see the message.<br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTables'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"Tables\\": [\\n {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListUserRoles' => [ + 'summary' => 'Retrieves the DLF roles assigned to a specific user.', + 'path' => '/api/metastore/auth/roles/userroles', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '119439', + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body', - 'description' => 'The HTTP request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'LockObjList' => [ - 'title' => 'LockObjList', - 'description' => 'The list of locks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The lock.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/LockObj', - ], - 'required' => false, - 'example' => '{"databaseName":"db","tableName":"test"}', - ], - ], - 'required' => false, - ], + 'name' => 'PrincipalArn', + 'in' => 'query', + 'schema' => ['description' => 'Uniquely identifies a RAM user or RAM role. The format is:'."\n" + ."\n" + .'- RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" + ."\n" + .'- RAM role: acs:ram::\\[accountId]:role/\\[roleName].', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1111:user/testuser', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1/100', 'required' => false], + ], + [ + 'name' => 'RoleNamePattern', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'A regular expression that matches the role name. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => '.*test.*'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['description' => 'The token to retrieve the next page of results. If the response does not return this token, pass an empty string ("").', 'type' => 'string', 'required' => false, 'example' => 'token!', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'lock response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '73201200-4C1A-4FEF-BD6B-C0DA7994FFA2', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'LockStatus' => [ - 'description' => 'The lock status.'."\n", - 'example' => '{"lockId":12323,"lockStatus":"ACQUIRED"}', - '$ref' => '#/components/schemas/LockStatus', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => '.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'UserRoles' => ['title' => '', 'description' => 'The user roles.', '$ref' => '#/components/schemas/UserRoles', 'example' => '参考UserRoles结构'], + 'NextPageToken' => ['title' => '', 'description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'], ], + 'example' => '', ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"73201200-4C1A-4FEF-BD6B-C0DA7994FFA2\\",\\n \\"Success\\": true,\\n \\"LockStatus\\": {\\n \\"LockId\\": 0,\\n \\"LockState\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateLock', - 'requestParamsDescription' => '1. Currently, LockObjList only supports size 1, which means that only one object can be locked.'."\n" - .'2. LockObj supports only table locks and does not support partition-level locks.'."\n", - 'responseParamsDescription' => '* code: the error code.'."\n" - .'* message: the error message.'."\n" - .'* requestId: the unique ID of the current request.'."\n" - .'* Success:true/false to determine whether the request is successful.'."\n" - .'* LockStatus: The field has a value if it is successful. Otherwise, it is empty. LockStatus contains two fields: lockId and Lockstate. If lockstate is Acquired, lockid has a value. Otherwise, it is empty.'."\n", - ], - 'GetLock' => [ - 'summary' => 'Queries the specified metadata lock.', - 'path' => '/api/metastore/catalogs/databases/tables/locks', - 'methods' => [ - 'get', + 'title' => 'ListUserRoles', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserRoles'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:ListUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"UserRoles\\": [\\n {\\n \\"Role\\": {\\n \\"Name\\": \\"role_name\\",\\n \\"Description\\": \\"role description\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"acs:dlf::111:role/role_name\\",\\n \\"CreateTime\\": 1647323053,\\n \\"UpdateTime\\": 1647323053,\\n \\"IsPredefined\\": 1\\n },\\n \\"GrantTime\\": 0,\\n \\"User\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RefreshLock' => [ + 'summary' => 'Refreshes the specified metadata lock.', + 'path' => '/api/metastore/catalogs/databases/tables/locks', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ 'name' => 'LockId', 'in' => 'query', - 'schema' => [ - 'title' => 'LockId', - 'description' => 'The lock ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '16533', - ], + 'schema' => ['title' => '', 'description' => 'The lock ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12324'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Lock response', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'LockStatus' => [ - 'description' => 'The lock status.'."\n", - 'example' => '{"lockId":123,"lockStatus":"Acquired"}', - '$ref' => '#/components/schemas/LockStatus', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'code', - 'description' => 'code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Success\\": true,\\n \\"LockStatus\\": {\\n \\"LockId\\": 0,\\n \\"LockState\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetLock', - 'requestParamsDescription' => 'lockid, that is, lockid returned from createlock'."\n", - ], - 'AbortLock' => [ - 'summary' => 'Aborts the specified metadata lock.', - 'path' => '/api/metastore/catalogs/databases/tables/locks/abort', - 'methods' => [ - 'delete', + 'title' => 'RefreshLock', + 'requestParamsDescription' => 'The lock ID that is returned by the CreateLock operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshLock'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RefreshLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RegisterLocation' => [ + 'summary' => 'Registers an Object Storage Service (OSS) path to be managed by Data Lake Formation (DLF).', + 'path' => '/webapi/locations', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'LockId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'LockId', - 'description' => 'The lock ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Location' => ['description' => 'The OSS path to register.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss://mybucket/', 'title' => ''], + 'RoleName' => ['description' => 'The Resource Access Management (RAM) role name.'."\n" + ."\n" + .'> DLF requires an authorized role to read and write data in the specified OSS path. You can use the `AliyunDLFWorkFlowDefaultRole` role, which is pre-configured with the required permissions for the path. Alternatively, you can use a custom role, but you must manually grant that role read and write permissions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AliyunDLFWorkFlowDefaultRole', 'title' => ''], + 'InventoryCollectEnabled' => ['description' => 'Specifies whether to enable the storage inventory.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'OssLogCollectEnabled' => ['description' => 'Specifies whether to enable OSS log collection.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], 'required' => false, - 'example' => '16530', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'transaction response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The registration result.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '01D8DD6B-4929-5999-9BB3-950AA30E3BD0', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false.'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3C2678BA-3451-14C3-90E2-D4EF5B4E7A84'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'LocationId' => ['description' => 'The ID of the location.', 'type' => 'string', 'example' => 'LOC-AB8FBC17F95A4AF5', 'title' => ''], + 'StorageCollectTaskOperationResultList' => [ + 'description' => 'The list of results for the enabled collection tasks.', + 'type' => 'array', + 'items' => ['description' => 'The result of an enabled collection task.', '$ref' => '#/components/schemas/StorageCollectTaskOperationResult', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'code', - 'description' => 'code', - 'type' => 'string', - ], + ], + 'title' => 'RegisterLocation', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterLocation'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RegisterLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"01D8DD6B-4929-5999-9BB3-950AA30E3BD0\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'AbortLock', - 'requestParamsDescription' => 'lockid, the lockid obtained from the createlock request'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C2678BA-3451-14C3-90E2-D4EF5B4E7A84\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": false,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'RefreshLock' => [ - 'summary' => 'Refreshes the specified metadata lock.', - 'path' => '/api/metastore/catalogs/databases/tables/locks', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RenamePartition' => [ + 'summary' => 'Renames a partition in a data lake table.', + 'path' => '/api/metastore/catalogs/databases/tables/partitions/rename', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'LockId', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'LockId', - 'description' => 'The lock ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request body is in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'PartitionInput' => ['description' => 'The updated partition information. This is the same as the information for CreatePartition.', '$ref' => '#/components/schemas/PartitionInput', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionValues' => ['description' => 'The partition values.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20200715162543389'], + ], 'required' => false, - 'example' => '12324', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Lock response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'code', - 'description' => 'code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RefreshLock', - 'requestParamsDescription' => 'lockid, that is, lockid returned from createlock'."\n", - ], - 'UnLock' => [ - 'summary' => 'Unlocks the specified metadata lock.', - 'path' => '/api/metastore/catalogs/databases/tables/locks', - 'methods' => [ - 'delete', + 'title' => 'RenamePartition', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- InvalidOperation: The specified database or table cannot be found, or the new partition name already exists.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the value of the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenamePartition'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RenamePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RenameTable' => [ + 'path' => '/api/metastore/catalogs/databases/tables/rename', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'LockId', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'LockId', - 'description' => 'The lock ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The request body of the HTTP request. The value is in the JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'TableInput' => ['description' => 'The table object. Note: Only specify the TableName.', '$ref' => '#/components/schemas/TableInput', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], + 'IsAsync' => ['title' => '', 'description' => 'Specifies whether to update the table asynchronously. Valid values:'."\n" + ."\n" + .'- false (default): The call is synchronous. The API operation waits for the background task to finish before it returns a result. If the background task takes a long time, the call may time out.'."\n" + ."\n" + .'- true: The call is asynchronous. The API operation returns a result immediately without waiting for the background task to finish. The response includes a task ID. You can use this ID to query the status of the task.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], 'required' => false, - 'example' => '11709', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'transaction response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '37C8470A-5E6D-5E4E-AEF0-EA3EBE9C89EE', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'TaskId' => ['title' => '', 'description' => 'The ID of the asynchronous task.', 'type' => 'string', 'example' => 'c38206c3aca0c41332ffe49294243009'], ], + 'example' => '', ], ], '5XX' => [ 'schema' => [ - 'title' => 'Code', + 'title' => '', 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'code', - 'description' => 'code', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"37C8470A-5E6D-5E4E-AEF0-EA3EBE9C89EE\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UnLock', - 'requestParamsDescription' => 'LockId, that is, the lockId obtained from CreateLock'."\n", - ], - 'StopMigrationWorkflow' => [ - 'summary' => 'Stop the metadata migration task.', - 'path' => '/webapi/migration/workflow/stop', - 'methods' => [ - 'put', + 'title' => 'RenameTable', + 'summary' => 'Updates the name of a data table in a data lake.', + 'responseParamsDescription' => 'Error code descriptions:'."\n" + ."\n" + .'- InvalidOperation: The specified database or table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the value of the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameTable'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RenameTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RevokePermissions' => [ + 'summary' => 'Revokes permissions on resources from a DLF user or role.', + 'path' => '/api/metastore/auth/permissions/revoke', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the migration task instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'M-6DCF5D8EF92E2195', + 'description' => 'The JSON-formatted request body.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of authorization to revoke. Only Hive is supported.', + 'type' => 'string', + 'required' => true, + 'enum' => ['hive'], + 'title' => '', + 'example' => 'Hive', + ], + 'MetaResource' => ['description' => 'The metadata resource to revoke permissions from.', 'required' => true, '$ref' => '#/components/schemas/MetaResource', 'title' => '', 'example' => ''], + 'Accesses' => ['description' => 'The access permissions to revoke.', 'required' => true, '$ref' => '#/components/schemas/Accesses', 'title' => '', 'example' => ''], + 'DelegateAccesses' => ['description' => 'The grantable access permissions that need to be revoked. This parameter is not available.', '$ref' => '#/components/schemas/Accesses', 'title' => '', 'required' => false, 'example' => ''], + 'Principal' => ['description' => 'The user or role to revoke permissions from. Use one of the following formats:'."\n" + ."\n" + .'- RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" + ."\n" + .'- RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n" + ."\n" + .'- DLF role: acs:dlf::\\[accountId]:role/\\[roleName].', 'required' => true, '$ref' => '#/components/schemas/Principal', 'title' => '', 'example' => ''], + 'CatalogId' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the test feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7CB5765C-F209-5B10-8792-D2BE9156ABE8'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], - 'description' => '', + 'example' => '', ], ], + '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\"\\n}","type":"json"}]', - 'title' => 'StopMigrationWorkflow', - ], - 'RunMigrationWorkflow' => [ - 'summary' => 'Runs a metadata migration task.', - 'path' => '/webapi/migration/workflow/run', - 'methods' => [ - 'post', + 'title' => 'RevokePermissions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokePermissions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:RevokePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"7CB5765C-F209-5B10-8792-D2BE9156ABE8\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RevokeRoleFromUsers' => [ + 'path' => '/api/metastore/auth/roles/revokeusers', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11412,202 +8974,249 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '114434', + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the migration instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'M-EDD8BF959BB97345', + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'RoleName' => ['description' => 'The role to revoke from users.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test_role_3'], + 'Users' => ['description' => 'The RAM identities to remove. The format is as follows:'."\n" + ."\n" + .'- RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" + ."\n" + .'- RAM role: acs:ram::\\[accountId]:role/\\[roleName].', '$ref' => '#/components/schemas/Principals', 'title' => '', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The returned data. The value is the ID of the workflow instance.'."\n", - 'type' => 'string', - 'example' => 'FI-7193B85809CAD95C', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A048EA8E-3519-5B18-B81E-EE3E0B6DBE0C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call succeeded. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"FI-7193B85809CAD95C\\",\\n \\"RequestId\\": \\"A048EA8E-3519-5B18-B81E-EE3E0B6DBE0C\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RunMigrationWorkflow', - ], - 'GetAsyncTaskStatus' => [ - 'summary' => 'Used in metadata-related asynchronous APIs to check the status of asynchronous execution tasks.', - 'path' => '/api/metastore/catalogs/tasks', - 'methods' => [ - 'get', + 'title' => 'RevokeRoleFromUsers', + 'summary' => 'Revokes a DLF role from multiple users.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeRoleFromUsers'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:RevokeRoleFromUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RevokeRolesFromUser' => [ + 'path' => '/api/metastore/auth/roles/revokeroles', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeCode' => '114433', + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'TaskId', - 'description' => 'The result returned by the asynchronous task.'."\n", - 'type' => 'string', + 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleNames' => ['title' => '', 'description' => 'The RAM roles to be revoked from the RAM user.', 'required' => true, '$ref' => '#/components/schemas/ListString', 'example' => ''], + 'User' => ['title' => '', 'description' => 'The RAM user from whom you want to revoke roles. Format:'."\n" + ."\n" + .'* RAM roles: acs:ram::\\[accountId]:role/\\[roleName].'."\n" + .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].', 'required' => true, '$ref' => '#/components/schemas/Principal', 'example' => ''], + ], 'required' => false, - 'example' => 'f546c761570e5efc8146a1986f7890d2', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The returned message.'."\n", + 'title' => '', + 'description' => 'Returns the message body.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The message that is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TaskStatus' => [ - 'description' => 'The task status.'."\n", - 'example' => 'Success', - '$ref' => '#/components/schemas/TaskStatus', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Code' => ['title' => '', 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The response message.'."\n", 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], - '5XX' => [ + ], + 'title' => 'RevokeRolesFromUser', + 'summary' => 'Removes multiple roles from a single user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeRolesFromUser'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:RevokeRolesFromUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'RunMigrationWorkflow' => [ + 'summary' => 'Runs a migration workflow.', + 'path' => '/webapi/migration/workflow/run', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the migration workflow instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'M-EDD8BF959BB97345', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Code', - 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], + 'Data' => ['description' => 'The response data. The value is the ID of the workflow instance.', 'type' => 'string', 'example' => 'FI-7193B85809CAD95C', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A048EA8E-3519-5B18-B81E-EE3E0B6DBE0C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskStatus\\": {\\n \\"Status\\": \\"\\",\\n \\"Message\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetAsyncTaskStatus', + 'title' => 'RunMigrationWorkflow', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunMigrationWorkflow'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RunMigrationWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"FI-7193B85809CAD95C\\",\\n \\"RequestId\\": \\"A048EA8E-3519-5B18-B81E-EE3E0B6DBE0C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', ], 'Search' => [ - 'summary' => 'Metadata retrieval.', 'path' => '/api/metastore/catalogs/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -11615,217 +9224,158 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'A short description of struct'."\n", + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'catalogid', - 'description' => 'catalogid'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'SearchText' => [ - 'title' => '搜索问题', - 'description' => 'The search text.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tags:tag1 or comment:^iso and name=aliyun and (createTime > "20211111" and createTime < "20211117") and has category', - ], + 'CatalogId' => ['title' => '', 'description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'SearchText' => ['description' => 'The search query.', 'type' => 'string', 'required' => false, 'example' => 'tags:tag1 or comment:^iso and name=aliyun and (createTime > "20211111" and createTime < "20211117") and has category', 'title' => ''], 'SortCriteria' => [ - 'title' => '排序结构', - 'description' => 'The sorting rules.'."\n", + 'title' => '', + 'description' => 'The sorting criteria.', 'type' => 'array', - 'items' => [ - 'description' => 'The sorting rule.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/SortCriterion', - ], - 'required' => false, - ], - 'PageSize' => [ - 'title' => '当前查询的页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - 'PageNumber' => [ - 'title' => '当前查询的页号', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['description' => 'The sorting criteria.', '$ref' => '#/components/schemas/SortCriterion', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'example' => '1', + 'example' => '', ], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => '', 'required' => false], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], 'SearchType' => [ - 'description' => 'The search type.'."\n", + 'description' => 'The object type.', 'type' => 'string', + 'enum' => ['table', 'all', 'database'], 'required' => false, 'example' => 'TABLE/DATABASE/CATALOG', - 'enum' => [ - 'table', - 'all', - 'database', - ], + 'title' => '', ], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应代码', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '响应消息', - 'description' => 'Response'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '460C862F-BB91-5C04-BC3F-946EEF467862', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the information about the service was queried.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '460C862F-BB91-5C04-BC3F-946EEF467862', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'DatabaseResult' => [ - 'title' => '返回的db结果', - 'description' => 'The returned database information.'."\n", + 'title' => '', + 'description' => 'The database result.', 'type' => 'object', 'properties' => [ 'Databases' => [ - 'title' => '返回的DatabaseList', - 'description' => 'The returned databases.'."\n", + 'title' => '', + 'description' => 'A list of databases.', 'type' => 'array', 'items' => [ - 'description' => 'The database information.'."\n", + 'description' => 'The database information.', 'type' => 'object', 'properties' => [ - 'Database' => [ - 'title' => '返回的Database', - 'description' => 'The returned database.'."\n", - '$ref' => '#/components/schemas/Database', - ], + 'Database' => ['description' => 'The database.', '$ref' => '#/components/schemas/Database', 'title' => '', 'example' => ''], 'HighLightList' => [ - 'title' => '返回高亮文本', - 'description' => 'The returned highlighted text.'."\n", + 'title' => '', + 'description' => 'The highlighted text.', 'type' => 'array', - 'items' => [ - 'description' => 'The returned highlighted text.'."\n", - '$ref' => '#/components/schemas/HighLight', - ], + 'items' => ['description' => 'The highlighted text.', '$ref' => '#/components/schemas/HighLight', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'TotalCount' => [ - 'title' => '满足匹配条件的总的Database个数', - 'description' => 'Total number of databases that meet the match conditions'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11000', - ], + 'TotalCount' => ['description' => 'The total number of databases that match the search criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '11000', 'title' => ''], ], + 'example' => '', ], 'TableResult' => [ - 'title' => '返回的table result', - 'description' => 'The returned table information.'."\n", + 'title' => '', + 'description' => 'The table result.', 'type' => 'object', 'properties' => [ 'Tables' => [ - 'title' => '返回的TableList', - 'description' => 'The returned tables.'."\n", + 'title' => '', + 'description' => 'A list of tables.', 'type' => 'array', 'items' => [ - 'description' => 'The metadata table.'."\n", + 'description' => 'The metadata table.', 'type' => 'object', 'properties' => [ - 'Table' => [ - 'title' => '返回的Table', - 'description' => 'The returned table.'."\n", - '$ref' => '#/components/schemas/Table', - ], + 'Table' => ['description' => 'The table.', '$ref' => '#/components/schemas/Table', 'title' => '', 'example' => ''], 'HighLightList' => [ - 'title' => '返回的高亮文本', - 'description' => 'The returned highlighted text.'."\n", + 'title' => '', + 'description' => 'The highlighted text.', 'type' => 'array', - 'items' => [ - 'description' => 'The returned highlighted text.'."\n", - '$ref' => '#/components/schemas/HighLight', - ], + 'items' => ['description' => 'The highlighted text.', '$ref' => '#/components/schemas/HighLight', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'TotalCount' => [ - 'title' => '满足匹配条件的总的Table个数', - 'description' => 'The total number of tables that meet the match conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1100', - ], + 'TotalCount' => ['description' => 'The total number of tables that match the search criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '1100', 'title' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"460C862F-BB91-5C04-BC3F-946EEF467862\\",\\n \\"Success\\": true,\\n \\"DatabaseResult\\": {\\n \\"Databases\\": [\\n {\\n \\"Database\\": {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 11000\\n },\\n \\"TableResult\\": {\\n \\"Tables\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1100\\n }\\n}","type":"json"}]', 'title' => 'Search', - 'description' => 'Metadata search'."\n", - ], - 'CreateRole' => [ - 'summary' => 'In the Data Lake Permissions section, add a role.', - 'path' => '/api/metastore/auth/roles', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'summary' => 'Retrieves metadata.', + 'description' => 'Retrieves metadata.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Search'], + ], ], - 'tags' => [ - 'user_permission', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:Search', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"460C862F-BB91-5C04-BC3F-946EEF467862\\",\\n \\"Success\\": true,\\n \\"DatabaseResult\\": {\\n \\"Databases\\": [\\n {\\n \\"Database\\": {\\n \\"CreateTime\\": 1608707407,\\n \\"Description\\": \\"this is a hive database\\",\\n \\"LocationUri\\": \\"/hdfs/hivedb/data\\",\\n \\"Name\\": \\"database_test\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"root\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 11000\\n },\\n \\"TableResult\\": {\\n \\"Tables\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [],\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1100\\n }\\n}","type":"json"}]', + ], + 'SearchAcrossCatalog' => [ + 'summary' => 'Searches for databases, tables, and columns across catalogs.', + 'path' => '/api/metastore/catalogs/search/search-across-catalog', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -11833,85 +9383,248 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'SearchText' => ['description' => 'The search query.', 'type' => 'string', 'required' => false, 'example' => 'tags:tag1 or comment:^iso and name=aliyun and (createTime > "20211111" and createTime < "20211117") and has category', 'title' => ''], + 'SortCriteria' => [ + 'title' => '', + 'description' => 'The sorting criteria.', + 'type' => 'array', + 'items' => ['description' => 'The sorting criteria.', '$ref' => '#/components/schemas/SortCriterion', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'PageSize' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => '', 'required' => false], + 'PageNumber' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], + 'CatalogIds' => [ + 'description' => 'The catalog IDs. If this parameter is not specified, all catalogs are searched.', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/ListString', + 'title' => '', + 'required' => false, + 'example' => '', + ], + 'SearchTypes' => ['description' => 'The search types. Valid values: ALL, CATALOG, DATABASE, and TABLE.', '$ref' => '#/components/schemas/ListString', 'title' => '', 'required' => false, 'example' => ''], + ], 'required' => false, - '$ref' => '#/components/schemas/RoleInput', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '77BC2016-BA80-570F-BD15-2FB80281FED6', - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '460C862F-BB91-5C04-BC3F-946EEF467862', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'DatabaseResult' => [ + 'title' => '', + 'description' => 'The database search results.', + 'type' => 'object', + 'properties' => [ + 'Databases' => [ + 'title' => '', + 'description' => 'The databases.', + 'type' => 'array', + 'items' => [ + 'description' => 'Database information.', + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => 'The database.', '$ref' => '#/components/schemas/Database', 'title' => '', 'example' => ''], + 'HighLightList' => [ + 'title' => '', + 'description' => 'The highlighted text.', + 'type' => 'array', + 'items' => ['description' => 'The highlighted text.', '$ref' => '#/components/schemas/HighLight', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of databases that match the search criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '11000', 'title' => ''], + ], + 'example' => '', ], - 'Message' => [ - 'title' => 'message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', + 'TableResult' => [ + 'title' => '', + 'description' => 'The table search results.', + 'type' => 'object', + 'properties' => [ + 'Tables' => [ + 'title' => '', + 'description' => 'The tables.', + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of the table result.', + 'type' => 'object', + 'properties' => [ + 'Table' => ['description' => 'The table.', '$ref' => '#/components/schemas/Table', 'title' => '', 'example' => ''], + 'HighLightList' => [ + 'title' => '', + 'description' => 'The highlighted text.', + 'type' => 'array', + 'items' => ['description' => 'The highlighted text.', '$ref' => '#/components/schemas/HighLight', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of tables that match the search criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '1100', 'title' => ''], + ], + 'example' => '', ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'CatalogResult' => [ + 'title' => '', + 'description' => 'The catalog search results.', + 'type' => 'object', + 'properties' => [ + 'Catalogs' => [ + 'description' => 'The catalogs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The catalog details.', + 'type' => 'object', + 'properties' => [ + 'Catalog' => ['description' => 'The catalog details.', '$ref' => '#/components/schemas/Catalog', 'title' => '', 'example' => ''], + 'HighLightList' => [ + 'description' => 'The highlighted text.', + 'type' => 'array', + 'items' => ['description' => 'Highlighted text.', '$ref' => '#/components/schemas/HighLight', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of catalogs that match the search criteria.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"77BC2016-BA80-570F-BD15-2FB80281FED6\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateRole', - ], - 'GrantRoleToUsers' => [ - 'summary' => 'Grant a Data Lake role to multiple users.', - 'path' => '/api/metastore/auth/roles/grantusers', - 'methods' => [ - 'put', + 'title' => 'SearchAcrossCatalog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAcrossCatalog'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:SearchAcrossCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"460C862F-BB91-5C04-BC3F-946EEF467862\\",\\n \\"Success\\": true,\\n \\"DatabaseResult\\": {\\n \\"Databases\\": [\\n {\\n \\"Database\\": {\\n \\"CreateTime\\": 1608707407,\\n \\"Description\\": \\"this is a hive database\\",\\n \\"LocationUri\\": \\"/hdfs/hivedb/data\\",\\n \\"Name\\": \\"database_test\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 1606226844,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"Grantor\\",\\n \\"GrantorType\\": \\"GrantorType\\",\\n \\"Privilege\\": \\"Privilege\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"root\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 11000\\n },\\n \\"TableResult\\": {\\n \\"Tables\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"comment_day\\",\\n \\"Name\\": \\"day\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": false,\\n \\"CreateTime\\": 1608707407,\\n \\"CreatedBy\\": \\"zhangsan\\",\\n \\"DatabaseName\\": \\"database_test\\",\\n \\"LastAccessTime\\": 1608707407,\\n \\"LastAnalyzedTime\\": 1608707407,\\n \\"Owner\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": [],\\n \\"Retention\\": 30000,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat\\",\\n \\"Location\\": \\"file:///tmp/table\\",\\n \\"NumBuckets\\": 10,\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"name\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"{“col1”:\\\\\\"val1\\\\\\"}\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"col1\\",\\n \\"Order\\": 1\\n }\\n ],\\n \\"StoredAsSubDirectories\\": false\\n },\\n \\"TableName\\": \\"table_name\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"Temporary\\": false,\\n \\"UpdateTime\\": 1608707407,\\n \\"ViewExpandedText\\": \\"\'\'\\",\\n \\"ViewOriginalText\\": \\"\'\'\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"VersionId\\": 5\\n }\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1100\\n },\\n \\"CatalogResult\\": {\\n \\"Catalogs\\": [\\n {\\n \\"Catalog\\": {\\n \\"CatalogId\\": \\"1344371\\",\\n \\"Description\\": \\"测试\\",\\n \\"LocationUri\\": \\"oss://dlf-test-oss-location/\\",\\n \\"Owner\\": \\"acs:ram::[accountId]:root\\",\\n \\"CreatedBy\\": \\"acs:ram::[accountId]:root\\\\n\\",\\n \\"CreateTime\\": 1640662815,\\n \\"UpdateTime\\": 1640662815,\\n \\"Status\\": \\"CREATED\\",\\n \\"CatalogType\\": \\"HMS\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100\\n }\\n}","type":"json"}]', + ], + 'StopMigrationWorkflow' => [ + 'path' => '/webapi/migration/workflow/stop', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the migration task instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'M-6DCF5D8EF92E2195', 'title' => ''], + ], ], - 'operationType' => 'readAndWrite', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'StopMigrationWorkflow', + 'summary' => 'Stops a metadata migration task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopMigrationWorkflow'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:StopMigrationWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'SubmitQuery' => [ + 'path' => '/webapi/query/submitQueryRequestBody', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '114170', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -11919,209 +9632,171 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The HTTP request body.'."\n", + 'description' => 'The HTTP request body.', 'type' => 'object', 'properties' => [ - 'RoleName' => [ - 'title' => 'RoleName', - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_role_8', - ], - 'Users' => [ - 'description' => 'The RAM users or roles to which you want to assign the role. Format:'."\n" - ."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" - .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Principals', - ], + 'sql' => ['description' => 'The SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'show databases', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'WS-A129E61C4892D2B4', 'title' => ''], + 'catalogId' => ['description' => 'The data catalog ID.', 'type' => 'string', 'required' => false, 'example' => 'catalog1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returns the message body.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4316D7DA-9816-596D-A3D7-12676FA59BDA', - ], - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => 'Q-14475CF9B51FCE5E', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '279AA630-A8ED-5EA9-80A3-2E213D63548C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '{ "success" : true }', + 'title' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4316D7DA-9816-596D-A3D7-12676FA59BDA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GrantRoleToUsers', - ], - 'GrantRolesToUser' => [ - 'summary' => 'Grant multiple roles to a single user.', - 'path' => '/api/metastore/auth/roles/grantroles', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Query.ClusterNotReady', 'errorMessage' => 'Query cluster is not ready. Please try again later.', 'description' => 'Query cluster is not ready, please wait a few seconds and retry'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'SubmitQuery', + 'summary' => 'Submits an SQL query.', + 'description' => '- This API operation is suitable for small and medium-sized queries running for less than an hour.'."\n" + ."\n" + .'- A maximum of 10,000 rows are returned for each query.'."\n" + ."\n" + .'- Concurrent execution is limited for a single Alibaba Cloud account. If you submit multiple queries at the same time, the queries are queued.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'tags' => [ - 'user_permission', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:SubmitQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"Q-14475CF9B51FCE5E\\",\\n \\"RequestId\\": \\"279AA630-A8ED-5EA9-80A3-2E213D63548C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UnLock' => [ + 'summary' => 'Releases the specified metadata lock.', + 'path' => '/api/metastore/catalogs/databases/tables/locks', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '114171', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'LockId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The lock ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11709'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RoleNames' => [ - 'title' => '待授权的角色名列表', - 'description' => 'The roles to be assigned to the user.', - 'required' => true, - '$ref' => '#/components/schemas/ListString', - ], - 'User' => [ - 'description' => 'The user to which you want to assign roles. Format:'."\n" - ."\n" - .'* RAM roles: acs:ram::\\[accountId]:role/\\[roleName].'."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].', - 'required' => true, - '$ref' => '#/components/schemas/Principal', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '37C8470A-5E6D-5E4E-AEF0-EA3EBE9C89EE'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], - 'required' => false, + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '5XX' => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876', - ], - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GrantRolesToUser', - ], - 'GrantPermissions' => [ - 'summary' => 'Grant the operation permissions on resources to the User /Data Lake role.', - 'path' => '/api/metastore/auth/permissions/grant', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'UnLock', + 'requestParamsDescription' => 'The ID of the lock. This ID is returned by the CreateLock operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnLock'], + ], ], - 'tags' => [ - 'user_permission', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UnLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"37C8470A-5E6D-5E4E-AEF0-EA3EBE9C89EE\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateCatalog' => [ + 'summary' => 'Updates a catalog.', + 'path' => '/api/metastore/catalogs', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -12129,544 +9804,452 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The request body, in JSON format.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '授权的类型，目前仅支持hive', - 'description' => 'The authorization type. Only Hive is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hive', - 'enum' => [ - 'hive', - ], - ], - 'MetaResource' => [ - 'title' => '授权meta资源', - 'description' => 'The metadata resource to be authorized.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/MetaResource', - ], - 'Accesses' => [ - 'title' => '授权的accesses列表', - 'description' => 'The list of the access permissions to be granted.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Accesses', - ], - 'DelegateAccesses' => [ - 'title' => '授权的grantable accesses列表', - 'description' => 'The list of the grantable access permissions to be granted.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Accesses', - ], - 'Principal' => [ - 'title' => '授权的用户/角色principal', - 'description' => 'The users or roles to be authorized. Formats:'."\n" - ."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n" - .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n" - .'* Data lake role: acs:dlf::\\[accountId]:role/\\[roleName]'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Principal', - ], - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'CatalogInput' => ['description' => 'The details of the catalog to update.', 'required' => true, '$ref' => '#/components/schemas/CatalogInput', 'title' => '', 'example' => ''], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message Code', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4912024D-2A06-5E9F-9667-35D9319917D7', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '64E46067-49EA-5A91-A7B1-E812E18FC243'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"4912024D-2A06-5E9F-9667-35D9319917D7\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GrantPermissions', - ], - 'BatchGrantPermissions' => [ - 'summary' => 'Grant the operation permissions on resources to a user or a data lake role at a time.', - 'path' => '/api/metastore/auth/permissions/batchgrant', - 'methods' => [ - 'post', + 'title' => 'UpdateCatalog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCatalog'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"64E46067-49EA-5A91-A7B1-E812E18FC243\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateCatalogSettings' => [ + 'summary' => 'Updates the configuration of a catalog. This operation requires the admin role or a higher role.', + 'path' => '/api/metastore/catalogs/settings', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => [], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', + 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '授权的类型，目前仅支持hive', - 'description' => 'The authorization type. Only Hive is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hive', - 'enum' => [ - 'hive', - ], - ], - 'GrantRevokeEntries' => [ - 'title' => '待授权列表', - 'description' => 'The list of the items to be authorized.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the item to be authorized.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/GrantRevokeEntry', - ], - 'required' => false, - ], - 'CatalogId' => [ - 'title' => 'catalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'CatalogSettings' => ['description' => 'The catalog settings.', '$ref' => '#/components/schemas/CatalogSettings', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message Code', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'BatchGrantRevokeFailureResult' => [ - 'title' => 'result', - 'description' => 'The result returned when batch authorization failed.'."\n", - 'example' => '', - '$ref' => '#/components/schemas/BatchGrantRevokeFailureResult', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '01D8DD6B-4929-5999-9BB3-950AA30E3BD0'], + 'Code' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"BatchGrantRevokeFailureResult\\": [\\n {\\n \\"GrantRevokeEntry\\": {\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"Id\\": \\"\\"\\n },\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'BatchGrantPermissions', - ], - 'DeleteRole' => [ - 'summary' => 'Delete a role from Data Lake Permissions.', - 'path' => '/api/metastore/auth/roles', - 'methods' => [ - 'delete', + 'title' => 'UpdateCatalogSettings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCatalogSettings'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateCatalogSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D8DD6B-4929-5999-9BB3-950AA30E3BD0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateDatabase' => [ + 'summary' => 'Updates the details of a database in a data lake.', + 'path' => '/api/metastore/catalogs/databases', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '114162', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'RoleName', - 'in' => 'query', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'roleName', - 'description' => 'The name of the role to be deleted.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The HTTP request body in JSON format.', + 'type' => 'object', + 'properties' => [ + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseInput' => ['description' => 'The new database.', '$ref' => '#/components/schemas/DatabaseInput', 'required' => false, 'title' => '', 'example' => ''], + 'Name' => ['title' => '', 'description' => 'The original name of the database. If the name is not changed, only other metadata is updated.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + ], 'required' => false, - 'example' => 'roleId/roleName至少有一个是非空', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status description.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '161F5EFC-E97E-43C0-AACF-FF18FAC912F0'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteRole', - ], - 'RevokeRoleFromUsers' => [ - 'summary' => 'Removes multiple users from a single data lake role.', - 'path' => '/api/metastore/auth/roles/revokeusers', - 'methods' => [ - 'put', + 'title' => 'UpdateDatabase', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- AlreadyExists: The new database name already exists.'."\n" + ."\n" + .'- NoSuchObject: The specified database does not exist.'."\n" + ."\n" + .'- InternalError: Other types of errors. For more information, see the Message parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatabase'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"161F5EFC-E97E-43C0-AACF-FF18FAC912F0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateFunction' => [ + 'summary' => 'Updates a user-defined function in a database of a data lake.', + 'path' => '/api/metastore/catalogs/databases/functions', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '114434', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'body', + 'name' => 'Body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The HTTP request body.'."\n", + 'title' => '', + 'description' => 'The request body in JSON format.', 'type' => 'object', 'properties' => [ - 'RoleName' => [ - 'title' => '待revoke的角色', - 'description' => 'The role that you want to revoke from users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_role_3', - ], - 'Users' => [ - 'title' => '待revoke的用户列表', - 'description' => 'The RAM users or roles from which you want to revoke the role. Format:'."\n" - ."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" - .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Principals', - ], + 'CatalogId' => ['description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test', 'title' => ''], + 'FunctionInput' => ['description' => 'The details of the function to update.', '$ref' => '#/components/schemas/FunctionInput', 'required' => false, 'title' => '', 'example' => ''], + 'FunctionName' => ['description' => 'The name of the function.', 'type' => 'string', 'required' => false, 'example' => 'func2', 'title' => ''], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Code' => [ - 'title' => 'Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'title' => '', + 'description' => 'Code', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RevokeRoleFromUsers', - ], - 'RevokeRolesFromUser' => [ - 'summary' => 'Removes multiple roles from a single user.', - 'path' => '/api/metastore/auth/roles/revokeroles', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'UpdateFunction', + 'responseParamsDescription' => 'Code: The error code.<br>'."\n" + .'InvalidObject: The specified metadatabase, table, or function does not exist, or a function parameter is empty.<br>'."\n" + .'InternalError: An internal error occurred. See the Message parameter for more information.<br><br>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunction'], + ], ], - 'tags' => [ - 'user_permission', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdatePartitionColumnStatistics' => [ + 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '114433', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'body', + 'name' => 'UpdateTablePartitionColumnStatisticsRequest', 'in' => 'body', - 'style' => 'json', + 'style' => 'flat', + 'schema' => ['description' => 'The parameters for updating the statistics of a table partition.', '$ref' => '#/components/schemas/UpdateTablePartitionColumnStatisticsRequest', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RoleNames' => [ - 'title' => '待删除的角色列表', - 'description' => 'The RAM roles to be revoked from the RAM user.', - 'required' => true, - '$ref' => '#/components/schemas/ListString', - ], - 'User' => [ - 'title' => '针对该用户进行revoke', - 'description' => 'The RAM user from whom you want to revoke roles. Format:'."\n" - ."\n" - .'* RAM roles: acs:ram::\\[accountId]:role/\\[roleName].'."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].', - 'required' => true, - '$ref' => '#/components/schemas/Principal', - ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], - 'required' => false, + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '5XX' => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RevokeRolesFromUser', - ], - 'RevokePermissions' => [ - 'summary' => 'Cancels the operation permissions on resources granted to a User /Data Lake role.', - 'path' => '/api/metastore/auth/permissions/revoke', - 'methods' => [ - 'post', + 'title' => 'UpdatePartitionColumnStatistics', + 'summary' => 'Creates or updates the column statistics for a data table partition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePartitionColumnStatistics'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdatePartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdatePermissions' => [ + 'summary' => 'Updates the permissions of a user or a DLF role.', + 'path' => '/api/metastore/auth/permissions/', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -12674,255 +10257,198 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'description' => 'The HTTP request body, in the JSON format.', 'type' => 'object', 'properties' => [ 'Type' => [ - 'title' => '取消授权的类型，目前仅支持hive', - 'description' => 'The permission revocation type. Only Hive is supported.'."\n", + 'description' => 'The authorization type. Only Hive is supported.', 'type' => 'string', 'required' => true, + 'enum' => ['hive'], + 'title' => '', 'example' => 'Hive', - 'enum' => [ - 'hive', - ], - ], - 'MetaResource' => [ - 'title' => '取消授权meta资源', - 'description' => 'The metadata resource for which permissions need to be revoked.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/MetaResource', - ], - 'Accesses' => [ - 'title' => '取消授权的accesses列表', - 'description' => 'The access permissions that need to be revoked.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Accesses', - ], - 'DelegateAccesses' => [ - 'title' => '取消授权的grantable accesses列表', - 'description' => 'The grantable access permissions that need to be revoked. This parameter is unavailable.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Accesses', - ], - 'Principal' => [ - 'title' => '取消授权的用户/角色principal', - 'description' => 'The user or role whose permissions need to be revoked. Formats:'."\n" - ."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n" - .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n" - .'* Data lake role: acs:dlf::\\[accountId]:role/\\[roleName]'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Principal', - ], - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', ], + 'MetaResource' => ['description' => 'The metadata resource to grant permissions.', 'required' => true, '$ref' => '#/components/schemas/MetaResource', 'title' => '', 'example' => ''], + 'Accesses' => ['description' => 'The access permissions to grant.', 'required' => true, '$ref' => '#/components/schemas/Accesses', 'title' => '', 'example' => ''], + 'DelegateAccesses' => ['description' => 'The grantable access permissions. This parameter is not available.', 'required' => true, '$ref' => '#/components/schemas/Accesses', 'title' => '', 'example' => ''], + 'Principal' => ['description' => 'The user or role to grant permissions. The format is as follows:'."\n" + ."\n" + .'- RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" + ."\n" + .'- RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n" + ."\n" + .'- Data lake role: acs:dlf::\\[accountId]:role/\\[roleName].', 'required' => true, '$ref' => '#/components/schemas/Principal', 'title' => '', 'example' => ''], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7CB5765C-F209-5B10-8792-D2BE9156ABE8', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"7CB5765C-F209-5B10-8792-D2BE9156ABE8\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RevokePermissions', - ], - 'BatchRevokePermissions' => [ - 'summary' => 'You can call this operation to revoke permissions on resources from a user or data lake role at a time.', - 'path' => '/api/metastore/auth/permissions/batchrevoke', - 'methods' => [ - 'post', + 'title' => 'UpdatePermissions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePermissions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdatePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateRegisteredLocation' => [ + 'path' => '/webapi/locations', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'Body', + 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '授权的类型，目前仅支持hive', - 'description' => 'The authorization type. Set the value to Hive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hive', - 'enum' => [ - 'hive', - ], - ], - 'GrantRevokeEntries' => [ - 'title' => '待授权列表', - 'description' => 'The permissions to be revoked.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details the permissions to be revoked.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/GrantRevokeEntry', - ], - 'required' => false, - ], - 'CatalogId' => [ - 'title' => 'catalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'LocationId' => ['description' => 'The location ID.'."\n" + ."\n" + .'> Call the RegisterLocation operation to obtain the location ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LOC-AB8FBC17F95A4AF5', 'title' => ''], + 'InventoryCollectEnabled' => ['description' => 'Specifies whether to enable OSS inventory.', 'type' => 'boolean', 'docRequired' => false, 'required' => false, 'example' => 'true', 'title' => ''], + 'OssLogCollectEnabled' => ['description' => 'Specifies whether to enable OSS logging.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The returned message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message Code', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C9E535E1-F040-56F4-B4EE-592B555DAE19', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'BatchGrantRevokeFailureResult' => [ - 'title' => 'result', - 'description' => 'The result returned when batch permission revocation failed.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8030C902-C25B-1839-867D-E6F70A5B9810'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'LocationId' => ['description' => 'The location ID.', 'type' => 'string', 'example' => 'LOC-AB8FBC17F95A4AF5', 'title' => ''], + 'StorageCollectTaskOperationResultList' => [ + 'description' => 'The results for updating collection tasks.', + 'type' => 'array', + 'items' => ['description' => 'The result for updating a collection task.', '$ref' => '#/components/schemas/StorageCollectTaskOperationResult', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', 'example' => '', - '$ref' => '#/components/schemas/BatchGrantRevokeFailureResult', ], ], + 'example' => '', + ], + ], + ], + 'title' => 'UpdateRegisteredLocation', + 'summary' => 'Updates a registered location.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRegisteredLocation'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateRegisteredLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"C9E535E1-F040-56F4-B4EE-592B555DAE19\\",\\n \\"Success\\": true,\\n \\"BatchGrantRevokeFailureResult\\": [\\n {\\n \\"GrantRevokeEntry\\": {\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"Id\\": \\"\\"\\n },\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'BatchRevokePermissions', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8030C902-C25B-1839-867D-E6F70A5B9810\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": false,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], 'UpdateRole' => [ 'summary' => 'Updates a role that has the data lake permissions.', 'path' => '/api/metastore/auth/roles', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'user_permission', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -12933,85 +10459,66 @@ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'RoleName' => [ - 'title' => 'RoleName', - 'description' => 'The role name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '原始名称', - ], - 'RoleInput' => [ - 'description' => 'The input information of the updated role.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/RoleInput', - ], + 'RoleName' => ['title' => '', 'description' => 'The role name.'."\n", 'type' => 'string', 'required' => false, 'example' => '原始名称'], + 'RoleInput' => ['description' => 'The input information of the updated role.'."\n", 'required' => false, '$ref' => '#/components/schemas/RoleInput', 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', + 'title' => '', 'description' => 'Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '604E5919-C6FF-54CE-9C23-C5350E6F5415', - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '604E5919-C6FF-54CE-9C23-C5350E6F5415'], + 'Code' => ['title' => '', 'description' => 'The status of the request.'."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"604E5919-C6FF-54CE-9C23-C5350E6F5415\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'UpdateRole', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRole'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"604E5919-C6FF-54CE-9C23-C5350E6F5415\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'UpdateRoleUsers' => [ - 'summary' => 'Update the user in the role to include ram user/ram role.', + 'summary' => 'Updates users for a DLF role.', 'path' => '/api/metastore/auth/updateroleusers', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'user_permission', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['user_permission'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ @@ -13019,9 +10526,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '119306', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', - ], + 'abilityTreeNodes' => ['FEATUREdlfOUR1X3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -13030,105 +10535,84 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The HTTP request body.'."\n", + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'RoleName' => [ - 'title' => 'Role名称', - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_role_8', - ], - 'Users' => [ - 'description' => 'The list of users or roles. Format:'."\n" - ."\n" - .'RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n" - ."\n" - .'RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Principals', - ], + 'RoleName' => ['description' => 'The name of the role.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test_role_8'], + 'Users' => ['description' => 'The users. The format is as follows:'."\n" + ."\n" + .'RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" + ."\n" + .'RAM role: acs:ram::\\[accountId]:role/\\[roleName].', '$ref' => '#/components/schemas/Principals', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'UpdateRoleUsers', - ], - 'UpdatePermissions' => [ - 'summary' => 'Update the permissions of the User /Data Lake role.', - 'path' => '/api/metastore/auth/permissions/', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoleUsers'], + ], ], - 'tags' => [ - 'user_permission', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateRoleUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateTable' => [ + 'summary' => 'Updates the information of a data table in a data lake.', + 'path' => '/api/metastore/catalogs/databases/tables', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ @@ -13136,2694 +10620,2728 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", + 'title' => '', + 'description' => 'The HTTP request body. It must be in JSON format.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '授权的类型，目前仅支持hive', - 'description' => 'The type of the authorization. Only Hive is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hive', - 'enum' => [ - 'hive', - ], - ], - 'MetaResource' => [ - 'title' => '授权meta资源', - 'description' => 'The metadata resource to be authorized.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/MetaResource', - ], - 'Accesses' => [ - 'title' => '授权的accesses列表', - 'description' => 'The list of access permissions to be authorized.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Accesses', - ], - 'DelegateAccesses' => [ - 'title' => '授权的grantable accesses列表', - 'description' => 'The list of access permissions that can be delegated. This parameter is unavailable.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Accesses', - ], - 'Principal' => [ - 'title' => '授权的用户/角色principal', - 'description' => 'The authorized users or roles. Formats:'."\n" - ."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n" - .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n" - .'* Data lake role: acs:dlf::\\[accountId]:role/\\[roleName]'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Principal', - ], - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], + 'CatalogId' => ['title' => '', 'description' => 'The ID of the data catalog.', 'type' => 'string', 'required' => false, 'example' => '1344371'], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'], + 'SkipArchive' => ['title' => '', 'description' => 'By default, updating a data table creates a new archived version. If you set SkipArchive to true, no new version is created.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'TableInput' => ['description' => 'The detailed information of the data table after the update.', '$ref' => '#/components/schemas/TableInput', 'required' => false, 'title' => '', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'], + 'IsAsync' => ['title' => '', 'description' => 'Specifies whether to perform an asynchronous update.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AllowPartitionKeyChange' => ['title' => '', 'description' => 'Specifies whether to allow updates to the partition key.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message Code', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], + 'TaskId' => ['title' => '', 'description' => 'The ID of the asynchronous task.', 'type' => 'string', 'example' => 'aa689782deb97265701f57324fc4ae42'], ], + 'example' => '', ], ], '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdatePermissions', - ], - 'UpdateCatalogSettings' => [ - 'summary' => 'To update the configurations of Data Lake Catalog, you must assume the admin role or more.', - 'path' => '/api/metastore/catalogs/settings', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'UpdateTable', + 'requestParamsDescription' => 'IsAsync:'."\n" + ."\n" + .'- true: Specifies an asynchronous invocation. The API returns a response immediately without waiting for the background task to complete. The response includes a task ID that the client can use to query the task status.'."\n" + ."\n" + .'- false: Specifies a synchronous call. The API returns a response only after the background task is complete. If the background task takes a long time, the request might time out.', + 'responseParamsDescription' => 'Error codes:'."\n" + ."\n" + .'- InvalidOperation: The specified database or table does not exist.'."\n" + ."\n" + .'- InternalError: An internal error occurred. For more information, see the Message parameter.'."\n" + ."\n" + .'- TaskId: The UpdateTable operation also updates the information of all partitions in the table. If you perform an asynchronous commit, a task ID is returned. You can use this ID to track the status of the asynchronous task. This parameter is not returned for synchronous commits.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTable'], + ], ], - 'tags' => [ - 'user_permission', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"aa689782deb97265701f57324fc4ae42\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateTableColumnStatistics' => [ + 'summary' => 'Creates or updates the column statistics for a data table.', + 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', - ], + 'abilityTreeNodes' => ['FEATUREdlf4RLCBT'], ], 'parameters' => [ [ - 'name' => 'body', + 'name' => 'UpdateTablePartitionColumnStatisticsRequest', 'in' => 'body', - 'style' => 'json', + 'style' => 'flat', + 'schema' => ['description' => 'The update parameters.', '$ref' => '#/components/schemas/UpdateTablePartitionColumnStatisticsRequest', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The HTTP request body.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - 'CatalogSettings' => [ - 'description' => 'The catalog configuration.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/CatalogSettings', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '.'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'], ], - 'required' => false, + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '5XX' => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returns the message body.'."\n", + 'title' => '', + 'description' => 'Code', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '01D8DD6B-4929-5999-9BB3-950AA30E3BD0', - ], - 'Code' => [ - 'title' => 'Code', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Whether the operation is successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The operation failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D8DD6B-4929-5999-9BB3-950AA30E3BD0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateCatalogSettings', + 'title' => 'UpdateTableColumnStatistics', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTableColumnStatistics'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateTableColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetRole' => [ - 'summary' => 'Obtain the role in Data Lake Permissions based on the role name.', - 'path' => '/api/metastore/auth/roles', - 'methods' => [ - 'get', + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dlf.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dlf.ap-southeast-1.aliyuncs.com', 'vpc' => 'datalake-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dlf.cn-beijing.aliyuncs.com', 'endpoint' => 'dlf.cn-beijing.aliyuncs.com', 'vpc' => 'datalake-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dlf.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dlf.cn-hangzhou.aliyuncs.com', 'vpc' => 'datalake-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dlf.cn-shanghai.aliyuncs.com', 'endpoint' => 'dlf.cn-shanghai.aliyuncs.com', 'vpc' => 'datalake-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dlf.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dlf.cn-shenzhen.aliyuncs.com', 'vpc' => 'datalake-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dlf.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'dlf.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'datalake-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dlf.us-east-1.aliyuncs.com', 'endpoint' => 'dlf.us-east-1.aliyuncs.com', 'vpc' => 'dlf-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dlf.eu-central-1.aliyuncs.com', 'endpoint' => 'dlf.eu-central-1.aliyuncs.com', 'vpc' => 'datalake-vpc.eu-central-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'Action.BlueprintInstance.Run.Failed', 'message' => 'Failed to run the blueprint instance.', 'http_code' => 400, 'description' => ''], + ['code' => 'Action.Unsupported', 'message' => 'The operation is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'AlreadyExists', 'message' => 'Database, table, partition or function already exists.', 'http_code' => 409, 'description' => ''], + ['code' => 'InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidObject', 'message' => 'The object is invalid. The issue is due to one of the following. Incomplete partition name/invalid partition column/invalid skew column/storage descriptor cannot be null/invalid table columns/invalid object name/cannot find database or table.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOperation', 'message' => 'The operation is invalid. Scenario 1: Corresponding Table or Database does not exist. Scenario 2: Unable to access old location. The new location of the table is on a different file system than the old location. Scenario 3: The name of table or partition already exists when you rename.', 'http_code' => 403, 'description' => ''], + ['code' => 'InvalidParams', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParams.Empty', 'message' => 'You must specify the parameter.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSuchObject', 'message' => 'Cannot find corresponding object. Scenario 1: Column stats does not exist. Scenario 2: Database does not exist. Scenario 3: Function does not exist. Scenario 4: Partition does not exist. Scenario 5: Table does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'Query.ClusterNotReady', 'message' => 'Query cluster is not ready. Please try again later.', 'http_code' => 400, 'description' => 'Query cluster is not ready, please wait a few seconds and retry'], + ['code' => 'Query.PageNumOverLimit', 'message' => 'The page number limit is exceeded. Please export to get more data.', 'http_code' => 400, 'description' => 'Page number over limit, please export to get more data'], + ['code' => 'Query.ResultExpired', 'message' => 'Query result cache expired. Please export results in history query.', 'http_code' => 400, 'description' => 'Query result cache expired, please export result in history query'], + ['code' => 'Query.TempDBNotExist', 'message' => 'The temp database does not exist. Please configure OSS path first.', 'http_code' => 400, 'description' => 'Temp database not exist, please config oss path first'], + ['code' => 'RAM.Permission.NotAllow', 'message' => 'You are not authorized to perform the operation. Please use RAM to authorize the operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'RequestEntityTooLarge', 'message' => 'Request Entity Too Large.', 'http_code' => 413, 'description' => 'The request body is too large, such as too many request parameters and parameter values are too long.'], + ['code' => 'Resource.BlueprintInstance.NotExist', 'message' => 'The blueprint instance does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'Resource.Workflow.NotExist', 'message' => 'The workflow does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnknownDB', 'message' => 'Unable to ${action} database.', 'http_code' => 404, 'description' => ''], + ['code' => 'UnknownPartition', 'message' => 'Unable to ${action} partition.', 'http_code' => 404, 'description' => ''], + ['code' => 'UnknownTable', 'message' => '${tableName} does not exist.', 'http_code' => 404, 'description' => ''], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunMigrationWorkflow'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunction'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetPartitions'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatabases'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLock'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRegisteredLocation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantPermissions'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableProfile'], + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPermissions'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopMigrationWorkflow'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunction'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateTables'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTableVersion'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Search'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePartitionColumnStatistics'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitions'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePartitionColumnStatistics'], + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRole'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdatePartitions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLifecycleRule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchRevokePermissions'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPartition'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteTableVersions'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoleUsers'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeRoleFromUsers'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctions'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTable'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableVersion'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortLock'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoleUsers'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserRoles'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTable'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteTables'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantRolesToUser'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameTable'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshLock'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePermissions'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePartition'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCatalogSettings'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionsProfile'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnLock'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLock'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCatalog'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabase'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunction'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreatePartitions'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionNames'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAcrossCatalog'], + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckPermissions'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenamePartition'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCatalog'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateTables'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTable'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTableColumnStatistics'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTableNames'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatabase'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableColumnStatistics'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetPartitionColumnStatistics'], + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRole'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionNames'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeRolesFromUser'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPartitionColumnStatistics'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionsByFilter'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeregisterLocation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabaseProfile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterLocation'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPartitionsByExpr'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePartition'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatabase'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTableColumnStatistics'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTableVersions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGrantPermissions'], + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRole'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCatalog'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeletePartitions'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncTaskStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokePermissions'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCatalogs'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRole'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTable'], + ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTables'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatabase'], + ['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetTables'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCatalog'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunction'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCatalogSettings'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantRoleToUsers'], + ], + ], + 'ram' => [ + 'productCode' => 'DataLake', + 'productName' => 'Data Lake Formation', + 'ramCodes' => ['dlf'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GrantRolesToUser', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:GrantRolesToUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateDataSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetEtlResourceUsages', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetEtlResourceUsages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListPartitionsByFilter', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionsByFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'DeleteTableColumnStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteTableColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'BatchDeletePartitions', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchDeletePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeBlueprintInstance', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:DescribeBlueprintInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RoleName', - 'in' => 'query', - 'schema' => [ - 'title' => 'roleName', - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'role_name', + [ + 'apiName' => 'GetTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4316D7DA-9816-596D-A3D7-12676FA59BDA', - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Role' => [ - 'title' => 'role', - 'description' => 'The information about the role.'."\n", - '$ref' => '#/components/schemas/Role', - ], - ], + [ + 'apiName' => 'BatchGetTables', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:BatchGetTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4316D7DA-9816-596D-A3D7-12676FA59BDA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"Role\\": {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n }\\n}","type":"json"}]', - 'title' => 'GetRole', - ], - 'ListRoles' => [ - 'summary' => 'You can query the list of data lake roles.', - 'path' => '/api/metastore/auth/roles/list', - 'methods' => [ - 'get', + [ + 'apiName' => 'UpdateWorkspaceConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateWorkspaceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateWorkflowScheduleStatus', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateWorkflowScheduleStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CheckConnection', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dlf:CheckConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchDeleteTables', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchDeleteTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'UpdateDataSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:UpdateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'SubmitUnarchiveTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dlf:SubmitUnarchiveTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetPartition', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '115466', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', + 'ramAction' => [ + 'action' => 'dlf:GetPartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'Next PageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token!', + [ + 'apiName' => 'RefreshLock', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RefreshLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RoleNamePattern', - 'in' => 'query', - 'schema' => [ - 'description' => 'The regular expression that matches the role name. Fuzzy search is supported, such as.\\*test.\\*.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*test.*', + ], + [ + 'apiName' => 'DeleteLifecycleResource', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteLifecycleResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'the number of entries returned on each page, the maximum value is 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '-1/100', + ], + [ + 'apiName' => 'ListProxyAccount', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListProxyAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'NextPageToken' => [ - 'title' => 'data', - 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - 'Roles' => [ - 'title' => 'role list data', - 'description' => 'The list of the roles.'."\n", - 'example' => '['."\n" - .' {'."\n" - .' "Description":"reserved by the system",'."\n" - .' "DisplayName":"admin",'."\n" - .' "UpdateTime":0,'."\n" - .' "IsPredefined":1,'."\n" - .' "Name":"admin"'."\n" - .' }'."\n" - .']', - '$ref' => '#/components/schemas/Roles', - ], - ], + [ + 'apiName' => 'GetRegionStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetRegionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Roles\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListRoles', - ], - 'ListRoleUsers' => [ - 'summary' => 'Gets the list of users for a single role.', - 'path' => '/api/metastore/auth/roles/roleusers', - 'methods' => [ - 'get', + [ + 'apiName' => 'UpdateRoleUsers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateRoleUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeregisterLocation', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeregisterLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeMetastoreCrawler', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DescribeMetastoreCrawler', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'GetUserExtraInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetUserExtraInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RoleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', + [ + 'apiName' => 'CreateLifecycleRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateLifecycleRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The size of each page. The maximum value is 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '-1/100', + ], + [ + 'apiName' => 'StopMigrationWorkflow', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:StopMigrationWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserNamePattern', - 'in' => 'query', - 'schema' => [ - 'title' => 'use name pattern filter', - 'description' => 'The regular expression that matches the user name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*user.*', + ], + [ + 'apiName' => 'ModifyMetastoreCrawler', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:ModifyMetastoreCrawler', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'NextPageToken', - 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token!', + ], + [ + 'apiName' => 'UpdateCatalog', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F', - ], - 'Code' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserRoles' => [ - 'title' => 'user roles', - 'description' => 'The roles assigned to the user.'."\n", - 'example' => '', - '$ref' => '#/components/schemas/UserRoles', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => 'token!', - ], - ], + [ + 'apiName' => 'UpdateRole', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"UserRoles\\": [\\n {\\n \\"Role\\": {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n },\\n \\"GrantTime\\": 0,\\n \\"User\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"token!\\"\\n}","type":"json"}]', - 'title' => 'ListRoleUsers', - ], - 'ListUserRoles' => [ - 'summary' => 'Obtains the list of data lake roles for a single user.', - 'path' => '/api/metastore/auth/roles/userroles', - 'methods' => [ - 'get', + [ + 'apiName' => 'GetLifecycleRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetLifecycleRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CheckBlueprintInstanceName', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CheckBlueprintInstanceName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetFunction', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCrawlerWorkflowInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListCrawlerWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTableColumnStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateTableColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDatabasesWithRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListDatabasesWithRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetIndicatorDetails', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetIndicatorDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDatabase', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '119439', - 'abilityTreeNodes' => [ - 'FEATUREdlfOUR1X3', + [ + 'apiName' => 'GetTableHistoryDetails', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableHistoryDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'PrincipalArn', - 'in' => 'query', - 'schema' => [ - 'description' => 'Used to uniquely identify a RAM user or RAM role. The OSS URL is in the following format:'."\n" - ."\n" - .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n" - .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::1111:user/userName', + [ + 'apiName' => 'GetLifecycleTask', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetLifecycleTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => 'PageSize', - 'description' => 'The size of each page. The maximum value is 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '-1/100', + ], + [ + 'apiName' => 'GetStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RoleNamePattern', - 'in' => 'query', - 'schema' => [ - 'title' => 'role name pattern filter', - 'description' => 'The regular expression that matches the role name. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '.*test.*', + ], + [ + 'apiName' => 'DeleteRole', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:DeleteRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token!', + ], + [ + 'apiName' => 'GetTableColumnStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Code' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserRoles' => [ - 'title' => 'Data', - 'description' => 'The roles assigned to the user.'."\n", - 'example' => '', - '$ref' => '#/components/schemas/UserRoles', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n", - 'type' => 'string', - 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa', - ], - ], + [ + 'apiName' => 'GetDataSource', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"UserRoles\\": [\\n {\\n \\"Role\\": {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n },\\n \\"GrantTime\\": 0,\\n \\"User\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\"\\n}","type":"json"}]', - 'title' => 'ListUserRoles', - ], - 'ListPermissions' => [ - 'summary' => 'Queries permissions.', - 'path' => '/api/metastore/auth/permissions/list', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateBlueprintInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateBlueprintInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateRole', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetPartitionColumnStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetPartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetMigrationWorkflowInstanceLogInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetMigrationWorkflowInstanceLogInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'StopBlueprintInstanceWorkflow', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:StopBlueprintInstanceWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlfT96YCV', + [ + 'apiName' => 'RevokePermissions', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:RevokePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", - 'type' => 'object', - 'properties' => [ - 'Principal' => [ - 'title' => '基于Principal对权限信息进行过滤', - 'description' => 'The principle based on which permission information is filtered.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Principal', - ], - 'NextPageToken' => [ - 'title' => '分页Token', - 'description' => 'A pagination token, which is used to obtain data on the next page. If no pagination token is returned in the response, set this parameter to an empty string ("") or an empty character (\'\').'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token!', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => 'The number of entries to return on each page. Maximum value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'Type' => [ - 'title' => '获取权限信息的类型，目前仅支持hive', - 'description' => 'The type of permission information to be obtained. Only Hive is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hive', - 'enum' => [ - 'hive', - ], - ], - 'MetaResource' => [ - 'title' => '基于资源对权限信息进行过滤', - 'description' => 'The resource based on which permission information is filtered.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/MetaResource', - ], - 'IsListUserRolePermissions' => [ - 'title' => '是否获取用户所属角色的权限', - 'description' => 'Specifies whether to obtain the permissions of the role to which the user belongs. This parameter takes effect only when you specify a specific resource object.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'MetaResourceType' => [ - 'title' => '基于Resource Type进行过滤', - 'description' => 'The type of the resource based on which permission information is filtered, such as database or table. If you do not specify this parameter, permission information is filtered based on both databases and tables.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DATABASE', - ], - 'CatalogId' => [ - 'title' => 'CatalogId', - 'description' => 'The catalog ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', - ], - ], - 'required' => false, + [ + 'apiName' => 'UpdateDatabase', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Response Object', - 'description' => 'The returned message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message Code', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '745EAAE2-5010-5C9F-A95C-B8FC5C1B03BF', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NextPageToken' => [ - 'title' => 'NextPageToken', - 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n", - 'type' => 'string', - 'example' => 'token!', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '', - ], - 'PrincipalResourcePermissionsList' => [ - 'description' => 'The permissions.'."\n", - 'example' => '[]', - '$ref' => '#/components/schemas/PrincipalResourcePermissionsList', - ], - ], + [ + 'apiName' => 'GetMetaDataApiCallUsages', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetMetaDataApiCallUsages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"745EAAE2-5010-5C9F-A95C-B8FC5C1B03BF\\",\\n \\"Success\\": true,\\n \\"NextPageToken\\": \\"token!\\",\\n \\"TotalCount\\": 0,\\n \\"PrincipalResourcePermissionsList\\": [\\n {\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListPermissions', - ], - 'CheckPermissions' => [ - 'summary' => 'Verify user permissions.', - 'path' => '/api/metastore/auth/permissions/check', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListSavedQuery', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListSavedQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListWorkflowInstanceRuntimeLogs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListWorkflowInstanceRuntimeLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyTableServicePolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:ModifyTableServicePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'BatchUpdatePartitions', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchUpdatePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetRdsDBInstanceAttribute', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetRdsDBInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListPermissions', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:ListPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The HTTP request body, in the JSON format.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/AccessRequest', + [ + 'apiName' => 'BatchCreateTables', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchCreateTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Response Object', - 'description' => 'Returns the message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Response Code', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message Code', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [], - 'example' => 'true', - ], - ], + [ + 'apiName' => 'CreateMetastoreCrawler', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateMetastoreCrawler', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - '5XX' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CheckPermissions', - ], - 'GetCatalogSettings' => [ - 'summary' => 'To obtain the configurations of Data Lake Catalog, you must assume the admin role or above.', - 'path' => '/api/metastore/catalogs/settings', - 'methods' => [ - 'get', + [ + 'apiName' => 'RevokeRolesFromUser', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:RevokeRolesFromUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListRoles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:ListRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'user_permission', + [ + 'apiName' => 'ListDataSources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CheckConnectivity', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dlf:CheckConnectivity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'BatchCreatePartitions', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchCreatePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetMetastoreMigration', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetMetastoreMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'ListTableHistory', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListTableHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', + [ + 'apiName' => 'CreateSavedQuery', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateSavedQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Code' => [ - 'title' => 'Code', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CatalogSettings' => [ - 'description' => 'The data lake configurations.'."\n", - '$ref' => '#/components/schemas/CatalogSettings', - ], - ], + [ + 'apiName' => 'ListTableServiceAction', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListTableServiceAction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"CatalogSettings\\": {\\n \\"Config\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetCatalogSettings', - ], - 'GetQueryResult' => [ - 'summary' => 'Obtains the results of a data exploration query.', - 'path' => '/webapi/query/getQueryResult', - 'methods' => [ - 'get', + [ + 'apiName' => 'DescribeRegions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:DescribeRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeletePartition', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeletePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UnLock', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UnLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetServiceStatus', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:GetServiceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'QueryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query ID.'."\n" - ."\n" - .'> You can call the SubmitQuery operation to query the query ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Q-41676378709440CE', + [ + 'apiName' => 'ListMetastoreCrawlerCreators', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListMetastoreCrawlerCreators', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ], + [ + 'apiName' => 'BatchUpdateTables', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchUpdateTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The size of each page. The maximum value is 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '100', + ], + [ + 'apiName' => 'BatchRevokePermissions', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:BatchRevokePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Obtain the query result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The query status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AVAILABLE'."\n" - .'* CANCELLED: The has canceled.'."\n" - .'* RUNNING: The is running.'."\n" - .'* CANCELLING: The is being canceled.'."\n" - .'* WAITING: The is waiting for.'."\n" - .'* ERROR', - 'type' => 'string', - 'enumValueTitles' => [ - 'AVAILABLE' => 'AVAILABLE', - 'CANCELLED' => 'CANCELLED', - 'RUNNING' => 'RUNNING', - 'CANCELLING' => 'CANCELLING', - 'WAITING' => 'WAITING', - 'ERROR' => 'ERROR', - ], - 'example' => 'AVAILABLE', - ], - 'ResultTmpTable' => [ - 'description' => 'The result temporary table, which is not available.'."\n", - 'type' => 'string', - 'example' => 'table', - ], - 'Owner' => [ - 'description' => 'The uid of the primary account of the creator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '229167306180609***', - ], - 'ErrorMessage' => [ - 'description' => 'The error message of the query.'."\n", - 'type' => 'string', - 'example' => 'Table or view not found:', - ], - 'Progress' => [ - 'description' => 'The progress of the query. The value ranges from 0 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '99', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Schema' => [ - 'description' => 'The header field and type of the query result. This parameter is returned only when the status is AVAILABLE.'."\n", - 'type' => 'string', - 'example' => '[{"name":"id","type":"INT"},{"name":"student_name","type":"VARCHAR"}]', - ], - 'ResultTmpDb' => [ - 'description' => 'The result temporary library is not available.'."\n", - 'type' => 'string', - 'example' => 'db'."\n", - ], - 'GmtModified' => [ - 'description' => 'The time when the query result was updated.'."\n", - 'type' => 'string', - 'example' => '2022-05-09 16:19:09', - ], - 'JobCompleted' => [ - 'description' => 'Whether the query has been completed. false indicates that you need to continue polling this interface.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RowCount' => [ - 'description' => 'The total number of rows in the result. This parameter is returned only when the status is AVAILABLE.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'EndTime' => [ - 'description' => 'The time when the query was completed.'."\n", - 'type' => 'string', - 'example' => '2022-05-09 16:19:09', - ], - 'StartTime' => [ - 'description' => 'The point in time when the query was initiated.'."\n", - 'type' => 'string', - 'example' => '2022-05-09 16:18:09', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1D2BCFBA-7639-59A9-817B-944EC1339279', - ], - 'Rows' => [ - 'description' => 'The returned result. This value is returned only when the status is AVAILABLE. The content is represented as a two-dimensional JSON array.'."\n", - 'type' => 'string', - 'example' => '[[10,"Tom"],[11,"Jerry"]]', - ], - 'Logs' => [ - 'description' => 'Run logs.'."\n", - 'type' => 'string', - 'example' => '["this is log"]', - ], - 'GmtCreate' => [ - 'description' => 'The time when the query was created.'."\n", - 'type' => 'string', - 'example' => '2022-05-09 16:18:09', - ], - 'Duration' => [ - 'description' => 'up time in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8000', - ], - 'Sql' => [ - 'description' => 'The original SQL statement.'."\n", - 'type' => 'string', - 'example' => 'select * from db.student', - ], - 'RowCountOverLimit' => [ - 'description' => 'Whether the total number of rows in the result exceeds the maximum value.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Id' => [ - 'description' => 'The query ID.'."\n", - 'type' => 'string', - 'example' => 'Q-41676378709440CE'."\n", - ], - 'TotalBytesProcessed' => [ - 'description' => 'The total amount of data scanned. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - ], - 'example' => '{ "data" : }', + [ + 'apiName' => 'ListMigrationWorkflowInstances', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListMigrationWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Query.ResultExpired', - 'errorMessage' => 'Query result cache expired, please export result in history query', + [ + 'apiName' => 'ListUnregisteredLocations', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListUnregisteredLocations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"ResultTmpTable\\": \\"table\\",\\n \\"Owner\\": 0,\\n \\"ErrorMessage\\": \\"Table or view not found:\\",\\n \\"Progress\\": 99,\\n \\"Success\\": true,\\n \\"Schema\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"type\\\\\\":\\\\\\"INT\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"student_name\\\\\\",\\\\\\"type\\\\\\":\\\\\\"VARCHAR\\\\\\"}]\\",\\n \\"ResultTmpDb\\": \\"db\\\\n\\",\\n \\"GmtModified\\": \\"2022-05-09 16:19:09\\",\\n \\"JobCompleted\\": true,\\n \\"RowCount\\": 100,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EndTime\\": \\"2022-05-09 16:19:09\\",\\n \\"StartTime\\": \\"2022-05-09 16:18:09\\",\\n \\"RequestId\\": \\"1D2BCFBA-7639-59A9-817B-944EC1339279\\",\\n \\"Rows\\": \\"[[10,\\\\\\"Tom\\\\\\"],[11,\\\\\\"Jerry\\\\\\"]]\\",\\n \\"Logs\\": \\"[\\\\\\"this is log\\\\\\"]\\",\\n \\"GmtCreate\\": \\"2022-05-09 16:18:09\\",\\n \\"Duration\\": 8000,\\n \\"Sql\\": \\"select * from db.student\\",\\n \\"RowCountOverLimit\\": false,\\n \\"Id\\": \\"Q-41676378709440CE\\\\n\\",\\n \\"TotalBytesProcessed\\": 1024\\n}","type":"json"}]', - 'title' => 'GetQueryResult', - ], - 'SubmitQuery' => [ - 'summary' => 'Submit an SQL query task.', - 'path' => '/webapi/query/submitQueryRequestBody', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateMetastoreMigration', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateMetastoreMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetMetaDataStorageUsages', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetMetaDataStorageUsages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListBlueprintInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListBlueprintInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'UpdateWorkflowExecuteInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateWorkflowExecuteInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetCatalogSettings', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetCatalogSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'GetBlueprintInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetBlueprintInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The HTTP request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'sql' => [ - 'description' => 'The SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'show databases', - ], - 'workspaceId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'WS-A129E61C4892D2B4', - ], - 'catalogId' => [ - 'description' => 'The ID of the data directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'catalog1', - ], - ], - 'required' => false, + [ + 'apiName' => 'ListRdsDBInstances', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListRdsDBInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Create the results of the query.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The data returned'."\n", - 'type' => 'string', - 'example' => 'Q-14475CF9B51FCE5E', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '279AA630-A8ED-5EA9-80A3-2E213D63548C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'example' => '{ "success" : true }', + [ + 'apiName' => 'ListCatalogs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Query.ClusterNotReady', - 'errorMessage' => 'Query cluster is not ready. Please try again later.', + [ + 'apiName' => 'SubmitQuery', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:SubmitQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"Q-14475CF9B51FCE5E\\",\\n \\"RequestId\\": \\"279AA630-A8ED-5EA9-80A3-2E213D63548C\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'SubmitQuery', - 'description' => '* Only suitable for submitting small and medium-sized queries. The execution time cannot exceed 1 hour.'."\n" - .'* A maximum of 10000 query results can be returned.'."\n" - .'* There are limits on concurrent execution under a single master account. If multiple queries are submitted at the same time, they will be queued.'."\n", - ], - 'CancelQuery' => [ - 'summary' => 'Cancel a query request.', - 'path' => '/webapi/query/cancelQuery', - 'methods' => [ - 'post', + [ + 'apiName' => 'UpdateMetastoreMigration', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateMetastoreMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreatePartition', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreatePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListTableUnregisteredLocations', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListTableUnregisteredLocations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'GrantRoleToUsers', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:GrantRoleToUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'QueryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query ID.'."\n" - ."\n" - .'> You can call the SubmitQuery operation to query the query ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Q-BCA5E96CB84BB8B8', + [ + 'apiName' => 'PreviewMetastoreCrawler', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:PreviewMetastoreCrawler', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'Query ID'."\n", - 'type' => 'string', - 'example' => 'Q-BCA5E96CB84BB8B8', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', + [ + 'apiName' => 'CreateTable', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"Q-BCA5E96CB84BB8B8\\",\\n \\"RequestId\\": \\"DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CancelQuery', - ], - 'GetRegionStatus' => [ - 'summary' => 'You can Data Lake Formation the activation status of the service in the specified region.', - 'path' => '/webapi/service/getRegionStatus', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListTableServicePolicy', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListTableServicePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GrantPermissions', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:GrantPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListBlueprintInstanceCreators', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListBlueprintInstanceCreators', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetRegisteredLocation', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetRegisteredLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAsyncTaskStatus', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:GetAsyncTaskStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'GetTableExtended', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableExtended', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - 'title' => 'RegionId', + ], + [ + 'apiName' => 'RenamePartition', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RenamePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CC58A776-0662-5C6D-B467-FFD4CF7F4C40', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'IsDlfServiceOpen' => [ - 'description' => 'Whether the DLF service is activated'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'RegionStatus' => [ - 'description' => 'The status of the region. SERVICE_INVALID: The service is unavailable. UNITITIALIZED: Not initialized. READY: Normal.'."\n", - 'type' => 'string', - 'example' => 'READY', - ], - 'AccountStatus' => [ - 'description' => 'Account status enabled or disabled'."\n", - 'type' => 'string', - 'example' => 'enabled', - ], - 'IsDependencyReady' => [ - 'description' => 'Whether the dependency is ready'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RegionId' => [ - 'description' => 'region id'."\n", - 'type' => 'string', - 'example' => 'cn_hangzhou', - ], - ], - 'example' => '{\'RegionId\': \'cn-shanghai\', \'RegionStatus\': \'SERVICE_INVALID\', \'AccountStatus\': \'\', \'IsDlfServiceOpen\': False}', - ], - ], + [ + 'apiName' => 'GetTableVersion', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": \\"true\\",\\n \\"RequestId\\": \\"CC58A776-0662-5C6D-B467-FFD4CF7F4C40\\",\\n \\"Data\\": {\\n \\"IsDlfServiceOpen\\": true,\\n \\"RegionStatus\\": \\"READY\\",\\n \\"AccountStatus\\": \\"enabled\\",\\n \\"IsDependencyReady\\": true,\\n \\"RegionId\\": \\"cn_hangzhou\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetRegionStatus', - ], - 'GetServiceStatus' => [ - 'summary' => 'Obtains the service activation status of a Data Lake Formation user.', - 'path' => '/webapi/service/getServiceStatus', - 'methods' => [ - 'get', + [ + 'apiName' => 'UpdatePermissions', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdatePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetStorageRank', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetStorageRank', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateLock', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'Search', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:Search', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ListStorageCollector', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListStorageCollector', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - 'title' => 'RegionId', + ], + [ + 'apiName' => 'ListMetastoreCrawler', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListMetastoreCrawler', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the test feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Data' => [ - 'description' => 'Service status'."\n", - 'type' => 'object', - 'properties' => [ - 'IsDlfServiceOpen' => [ - 'description' => 'Whether the DLF service is activated'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HasRamPermissions' => [ - 'description' => 'Whether to complete RAM authorization'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsOssOpen' => [ - 'description' => 'Whether the OSS service is enabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'example' => '{ "AccountStatus":"", "RegionStatus":"READY", "RegionId":"cn-shanghai", "IsDependencyReady":true, "IsDlfServiceOpen":true }', - ], - ], - 'description' => '', + [ + 'apiName' => 'GetDatabaseProfile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetDatabaseProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Data\\": {\\n \\"IsDlfServiceOpen\\": true,\\n \\"HasRamPermissions\\": true,\\n \\"IsOssOpen\\": true\\n }\\n}","type":"json"}]', - 'title' => 'GetServiceStatus', - ], - 'DescribeRegions' => [ - 'summary' => 'Obtains the list of open regions.', - 'path' => '/webapi/service/describeRegions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListLifecycleResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListLifecycleResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '86171', - 'abilityTreeNodes' => [ - 'FEATUREdlfSKHNZC', + [ + 'apiName' => 'ModifyWorkflowExecuteInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:ModifyWorkflowExecuteInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the test feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB', - ], - 'Regions' => [ - 'description' => 'The region list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The region.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type.'."\n", - 'type' => 'string', - 'example' => 'region', - ], - 'ShowName' => [ - 'description' => 'The display name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Name' => [ - 'description' => 'The name of the data.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Description' => [ - 'description' => 'The description of the filtering table.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - 'example' => '', - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DeleteBlueprintInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteBlueprintInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Regions\\": [\\n {\\n \\"Type\\": \\"region\\",\\n \\"ShowName\\": \\"华东1（杭州）\\",\\n \\"Name\\": \\"cn-hangzhou\\",\\n \\"Description\\": \\"华东1\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeRegions', - ], - 'SearchAcrossCatalog' => [ - 'summary' => 'Search across catalogs for content such as libraries, tables, and fields.', - 'path' => '/api/metastore/catalogs/search/search-across-catalog', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateDatabase', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetLatestDate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetLatestDate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteSavedQuery', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteSavedQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeletePartitionColumnStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeletePartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListUserRoles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:ListUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'GetCatalog', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'A short description of struct'."\n", - 'type' => 'object', - 'properties' => [ - 'SearchText' => [ - 'title' => '搜索问题', - 'description' => 'The search text.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tags:tag1 or comment:^iso and name=aliyun and (createTime > "20211111" and createTime < "20211117") and has category', - ], - 'SortCriteria' => [ - 'title' => '排序结构', - 'description' => 'The sorting rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sorting rule.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/SortCriterion', - ], - 'required' => false, - ], - 'PageSize' => [ - 'title' => '当前查询的页大小', - 'description' => 'The number of entries on the queried page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - 'PageNumber' => [ - 'title' => '当前查询的页号', - 'description' => 'The page number of the queried page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'CatalogIds' => [ - 'title' => 'CatalogId数组，为空则搜索所有Catalog', - 'description' => 'The catalog IDs. If this parameter is empty, all catalogs are queried.'."\n", - 'required' => false, - 'enumValueTitles' => [], - '$ref' => '#/components/schemas/ListString', - ], - 'SearchTypes' => [ - 'title' => 'SearchTypes数组，可选值为ALL/CATALOG/DATABASE/TABLE', - 'description' => 'The search types. Valid values: ALL, CATALOG, DATABASE, and TABLE.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ListString', - ], - ], - 'required' => false, + [ + 'apiName' => 'RevokeRoleFromUsers', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dlf:RevokeRoleFromUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '响应代码', - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => '响应消息', - 'description' => 'Response'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '460C862F-BB91-5C04-BC3F-946EEF467862', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the information about the service was queried.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'DatabaseResult' => [ - 'title' => '返回的db结果', - 'description' => 'The returned database information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Databases' => [ - 'title' => '返回的DatabaseList', - 'description' => 'The returned databases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The database information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'title' => '返回的Database', - 'description' => 'The returned database.'."\n", - '$ref' => '#/components/schemas/Database', - ], - 'HighLightList' => [ - 'title' => '返回高亮文本', - 'description' => 'The returned highlighted text.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned highlighted text.'."\n", - '$ref' => '#/components/schemas/HighLight', - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '满足匹配条件的总的Database个数', - 'description' => 'Total number of databases that meet the match conditions'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11000', - ], - ], - ], - 'TableResult' => [ - 'title' => '返回的table result', - 'description' => 'The returned table information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Tables' => [ - 'title' => '返回的TableList', - 'description' => 'The returned tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The table information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Table' => [ - 'title' => '返回的Table', - 'description' => 'The returned table.'."\n", - '$ref' => '#/components/schemas/Table', - ], - 'HighLightList' => [ - 'title' => '返回的高亮文本', - 'description' => 'The returned highlighted text.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned highlighted text.'."\n", - '$ref' => '#/components/schemas/HighLight', - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '满足匹配条件的总的Table个数', - 'description' => 'The total number of tables that meet the match conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1100', - ], - ], - ], - 'CatalogResult' => [ - 'title' => '返回的Catalog result', - 'description' => 'The returned catalog information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Catalogs' => [ - 'description' => 'The returned catalogs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The catalog details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Catalog' => [ - 'description' => 'The returned catalog.'."\n", - '$ref' => '#/components/schemas/Catalog', - ], - 'HighLightList' => [ - 'description' => 'The returned highlighted text.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned highlighted text.'."\n", - '$ref' => '#/components/schemas/HighLight', - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '满足匹配条件的总的Catalog个数', - 'description' => 'Total number of catalogs that meet the match conditions'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - ], + [ + 'apiName' => 'GetQueryResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetQueryResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCatalog', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLocationStorageRank', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetLocationStorageRank', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListLifecycleRules', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListLifecycleRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTable', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkspaces', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListWorkspaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"460C862F-BB91-5C04-BC3F-946EEF467862\\",\\n \\"Success\\": true,\\n \\"DatabaseResult\\": {\\n \\"Databases\\": [\\n {\\n \\"Database\\": {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 11000\\n },\\n \\"TableResult\\": {\\n \\"Tables\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1100\\n },\\n \\"CatalogResult\\": {\\n \\"Catalogs\\": [\\n {\\n \\"Catalog\\": {\\n \\"CatalogId\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"CreatedBy\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CatalogType\\": \\"\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100\\n }\\n}","type":"json"}]', - 'title' => 'SearchAcrossCatalog', - ], - 'RegisterLocation' => [ - 'summary' => 'Register the OSS path to be managed by DLF.', - 'path' => '/webapi/locations', - 'methods' => [ - 'post', + [ + 'apiName' => 'UpdateFunction', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteMetastoreCrawler', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteMetastoreCrawler', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RunBlueprintInstanceWorkflow', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RunBlueprintInstanceWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListTables', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'UpdateLifecycleRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateLifecycleRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'BatchGrantPermissions', + 'description' => '', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:BatchGrantPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'HTTP'."\n", - 'type' => 'object', - 'properties' => [ - 'Location' => [ - 'description' => 'Registered OSS path'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'oss://mybucket/', - ], - 'RoleName' => [ - 'description' => 'RAM role name'."\n" - ."\n" - .'> Data Lake Formation read and write data in the OSS path. If you want to AliyunDLFWorkFlowDefaultRole a role, the role is automatically built in to the role. Alternatively, you can create a custom role, but you must manually ensure that the role has the read and write permissions on the corresponding path.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'AliyunDLFWorkFlowDefaultRole', - ], - 'InventoryCollectEnabled' => [ - 'description' => 'Whether to enable OSS bucket inventory'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'OssLogCollectEnabled' => [ - 'description' => 'Whether to enable OSS log storage'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, + [ + 'apiName' => 'GetLocationIndicatorDetails', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetLocationIndicatorDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The registration results.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3C2678BA-3451-14C3-90E2-D4EF5B4E7A84', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'LocationId' => [ - 'description' => 'Location ID'."\n", - 'type' => 'string', - 'example' => 'LOC-AB8FBC17F95A4AF5', - ], - 'StorageCollectTaskOperationResultList' => [ - 'description' => 'The list of collection tasks that are enabled.', - 'type' => 'array', - 'items' => [ - 'description' => 'The collection task that is enabled.', - '$ref' => '#/components/schemas/StorageCollectTaskOperationResult', - ], - ], - ], - ], - ], + [ + 'apiName' => 'AbortLock', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:AbortLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C2678BA-3451-14C3-90E2-D4EF5B4E7A84\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": true,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'RegisterLocation', - ], - 'DeregisterLocation' => [ - 'summary' => 'Cancel Location registration.', - 'path' => '/webapi/locations', - 'methods' => [ - 'delete', + [ + 'apiName' => 'UpdateTable', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListTableNames', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListTableNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDatabases', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'GetLock', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'LocationId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Location ID'."\n" - ."\n" - .'> You can call the RegisterLocation operation to obtain the Location ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'LOC-AB8FBC17F95A4AF5', + [ + 'apiName' => 'ListMetastoreMigrations', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListMetastoreMigrations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Deregister the location.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E47920CD-BAE6-1305-88DF-FBDD3D300845', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'Response parameters'."\n", - 'type' => 'object', - 'properties' => [ - 'LocationId' => [ - 'description' => 'Location ID'."\n", - 'type' => 'string', - 'example' => 'LOC-AB8FBC17F95A4AF5', - ], - 'StorageCollectTaskOperationResultList' => [ - 'description' => 'The list of the collection tasks that are disabled.', - 'type' => 'array', - 'items' => [ - 'description' => 'The collection task that is disabled.', - '$ref' => '#/components/schemas/StorageCollectTaskOperationResult', - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetWorkflowInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E47920CD-BAE6-1305-88DF-FBDD3D300845\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": true,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DeregisterLocation', - ], - 'UpdateRegisteredLocation' => [ - 'summary' => 'Edit a Registered Location.', - 'path' => '/webapi/locations', - 'methods' => [ - 'put', + [ + 'apiName' => 'DeleteDataSource', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateUserFeedback', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateUserFeedback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListPartitionNames', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListPartitionsByExpr', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionsByExpr', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetTableProfile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetTableProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'DeleteCatalog', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'HTTP'."\n", - 'type' => 'object', - 'properties' => [ - 'LocationId' => [ - 'description' => 'Location ID'."\n" - ."\n" - .'> You can call the RegisterLocation operation to obtain the Location ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'LOC-AB8FBC17F95A4AF5', - ], - 'InventoryCollectEnabled' => [ - 'description' => 'Whether to enable OSS bucket inventory'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], - 'OssLogCollectEnabled' => [ - 'description' => 'Whether to enable OSS log storage'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - 'docRequired' => false, + [ + 'apiName' => 'SearchAcrossCatalog', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:SearchAcrossCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The result of location edit operation.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8030C902-C25B-1839-867D-E6F70A5B9810', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'LocationId' => [ - 'description' => 'Location ID'."\n", - 'type' => 'string', - 'example' => 'LOC-AB8FBC17F95A4AF5', - ], - 'StorageCollectTaskOperationResultList' => [ - 'description' => 'The list of collection tasks that are updated.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The collection task that is updated.'."\n", - '$ref' => '#/components/schemas/StorageCollectTaskOperationResult', - ], - ], - ], - ], - ], + [ + 'apiName' => 'StopCrawlerWorkflow', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:StopCrawlerWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8030C902-C25B-1839-867D-E6F70A5B9810\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": true,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'UpdateRegisteredLocation', - ], - 'ListPartitionsByExpr' => [ - 'summary' => 'Obtains a list of data table partitions in the data lake and queries them by condition.', - 'path' => '/api/metastore/catalogs/databases/tables/partitions/listbyexpr', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteDatabase', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetRole', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:GetRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdatePartitionColumnStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdatePartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + [ + 'apiName' => 'CreateTpcdsDatabase', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:CreateTpcdsDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [], - 'responses' => [ - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - ], + [ + 'apiName' => 'RenameTable', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RenameTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'ListPartitionsByExpr', - 'description' => 'You cannot specify expr to filter partitions. Currently, you need to call the listpartitionsbyfilter to complete the corresponding function.'."\n", - 'responseParamsDescription' => '* code: error code'."\n" - .'* message: the error message.'."\n" - .'* requestId: the unique ID of the current request.'."\n" - .'* Success:true/false to determine whether the request is successful.'."\n", - ], - 'GetDatabaseProfile' => [ - 'summary' => 'Gets the details of the database data profile.', - 'path' => '/webapi/metastorehouse/catalog/database/databaseprofile', - 'methods' => [ - 'get', + [ + 'apiName' => 'UpdateRegisteredLocation', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:UpdateRegisteredLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeZones', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dlf:DescribeZones', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RunCrawlerWorkflow', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:RunCrawlerWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTablesWithRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListTablesWithRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListRoleUsers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:ListRoleUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetStorageAnalysis', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetStorageAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDataSource', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:DescribeDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory. By default, the ID of the primary account is entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371'."\n", + [ + 'apiName' => 'BatchGetPartitionColumnStatistics', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchGetPartitionColumnStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '530_db', + ], + [ + 'apiName' => 'UpdateCatalogSettings', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:UpdateCatalogSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Response', - 'description' => 'Response'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DatabaseProfile' => [ - 'description' => 'The data profile of the database.'."\n", - 'example' => '{'."\n" - .' "FileCnt": 213,'."\n" - .' "FileSize": 34324'."\n" - .'}', - '$ref' => '#/components/schemas/DatabaseProfile', - ], - ], + [ + 'apiName' => 'ListPartitions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB\\",\\n \\"Success\\": true,\\n \\"DatabaseProfile\\": {\\n \\"FileCnt\\": 0,\\n \\"FileSize\\": 0,\\n \\"Name\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"ObjectSize\\": 0,\\n \\"ObjectCnt\\": 0,\\n \\"LatestDate\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDatabaseProfileResponse>\\n <RequestId>AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB</RequestId>\\n <Success>true</Success>\\n <DatabaseProfile>\\n <FileCnt>3234</FileCnt>\\n <FileSize>1254312</FileSize>\\n <Name>test_db</Name>\\n <CreateTime>2023-08-16 18:02:22</CreateTime>\\n <Location>oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/</Location>\\n <ObjectSize>1254312</ObjectSize>\\n <ObjectCnt>3234</ObjectCnt>\\n <LatestDate>2023-08-30 19:16:10</LatestDate>\\n </DatabaseProfile>\\n</GetDatabaseProfileResponse>","errorExample":""}]', - 'title' => 'GetDatabaseProfile', - 'description' => 'To use a data profile, you must first host the OSS bucket of the database.'."\n", - ], - 'GetLifecycleRule' => [ - 'summary' => 'Obtains the lifecycle rules of a database and table.', - 'path' => '/webapi/metastorehouse/lifecycle/rule/getLifecycleRule', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListLifecycleTasks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListLifecycleTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RunLifecycleRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RunLifecycleRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetHudiProperties', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetHudiProperties', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'BatchGetPartitions', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdlf4RLCBT', + 'ramAction' => [ + 'action' => 'dlf:BatchGetPartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ResourceName', - 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the resource, which is a string that consists of the data directory, database, and table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'demo_catalog_id.demo_db_name.demo_table_name', + [ + 'apiName' => 'CancelQuery', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CancelQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'BizId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The business ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LCRU-17E7192705C365C0', + ], + [ + 'apiName' => 'RegisterLocation', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RegisterLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Response', - 'description' => 'The returned message body.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBC848F-7CC7-52E3-9FBF-924D09B5C27A', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Data' => [ - 'description' => 'The information about the lifecycle rule.'."\n", - '$ref' => '#/components/schemas/LifecycleRule', - ], - ], + [ + 'apiName' => 'ListQueryHistory', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListQueryHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRegionClusterInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetRegionClusterInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExportQueryResult', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ExportQueryResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDatabaseUnregisteredLocations', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListDatabaseUnregisteredLocations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateFunction', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:CreateFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteLifecycleRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteLifecycleRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkflowInstantences', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListWorkflowInstantences', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBC848F-7CC7-52E3-9FBF-924D09B5C27A\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BizId\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ResourceType\\": \\"\\",\\n \\"BindCount\\": 0,\\n \\"Description\\": \\"\\",\\n \\"RuleType\\": \\"\\",\\n \\"Config\\": \\"\\",\\n \\"IaDays\\": 0,\\n \\"ArchiveDays\\": 0,\\n \\"ColdArchiveDays\\": 0,\\n \\"ScheduleStatus\\": \\"\\",\\n \\"Workflow\\": {\\n \\"LatestInstanceId\\": \\"\\",\\n \\"LatestInstanceStatus\\": \\"\\",\\n \\"LatestStartTime\\": \\"\\",\\n \\"LatestEndTime\\": \\"\\"\\n },\\n \\"WorkflowId\\": \\"\\",\\n \\"WorkflowInstance\\": {\\n \\"DlfWorkflowId\\": \\"\\",\\n \\"ExternalInstanceId\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"RuntimeLogs\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"InstanceId\\": \\"\\",\\n \\"BizTime\\": \\"\\",\\n \\"LogType\\": \\"\\",\\n \\"LogId\\": \\"\\",\\n \\"LogSummary\\": \\"\\",\\n \\"LogContent\\": \\"\\"\\n }\\n ],\\n \\"BatchProgress\\": 0\\n },\\n \\"CatalogId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetLifecycleRule', - ], - 'ListPartitionsProfile' => [ - 'summary' => 'Obtains the details of a partition data profile.', - 'path' => '/webapi/metastorehouse/catalog/database/tableprofile/partitionprofile/listPartitionsProfile', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListRegisteredLocations', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListRegisteredLocations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RunMigrationWorkflow', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:RunMigrationWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListFunctions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListFunctions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListTableVersions', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:ListTableVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'RefreshUserSession', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dlf:RefreshUserSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListFunctionNames', + 'description' => '', 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '139289', - 'abilityTreeNodes' => [ - 'FEATUREdlfTGKBOY', + 'ramAction' => [ + 'action' => 'dlf:ListFunctionNames', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CatalogId', - 'description' => 'The ID of the data directory. By default, the ID of the primary account is entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1344371', + [ + 'apiName' => 'DeleteTableVersion', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteTableVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'DatabaseName', - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_db', + ], + [ + 'apiName' => 'BatchDeleteTableVersions', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:BatchDeleteTableVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metadata table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_tbl', + ], + [ + 'apiName' => 'ListPartitionsProfile', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dlf:ListPartitionsProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'Page number'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'CheckPermissions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dlf:CheckPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'DeleteFunction', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PartitionNames', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The names of partitions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the partition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'year=3/month=1', - ], - 'required' => false, + ], + [ + 'apiName' => 'GetUnarchiveDetail', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:GetUnarchiveDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Response', - 'description' => 'Response'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '97434FA4-A6B2-1AE4-A174-76964F29C759', - ], - 'Success' => [ - 'title' => 'Success', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Data' => [ - 'description' => 'The partition data profiles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The partition data profile.'."\n", - '$ref' => '#/components/schemas/PartitionProfile', - ], - ], - 'LatestDate' => [ - 'description' => 'The time when the metadata warehouse was updated.'."\n", - 'type' => 'string', - 'example' => '2023-08-30 19:16:10', - ], - 'LatestAccessNumDate' => [ - 'description' => 'The time when the access frequency is updated. This parameter is obsolete.'."\n", - 'type' => 'string', - 'example' => '-', - ], - ], + [ + 'apiName' => 'DeleteMetastoreMigration', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dlf:DeleteMetastoreMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetUserExtraInfo', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dlf:SetUserExtraInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"97434FA4-A6B2-1AE4-A174-76964F29C759\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"DatabaseName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"PartitionName\\": \\"year=2023/month=1\\",\\n \\"ArchiveStatus\\": \\"STANDARD\\",\\n \\"CreateTime\\": \\"2023-08-16 18:02:22\\",\\n \\"LastModifyTime\\": \\"2023-08-16 18:02:25\\",\\n \\"LastAccessTime\\": \\"2023-08-22 12:14:42\\",\\n \\"LastAccessNumTime\\": \\"\\",\\n \\"Location\\": \\"oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1\\",\\n \\"FileSize\\": 13,\\n \\"ObjectSize\\": 13,\\n \\"FileCnt\\": 1,\\n \\"ObjectCnt\\": 1,\\n \\"AccessNum\\": 0,\\n \\"AccessNumWeekly\\": 0,\\n \\"AccessNumMonthly\\": 0,\\n \\"ObjectAccessNum\\": 0,\\n \\"ObjectAccessNumWeekly\\": 4,\\n \\"ObjectAccessNumMonthly\\": 4,\\n \\"DataSourceType\\": \\"OSS_HDFS\\"\\n }\\n ],\\n \\"LatestDate\\": \\"2023-08-30 19:16:10\\",\\n \\"LatestAccessNumDate\\": \\"-\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPartitionsProfileResponse>\\n <Code>-</Code>\\n <Message>-</Message>\\n <RequestId>97434FA4-A6B2-1AE4-A174-76964F29C759</RequestId>\\n <Success>true</Success>\\n <Total>1</Total>\\n <Data>\\n <DatabaseName>test_db</DatabaseName>\\n <TableName>test_tbl</TableName>\\n <PartitionName>year=2023/month=1</PartitionName>\\n <ArchiveStatus>STANDARD</ArchiveStatus>\\n <CreateTime>2023-08-16 18:02:22</CreateTime>\\n <LastModifyTime>2023-08-16 18:02:25</LastModifyTime>\\n <LastAccessTime>2023-08-22 12:14:42</LastAccessTime>\\n <Location>oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1</Location>\\n <FileSize>13</FileSize>\\n <ObjectSize>13</ObjectSize>\\n <FileCnt>1</FileCnt>\\n <ObjectCnt>1</ObjectCnt>\\n <ObjectAccessNum>0</ObjectAccessNum>\\n <ObjectAccessNumWeekly>4</ObjectAccessNumWeekly>\\n <ObjectAccessNumMonthly>4</ObjectAccessNumMonthly>\\n <DataSourceType>OSS_HDFS</DataSourceType>\\n </Data>\\n <LatestDate>2023-08-30 19:16:10</LatestDate>\\n</ListPartitionsProfileResponse>","errorExample":""}]', - 'title' => 'ListPartitionsProfile', - 'description' => 'To use a data profile, you must first host the OSS bucket of the table.'."\n", - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'dlf.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'dlf.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'dlf.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'dlf.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'dlf.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'dlf.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'dlf.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'dlf.us-east-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |