'1.0',
'info' => ['style' => 'ROA', 'product' => 'DataLake', 'version' => '2020-07-10'],
'directories' => [
[
'children' => [
[
'children' => ['UpdateCatalog'],
'type' => 'directory',
'title' => 'Catalog',
],
[
'children' => ['UpdateDatabase'],
'type' => 'directory',
'title' => 'Database',
],
[
'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',
'title' => 'Partition',
],
[
'children' => ['ListFunctionNames'],
'type' => 'directory',
'title' => 'Function',
],
[
'children' => ['CreateLock', 'GetLock', 'AbortLock', 'RefreshLock', 'UnLock'],
'type' => 'directory',
'title' => 'Lock',
],
[
'children' => ['StopMigrationWorkflow', 'RunMigrationWorkflow'],
'type' => 'directory',
'title' => 'Metadata migration',
],
'GetAsyncTaskStatus',
],
'type' => 'directory',
'title' => 'Metadata',
],
[
'children' => ['GrantRolesToUser', 'BatchGrantPermissions', 'RevokeRolesFromUser', 'RevokePermissions', 'BatchRevokePermissions', 'UpdateRoleUsers', 'UpdatePermissions', 'UpdateCatalogSettings', 'ListRoleUsers', 'ListUserRoles', 'CheckPermissions', 'GetCatalogSettings'],
'type' => 'directory',
'title' => 'Permission',
],
[
'children' => ['GetQueryResult', 'SubmitQuery', 'CancelQuery'],
'type' => 'directory',
'title' => 'Data exploration',
],
[
'children' => ['GetRegionStatus', 'GetServiceStatus'],
'type' => 'directory',
'title' => 'Common services',
],
[
'children' => [
'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' => [
'Accesses' => [
'title' => 'A short description of struct',
'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' => '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',
],
'BatchGrantRevokeFailureResult' => [
'title' => 'A short description of struct',
'description' => '批量授权错误时的结果',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/GrantRevokeFailureEntry'],
],
'Catalog' => [
'title' => '',
'description' => 'Details of the catalog.',
'type' => 'object',
'properties' => [
'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.',
'enumValueTitles' => ['NATIVE' => 'NATIVE', 'HMS' => 'HMS'],
'type' => 'string',
'example' => 'HMS',
'visibility' => 'Public',
'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' => '',
'description' => 'The structure for creating or updating a catalog.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Authentication resource structure: data directory.'."\n",
'type' => 'object',
'properties' => [
'CatalogId' => ['title' => '', 'description' => 'The ID of the data directory.'."\n", 'type' => 'string', 'example' => '1344371', 'visibility' => 'Public', 'backendName' => 'CatalogId'],
],
'visibility' => 'Public',
'example' => '',
],
'CatalogSettings' => [
'title' => '',
'description' => 'Data Lake-related configurations'."\n",
'type' => 'object',
'properties' => [
'Config' => [
'title' => '',
'description' => 'The metadata of the sample.'."\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' => '',
'description' => 'Authentication resource structure-Column'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The list of field names.'."\n",
'type' => 'array',
'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' => '',
'description' => 'The field statistics.'."\n",
'type' => 'object',
'properties' => [
'ColumnStatisticsDesc' => ['description' => 'The description of the field statistics.'."\n", '$ref' => '#/components/schemas/ColumnStatisticsDesc', 'visibility' => 'Public', 'backendName' => 'ColumnStatisticsDesc', 'title' => '', 'example' => ''],
'ColumnStatisticsObjList' => [
'title' => '',
'description' => 'The field statistics.'."\n",
'type' => 'array',
'items' => ['description' => 'The field statistics.'."\n", '$ref' => '#/components/schemas/ColumnStatisticsObj', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''],
'visibility' => 'Public',
'backendName' => 'ColumnStatisticsObjectList',
'example' => '',
],
'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' => '',
'description' => 'ColumnStatisticsDesc'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'ColumnStatisticsObj'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The statistics on the field.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Database object'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Database object'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Database Data Overview'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Authentication resource structure: database.'."\n",
'type' => 'object',
'properties' => [
'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",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'ErrorDetail'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'FieldSchema'."\n",
'type' => 'object',
'properties' => [
'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",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Functions'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Resource URI of the function'."\n",
'type' => 'array',
'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' => '', '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' => '',
'description' => 'Functions'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Resource URI of the function'."\n",
'type' => 'array',
'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' => '', 'description' => 'The time when the rule was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1638501155', 'visibility' => 'Public', 'backendName' => 'CreateTime'],
],
'visibility' => 'Public',
'example' => '',
],
'FunctionResource' => [
'title' => '',
'description' => 'Authentication resource structure: Function.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'A short description of struct'."\n",
'type' => 'object',
'properties' => [
'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' => 'tab2'],
],
],
'IndicatorStatistic' => [
'title' => '',
'description' => 'A detailed record for an indicator.',
'type' => 'object',
'properties' => [
'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'],
],
],
'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' => '',
'description' => 'The information about the lifecycle rule.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'ListFieldSchema array'."\n",
'type' => 'array',
'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',
'type' => 'array',
'items' => [
'description' => 'Resource URI'."\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'],
],
'extendType' => 'true',
],
'parseType' => 'json',
'itemName' => 'ResourceUri',
],
'ListString' => [
'title' => '',
'description' => 'ListString'."\n",
'type' => 'array',
'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' => '',
'description' => 'LockObj'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'LockStatus'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'View logs.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The resource structure for authentication.',
'type' => 'object',
'properties' => [
'ResourceType' => [
'title' => '',
'description' => 'The object type of the metadata resource.',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TABLE' => '元数据表', 'DATABASE' => '元数据库', 'COLUMN' => '字段', ' CATALOG' => ' 元数据目录', ' FUNCTION' => ' 函数'],
'example' => 'TABLE',
'visibility' => 'Public',
'backendName' => 'ResourceType',
],
'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' => '',
'description' => 'Order'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Parameters'."\n",
'type' => 'object',
'additionalProperties' => ['description' => 'Parameter key/value'."\n", 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'title' => ''],
'visibility' => 'Public',
'parseType' => 'json',
'example' => '',
],
'Partition' => [
'title' => '',
'description' => 'Partition'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The KVPs that are related to the partition.'."\n",
'type' => 'object',
'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' => '',
'description' => 'The values in the partition.'."\n",
'type' => 'array',
'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' => '',
'description' => 'PartitionError'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Partition'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The KVPs that are related to the partition.'."\n",
'type' => 'object',
'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", '$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' => '',
'description' => 'The values in the partition.'."\n",
'type' => 'array',
'items' => ['description' => 'The values in the partition.'."\n", 'type' => 'string', 'example' => 'part1', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''],
'visibility' => 'Public',
'backendName' => 'Values',
'example' => '',
],
'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' => 'The data profile of a partition.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Partition structure of shared sd'."\n",
'type' => 'object',
'properties' => [
'SharedSDPartitions' => [
'title' => '',
'description' => 'Shared partition list, which indicates the common parts of multiple partitions'."\n",
'type' => 'array',
'items' => ['description' => 'Shard'."\n", '$ref' => '#/components/schemas/Partition', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''],
'visibility' => 'Public',
'backendName' => 'SharedSDPartitions',
'example' => '',
],
'SharedStorageDescriptor' => [
'title' => '',
'description' => 'Shared SD information, indicating that multiple partitions share the same SD'."\n",
'type' => 'object',
'properties' => [
'Cols' => [
'title' => '',
'description' => 'The column content.'."\n",
'type' => 'array',
'items' => ['description' => 'Details of each column'."\n", '$ref' => '#/components/schemas/FieldSchema', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''],
'visibility' => 'Public',
'backendName' => 'Cols',
'example' => '',
],
'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' => '',
'description' => 'PartitionValueList'."\n",
'type' => 'array',
'items' => [
'description' => 'Object of partition value'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The ARN of the unique identity.'."\n",
'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", 'type' => 'string', 'example' => 'acs:ram::[AliyunAccountId]:user/username_abc', 'visibility' => 'Public', 'backendName' => 'PrincipalArn'],
],
'visibility' => 'Public',
'example' => '',
],
'PrincipalPrivilegeSet' => [
'title' => '',
'description' => 'The set of permissions owned by the principal.'."\n",
'type' => 'object',
'properties' => [
'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",
'type' => 'array',
'items' => ['description' => 'Principal'."\n", '$ref' => '#/components/schemas/Principal', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''],
'visibility' => 'Public',
'parseType' => 'struct',
'example' => '',
],
'PrivilegeGrantInfo' => [
'title' => '',
'description' => 'The information about permissions.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Resource permission information.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Authentication resource list'."\n",
'type' => 'array',
'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' => '',
'description' => 'The permission information.'."\n",
'type' => 'object',
'additionalProperties' => [
'description' => 'The permissions.'."\n",
'type' => 'array',
'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' => '',
'description' => 'ResourceUri'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Data Lake Metadata Role'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'role input'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'A short description of struct'."\n",
'type' => 'array',
'items' => ['description' => 'The role.'."\n", '$ref' => '#/components/schemas/Role', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''],
'visibility' => 'Public',
'parseType' => 'struct',
'itemName' => 'Role',
'example' => '',
],
'SerDeInfo' => [
'title' => '',
'description' => 'SerDeInfo'."\n",
'type' => 'object',
'properties' => [
'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",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'SkewedInfo'."\n",
'type' => 'object',
'properties' => [
'SkewedColNames' => [
'title' => '',
'description' => 'List of fields that contain skewed values'."\n",
'type' => 'array',
'items' => ['description' => 'The names of the skewed fields.'."\n", 'type' => 'string', 'example' => 'col1', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''],
'visibility' => 'Public',
'example' => '',
],
'SkewedColValueLocationMaps' => [
'title' => '',
'description' => 'Mapping Map of skew values and fields'."\n",
'type' => 'object',
'additionalProperties' => ['description' => 'Mapping Map of skew values and fields'."\n", 'type' => 'string', 'example' => '{“col1”:"val1"}', 'visibility' => 'Public', 'title' => ''],
'visibility' => 'Public',
'example' => '',
],
'SkewedColValues' => [
'title' => '',
'description' => 'Tilt Value List'."\n",
'type' => 'array',
'items' => [
'description' => 'The values of the skewed fields.'."\n",
'type' => 'array',
'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",
'type' => 'object',
'properties' => [
'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",
'type' => 'object',
'properties' => [
'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' => 'The result of modifying a collection task.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'StorageDescriptor'."\n",
'type' => 'object',
'properties' => [
'BucketCols' => ['description' => 'The array of bucket fields.'."\n", '$ref' => '#/components/schemas/ListString', 'visibility' => 'Public', 'title' => '', 'example' => ''],
'Cols' => [
'title' => '',
'description' => 'All the fields in a table.'."\n",
'type' => 'array',
'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' => '',
'description' => 'The mapping array of KVPs.'."\n",
'type' => 'object',
'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' => '',
'description' => 'The sort fields.'."\n",
'type' => 'array',
'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",
'type' => 'object',
'properties' => [
'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",
'type' => 'object',
'properties' => [
'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",
'type' => 'object',
'properties' => [
'dbStorageRank' => [
'title' => '',
'description' => 'Library storage ranking list'."\n",
'type' => 'array',
'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",
'type' => 'array',
'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",
'type' => 'array',
'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' => '',
'description' => 'Table'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'TableError'."\n",
'type' => 'object',
'properties' => [
'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' => '',
],
'TableExtended' => [
'title' => 'A short description of struct',
'description' => 'TableExtended',
'type' => 'object',
'properties' => [
'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' => [
'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' => [
'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'],
],
],
'TableInput' => [
'title' => '',
'description' => 'Table'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Authentication resource structure-Table'."\n",
'type' => 'object',
'properties' => [
'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",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The schema of a table version.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'status and message'."\n",
'type' => 'object',
'properties' => [
'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' => '',
],
'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",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The list of field statistics.'."\n",
'type' => 'array',
'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' => '', '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",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The list of metadata roles and user relationships in the data lake.'."\n",
'type' => 'array',
'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' => 'Contains the details of a workflow.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Represents a single run of a workflow.',
'type' => 'object',
'properties' => [
'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' => 'The runtime logs for the workflow instance.',
'type' => 'array',
'items' => ['description' => 'Details of a single log entry.', '$ref' => '#/components/schemas/LogInfo', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'],
'example' => '',
'visibility' => 'Public',
'backendName' => 'runtimeLogs',
],
'BatchProgress' => ['title' => '', 'description' => 'The progress of the batch execution.', 'type' => 'integer', 'format' => 'int32', 'example' => '', 'visibility' => 'Public', 'backendName' => 'batchProgress'],
],
'example' => '',
'visibility' => 'Public',
],
],
],
'apis' => [
'AbortLock' => [
'path' => '/api/metastore/catalogs/databases/tables/locks/abort',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'LockId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The lock ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16530'],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
'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' => '',
],
],
],
'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'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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'],
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'BatchCreateTables',
'summary' => 'Creates multiple tables in a data lake.',
'responseParamsDescription' => 'Error codes
InvalidObject: The name, partition, column, or skewCol parameter is invalid.
AlreadyExists: The metadata table already exists.
NoSuchObject: The specified metadatabase does not exist.
InternalError: An internal error occurred. For more information, see the Message parameter.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateTables'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '.'],
'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 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' => '',
],
],
],
'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'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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 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' => 'BatchDeleteTableVersions',
'responseParamsDescription' => 'Code: The error code.
'."\n"
.'NoSuchObject: The specified table does not exist.
'."\n"
.'InternalError: An internal error occurred. See the Message parameter for details.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteTableVersions'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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'],
'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,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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. 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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'BatchDeleteTables',
'responseParamsDescription' => 'NoSuchObject: The specified table does not exist.
'."\n"
.'InternalError: An internal error occurred. For more information, refer to the Message parameter.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteTables'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The message body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The HTTP 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'],
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
'Partitions' => [
'title' => '',
'description' => 'A list of partition details.',
'type' => 'array',
'items' => ['description' => 'The partition details.', '$ref' => '#/components/schemas/Partition', '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'],
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'BatchGetPartitions',
'summary' => 'Retrieves the details of multiple partitions in a data lake database.',
'responseParamsDescription' => 'Error codes for the Code parameter:'."\n"
."\n"
.'- 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'],
],
],
'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'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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. \\`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' => '',
],
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'BatchGetTables',
'responseParamsDescription' => 'Code: The error code.
'."\n"
.'NoSuchObject: The specified data table does not exist.
'."\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' => 'BatchGetTables'],
],
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => [
[
'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' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body in the JSON format.',
'type' => 'object',
'properties' => [
'Type' => [
'description' => 'The authorization type. Currently, only Hive is supported.',
'type' => 'string',
'required' => true,
'enum' => ['hive'],
'title' => '',
'example' => 'Hive',
],
'GrantRevokeEntries' => [
'title' => '',
'description' => 'The permissions to revoke.',
'type' => 'array',
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => [],
],
'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'],
],
],
'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'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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'],
'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,
'example' => '',
],
'TableName' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '.'],
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'BatchUpdatePartitions',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdatePartitions'],
],
],
'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'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'BatchUpdateTables',
'responseParamsDescription' => 'The Code parameter can return the following error codes:'."\n"
."\n"
.'- 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'],
],
],
'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' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'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' => [
'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' => [
[
'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' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => ['description' => 'The request body in JSON format.', '$ref' => '#/components/schemas/AccessRequest', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '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.',
'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' => '',
'description' => 'Response Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'CreateCatalog',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCatalog'],
],
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '',
],
],
'5XX' => [
'schema' => [
'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
'."\n"
.'InvalidObject: The name, partition, column, or skewCol parameter failed validation.
'."\n"
.'AlreadyExists: The metadatabase already exists.
'."\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' => 'CreateDatabase'],
],
],
'ramActions' => [
[
'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' => '',
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The returned result.',
'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' => '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' => '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'],
],
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'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' => '{"databaseName":"db","tableName":"test"}',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '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' => [],
],
'title' => 'CreateLock',
'summary' => 'Creates a metadata lock.',
'requestParamsDescription' => '1. The LockObjList parameter can contain only one lock object.'."\n"
."\n"
.'2. The LockObj parameter supports only table locks. Partition-level locks are not supported.',
'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 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 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'],
],
],
'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'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '.'],
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'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' => '',
'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' => [
[
'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' => [
[
'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' => '',
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The returned result.',
'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' => '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' => '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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'CatalogId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the catalog.', 'type' => 'string', 'required' => true, 'example' => 'catalog_test'],
],
[
'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' => '',
'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' => [
[
'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' => 'CatalogId',
'in' => 'query',
'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' => '',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Response Object',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'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 function.', 'type' => 'string', 'required' => false, 'example' => 'func2'],
],
],
'responses' => [
200 => [
'schema' => [
'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' => [
[
'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' => '',
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'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_20201223'],
],
[
'name' => 'PartitionNames',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A list of partition names.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'ColumnNames',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A list of column names.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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 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' => '',
],
],
],
'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'],
],
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '114162',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'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' => '',
'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' => [
[
'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' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'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 data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'],
],
],
'responses' => [
200 => [
'schema' => [
'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 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' => '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'],
],
],
'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'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'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_20201223'],
],
[
'name' => 'ColumnNames',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A list of field names.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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: 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' => '',
],
],
],
'title' => 'DeleteTableColumnStatistics',
'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 is successful. The value is true for success and false for failure.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTableColumnStatistics'],
],
],
'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' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'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 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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'title' => 'DeleteTableVersion',
'summary' => 'Deletes a specified version of a table in the data lake.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTableVersion'],
],
],
'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' => [],
'produces' => [],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'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' => '',
'description' => 'The result of the deregistration.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
'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' => [
'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' => ''],
'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' => '',
],
],
],
'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' => '[{"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',
],
'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'],
'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' => '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' => '',
'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' => '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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'GetAsyncTaskStatus',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncTaskStatus'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'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 response body.',
'type' => 'object',
'properties' => [
'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' => [],
],
'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' => '[{"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',
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'CatalogId',
'in' => 'query',
'schema' => ['description' => 'The catalog ID.', 'type' => 'string', 'required' => false, 'example' => '1344371', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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 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' => '',
],
],
],
'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' => '[{"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',
],
'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' => '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' => 'Name',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'database_test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Response',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => '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'."\n"],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test_db'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => ''],
],
'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 data.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'GetFunction',
'summary' => 'Retrieves a user-defined function from a database in a data lake.',
'responseParamsDescription' => 'Error codes for the Code parameter:
'."\n"
.'InternalError: See the Message parameter for details.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunction'],
],
],
'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' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '*'],
],
],
],
],
'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' => '',
'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 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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The HTTP request body.',
'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'],
'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' => '',
'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' => '.'],
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'GetPartition',
'summary' => 'Retrieves the details of a database partition in a data lake.',
'responseParamsDescription' => 'Error codes:'."\n"
."\n"
.'- 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'],
],
],
'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' => '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 data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'],
],
[
'name' => 'PartitionNames',
'in' => 'query',
'style' => 'json',
'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 list of columns in the data table.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'GetPartitionColumnStatistics',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPartitionColumnStatistics'],
],
],
'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' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'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' => [
'description' => 'The query results.',
'type' => 'object',
'properties' => [
'Status' => [
'description' => 'The query status.',
'enumValueTitles' => ['AVAILABLE' => 'Available', 'CANCELLED' => 'Canceled', 'RUNNING' => 'Running', 'CANCELLING' => 'Canceling', 'WAITING' => 'Waiting', 'ERROR' => 'Error'],
'type' => 'string',
'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' => '',
],
],
],
'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' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'errorCodes' => [],
'title' => 'GetRegionStatus',
'summary' => 'Retrieves the DLF activation status in a region.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'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'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'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' => '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' => [
'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' => ''],
'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' => '',
],
],
'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' => '',
'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 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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'GetTable',
'responseParamsDescription' => 'Code: The error code.
'."\n"
.'NoSuchObject: The specified metadata table does not exist.
'."\n"
.'InternalError: An internal error occurred. See the Message field for details.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTable'],
],
],
'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'],
'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 data table.', 'type' => 'string', 'required' => false, 'example' => 'test_table_20201223'],
],
[
'name' => 'ColumnNames',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A list of table columns.', '$ref' => '#/components/schemas/ListString', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => [],
],
],
'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' => 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' => '',
'description' => 'Response.',
'type' => 'object',
'properties' => [
'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' => ''],
],
'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' => '',
'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'."\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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'GetTableVersion',
'summary' => 'Retrieves a specific version of a table.',
'responseParamsDescription' => 'Code: The error code.
NoSuchObject: The specified metadata table does not exist.
InternalError: An internal error occurred. For more information, see the Message parameter.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTableVersion'],
],
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The HTTP request body, in the JSON format.',
'type' => 'object',
'properties' => [
'Type' => [
'description' => 'The authorization type. Only Hive is supported.',
'type' => 'string',
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => [],
],
'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' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"4912024D-2A06-5E9F-9667-35D9319917D7\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'translator' => 'manual',
],
'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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '114170',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The HTTP request body.',
'type' => 'object',
'properties' => [
'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' => '',
'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 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' => '',
],
],
],
'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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4316D7DA-9816-596D-A3D7-12676FA59BDA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'translator' => 'manual',
],
'GrantRolesToUser' => [
'path' => '/api/metastore/auth/roles/grantroles',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => ['user_permission'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '114171',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'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 response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'translator' => 'manual',
],
'ListCatalogs' => [
'path' => '/api/metastore/catalogs/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' => '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' => '',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'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'],
],
'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
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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'The status of the request.', 'type' => 'string', 'example' => 'OK'],
'Databases' => [
'title' => '',
'description' => 'The list of metadatabases.',
'type' => 'array',
'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' => '',
'description' => 'Response',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Response Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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"
.'- 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
'."\n"
.'InternalError: An internal error occurred. For more information, see the Message parameter.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatabases'],
],
],
'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'],
'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' => '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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'ListFunctionNames',
'responseParamsDescription' => 'Error codes for the Code parameter:
'."\n"
.'InternalError: An internal error occurred. For more information, see the Message parameter.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionNames'],
],
],
'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'],
'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' => '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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'],
'Functions' => [
'title' => '',
'description' => 'A list of function details.',
'type' => 'array',
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'ListFunctions',
'responseParamsDescription' => 'Error codes for \\`Code\\`:
'."\n"
.'\\`InternalError\\`: The request failed due to an internal error. For more information, see the \\`Message\\` parameter.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctions'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The HTTP request body.',
'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'],
'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' => '',
'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' => '.'],
'NextPageToken' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa'],
'PartitionNames' => [
'title' => '',
'description' => 'A list of partition names.',
'type' => 'array',
'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' => '',
'description' => 'code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The HTTP request body.',
'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'],
'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' => 'true',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '.'],
'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' => '',
],
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'ListPartitions',
'responseParamsDescription' => 'Error codes for the Code parameter:'."\n"
."\n"
.'- 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'],
],
],
'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' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [],
'responses' => [
'5XX' => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'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' => '',
'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' => '.'],
'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' => '',
],
'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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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"
.'- 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'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '139289',
'abilityTreeNodes' => ['FEATUREdlfTGKBOY'],
],
'parameters' => [
[
'name' => 'CatalogId',
'in' => 'query',
'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' => '', 'description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_db'],
],
[
'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' => [
'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,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Response'."\n",
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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\\": \\"-\\",\\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":"\\n -\\n -\\n 97434FA4-A6B2-1AE4-A174-76964F29C759\\n true\\n 1\\n \\n test_db\\n test_tbl\\n year=2023/month=1\\n STANDARD\\n 2023-08-16 18:02:22\\n 2023-08-16 18:02:25\\n 2023-08-22 12:14:42\\n oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1\\n 13\\n 13\\n 1\\n 1\\n 0\\n 4\\n 4\\n OSS_HDFS\\n \\n 2023-08-30 19:16:10\\n","errorExample":""}]',
],
'ListPermissions' => [
'summary' => 'Queries permissions.',
'path' => '/api/metastore/auth/permissions/list',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlfT96YCV'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The HTTP request body, in the JSON format.'."\n",
'type' => 'object',
'properties' => [
'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' => 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' => '',
'description' => 'The returned message body.'."\n",
'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' => '', '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' => [],
],
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'title' => 'ListRoleUsers',
'summary' => 'Lists the users for a specific role.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoleUsers'],
],
],
'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'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '115466',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'NextPageToken',
'in' => 'query',
'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' => 'RoleNamePattern',
'in' => 'query',
'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' => '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' => '',
'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' => '', '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' => '', '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' => '',
'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' => '.'],
'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 name of a table.', 'type' => 'string', 'example' => 'table1', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'5XX' => [
'schema' => [
'title' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'ListTableNames',
'responseParamsDescription' => 'Code: The error code.
'."\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' => 'ListTableNames'],
],
],
'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'],
'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 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'],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'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' => '', 'description' => 'The number of entries per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => 'A table with a version.', '$ref' => '#/components/schemas/TableVersion', 'example' => '{"table":{},"versionId":123}', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'5XX' => [
'schema' => [
'title' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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'],
'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 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' => '', 'description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'database_test'],
],
[
'name' => 'TableType',
'in' => 'query',
'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' => '',
'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' => '.'],
'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' => '',
],
],
'5XX' => [
'schema' => [
'title' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'ListTables',
'responseParamsDescription' => 'Code: The description of the error code.
InternalError: An internal error occurred. For more information, see the message.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTables'],
],
],
'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' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '119439',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'title' => 'ListUserRoles',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserRoles'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'LockId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The lock ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12324'],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'title' => 'RefreshLock',
'requestParamsDescription' => 'The lock ID that is returned by the CreateLock operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshLock'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The registration result.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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 \\"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',
],
'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'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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 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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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 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' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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' => [],
],
],
'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' => [
'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' => [
'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'],
],
'example' => '',
],
],
'5XX' => [],
],
'title' => 'RevokePermissions',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokePermissions'],
],
],
'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' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '114434',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => [
'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'],
],
'example' => '',
],
],
],
'title' => 'RevokeRoleFromUsers',
'summary' => 'Revokes a DLF role from multiple users.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeRoleFromUsers'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '114433',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Returns the message body.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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' => [
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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' => [
'path' => '/api/metastore/catalogs/search',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'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 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 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 object type.',
'type' => 'string',
'enum' => ['table', 'all', 'database'],
'required' => false,
'example' => 'TABLE/DATABASE/CATALOG',
'title' => '',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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 result.',
'type' => 'object',
'properties' => [
'Databases' => [
'title' => '',
'description' => 'A list of databases.',
'type' => 'array',
'items' => [
'description' => 'The 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' => '',
],
'TableResult' => [
'title' => '',
'description' => 'The table result.',
'type' => 'object',
'properties' => [
'Tables' => [
'title' => '',
'description' => 'A list of tables.',
'type' => 'array',
'items' => [
'description' => 'The metadata table.',
'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' => '',
],
],
'example' => '',
],
],
],
'title' => 'Search',
'summary' => 'Retrieves metadata.',
'description' => 'Retrieves metadata.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Search'],
],
],
'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\\": \\"tab2\\"\\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\\": \\"tab2\\"\\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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
'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' => '',
],
'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' => '',
],
],
],
'title' => 'SearchAcrossCatalog',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAcrossCatalog'],
],
],
'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\\": \\"tab2\\"\\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\\": \\"tab2\\"\\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\\": \\"tab2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100\\n }\\n}","type":"json"}]',
],
'StopMigrationWorkflow' => [
'path' => '/webapi/migration/workflow/stop',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the migration task instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'M-6DCF5D8EF92E2195', 'title' => ''],
],
],
'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',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The HTTP request body.',
'type' => 'object',
'properties' => [
'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' => [
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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'],
],
],
'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' => [],
],
'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'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'LockId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The lock ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11709'],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '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'],
],
'example' => '',
],
],
'5XX' => [
'schema' => [
'title' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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'],
],
],
'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'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The request body, in JSON format.',
'type' => 'object',
'properties' => [
'CatalogInput' => ['description' => 'The details of the catalog to update.', 'required' => true, '$ref' => '#/components/schemas/CatalogInput', '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' => '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' => '',
],
],
],
'title' => 'UpdateCatalog',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCatalog'],
],
],
'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' => [],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'title' => 'UpdateCatalogSettings',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCatalogSettings'],
],
],
'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'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'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' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The returned result.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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'],
],
],
'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' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The request body in JSON format.',
'type' => 'object',
'properties' => [
'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' => '',
'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 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' => '',
],
],
],
'title' => 'UpdateFunction',
'responseParamsDescription' => 'Code: The error code.
'."\n"
.'InvalidObject: The specified metadatabase, table, or function does not exist, or a function parameter is empty.
'."\n"
.'InternalError: An internal error occurred. See the Message parameter for more information.
',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunction'],
],
],
'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'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'UpdateTablePartitionColumnStatisticsRequest',
'in' => 'body',
'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' => [
'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' => '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' => 'UpdatePartitionColumnStatistics',
'summary' => 'Creates or updates the column statistics for a data table partition.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePartitionColumnStatistics'],
],
],
'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'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The HTTP request body, in the JSON format.',
'type' => 'object',
'properties' => [
'Type' => [
'description' => 'The authorization type. Only Hive is supported.',
'type' => 'string',
'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. 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' => '',
'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' => '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' => [],
],
'title' => 'UpdatePermissions',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePermissions'],
],
],
'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'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => '',
],
],
'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' => '*'],
],
],
],
],
'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'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.'."\n",
'type' => 'object',
'properties' => [
'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' => '',
'description' => 'Response'."\n",
'type' => 'object',
'properties' => [
'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' => '',
],
],
],
'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' => 'Updates users for a DLF role.',
'path' => '/api/metastore/auth/updateroleusers',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => ['user_permission'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '119306',
'abilityTreeNodes' => ['FEATUREdlfOUR1X3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'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' => '',
'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 was successful. Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
],
'example' => '',
],
],
],
'title' => 'UpdateRoleUsers',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoleUsers'],
],
],
'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' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The HTTP request body. It 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'],
'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' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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' => [],
],
'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'],
],
],
'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' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdlf4RLCBT'],
],
'parameters' => [
[
'name' => 'UpdateTablePartitionColumnStatisticsRequest',
'in' => 'body',
'style' => 'flat',
'schema' => ['description' => 'The update parameters.', '$ref' => '#/components/schemas/UpdateTablePartitionColumnStatisticsRequest', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'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'],
],
'example' => '',
],
],
'5XX' => [
'schema' => [
'title' => '',
'description' => 'Code',
'type' => 'object',
'properties' => [
'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
],
],
'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',
],
],
'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' => '*'],
],
],
],
[
'apiName' => 'CreateDataSource',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetEtlResourceUsages',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetEtlResourceUsages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPartitionsByFilter',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListPartitionsByFilter',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteTableColumnStatistics',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteTableColumnStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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',
'ramAction' => [
'action' => 'dlf:DescribeBlueprintInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTable',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchGetTables',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:BatchGetTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateWorkspaceConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:UpdateWorkspaceConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateWorkflowScheduleStatus',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdateWorkflowScheduleStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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' => '*'],
],
],
],
[
'apiName' => 'UpdateDataSource',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:UpdateDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitUnarchiveTask',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dlf:SubmitUnarchiveTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPartition',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetPartition',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RefreshLock',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:RefreshLock',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteLifecycleResource',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteLifecycleResource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListProxyAccount',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListProxyAccount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRegionStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetRegionStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateRoleUsers',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:UpdateRoleUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeregisterLocation',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeregisterLocation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeMetastoreCrawler',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DescribeMetastoreCrawler',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetUserExtraInfo',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetUserExtraInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateLifecycleRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateLifecycleRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopMigrationWorkflow',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:StopMigrationWorkflow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyMetastoreCrawler',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:ModifyMetastoreCrawler',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateCatalog',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdateCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateRole',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:UpdateRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetLifecycleRule',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetLifecycleRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckBlueprintInstanceName',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:CheckBlueprintInstanceName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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' => '*'],
],
],
],
[
'apiName' => 'GetTableHistoryDetails',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetTableHistoryDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetLifecycleTask',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetLifecycleTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetStatistics',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteRole',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dlf:DeleteRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTableColumnStatistics',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetTableColumnStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataSource',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateBlueprintInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateBlueprintInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateRole',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPartitionColumnStatistics',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetPartitionColumnStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMigrationWorkflowInstanceLogInfo',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetMigrationWorkflowInstanceLogInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopBlueprintInstanceWorkflow',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:StopBlueprintInstanceWorkflow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RevokePermissions',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dlf:RevokePermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateDatabase',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdateDatabase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMetaDataApiCallUsages',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetMetaDataApiCallUsages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSavedQuery',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListSavedQuery',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListWorkflowInstanceRuntimeLogs',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListWorkflowInstanceRuntimeLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyTableServicePolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:ModifyTableServicePolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchUpdatePartitions',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:BatchUpdatePartitions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRdsDBInstanceAttribute',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetRdsDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPermissions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:ListPermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchCreateTables',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:BatchCreateTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateMetastoreCrawler',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateMetastoreCrawler',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RevokeRolesFromUser',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dlf:RevokeRolesFromUser',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListRoles',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:ListRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataSources',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListDataSources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckConnectivity',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dlf:CheckConnectivity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchCreatePartitions',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:BatchCreatePartitions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMetastoreMigration',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetMetastoreMigration',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTableHistory',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListTableHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSavedQuery',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateSavedQuery',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTableServiceAction',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListTableServiceAction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRegions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeletePartition',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeletePartition',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnLock',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UnLock',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetServiceStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetServiceStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListMetastoreCrawlerCreators',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListMetastoreCrawlerCreators',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchUpdateTables',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:BatchUpdateTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchRevokePermissions',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dlf:BatchRevokePermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListMigrationWorkflowInstances',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListMigrationWorkflowInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListUnregisteredLocations',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListUnregisteredLocations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateMetastoreMigration',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateMetastoreMigration',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMetaDataStorageUsages',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetMetaDataStorageUsages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListBlueprintInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListBlueprintInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateWorkflowExecuteInfo',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:UpdateWorkflowExecuteInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCatalogSettings',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetCatalogSettings',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetBlueprintInstance',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetBlueprintInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListRdsDBInstances',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListRdsDBInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCatalogs',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListCatalogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitQuery',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:SubmitQuery',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateMetastoreMigration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:UpdateMetastoreMigration',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePartition',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:CreatePartition',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTableUnregisteredLocations',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListTableUnregisteredLocations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GrantRoleToUsers',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:GrantRoleToUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PreviewMetastoreCrawler',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:PreviewMetastoreCrawler',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateTable',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:CreateTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTableServicePolicy',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListTableServicePolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GrantPermissions',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:GrantPermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListBlueprintInstanceCreators',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListBlueprintInstanceCreators',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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',
'ramAction' => [
'action' => 'dlf:GetAsyncTaskStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTableExtended',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetTableExtended',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenamePartition',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:RenamePartition',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTableVersion',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetTableVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdatePermissions',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:UpdatePermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetStorageRank',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetStorageRank',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateLock',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:CreateLock',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'Search',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:Search',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListStorageCollector',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListStorageCollector',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListMetastoreCrawler',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListMetastoreCrawler',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDatabaseProfile',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetDatabaseProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListLifecycleResources',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListLifecycleResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyWorkflowExecuteInfo',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:ModifyWorkflowExecuteInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteBlueprintInstance',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteBlueprintInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDatabase',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:CreateDatabase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetLatestDate',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetLatestDate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSavedQuery',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteSavedQuery',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeletePartitionColumnStatistics',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeletePartitionColumnStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListUserRoles',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:ListUserRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCatalog',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RevokeRoleFromUsers',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dlf:RevokeRoleFromUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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' => '*'],
],
],
],
[
'apiName' => 'UpdateFunction',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdateFunction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteMetastoreCrawler',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteMetastoreCrawler',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RunBlueprintInstanceWorkflow',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:RunBlueprintInstanceWorkflow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTables',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateLifecycleRule',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdateLifecycleRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchGrantPermissions',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:BatchGrantPermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetLocationIndicatorDetails',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetLocationIndicatorDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AbortLock',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:AbortLock',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateTable',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdateTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTableNames',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListTableNames',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDatabases',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListDatabases',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetLock',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetLock',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListMetastoreMigrations',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListMetastoreMigrations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetWorkflowInstance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetWorkflowInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDataSource',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateUserFeedback',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateUserFeedback',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPartitionNames',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListPartitionNames',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPartitionsByExpr',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListPartitionsByExpr',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTableProfile',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetTableProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCatalog',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SearchAcrossCatalog',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:SearchAcrossCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopCrawlerWorkflow',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:StopCrawlerWorkflow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDatabase',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteDatabase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRole',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:GetRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdatePartitionColumnStatistics',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdatePartitionColumnStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateTpcdsDatabase',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dlf:CreateTpcdsDatabase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenameTable',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:RenameTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateRegisteredLocation',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:UpdateRegisteredLocation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeZones',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dlf:DescribeZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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' => '*'],
],
],
],
[
'apiName' => 'ListRoleUsers',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:ListRoleUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetStorageAnalysis',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetStorageAnalysis',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDataSource',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:DescribeDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchGetPartitionColumnStatistics',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:BatchGetPartitionColumnStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateCatalogSettings',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:UpdateCatalogSettings',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPartitions',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListPartitions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListLifecycleTasks',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListLifecycleTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RunLifecycleRule',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:RunLifecycleRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetHudiProperties',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetHudiProperties',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchGetPartitions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:BatchGetPartitions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelQuery',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:CancelQuery',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RegisterLocation',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:RegisterLocation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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' => '*'],
],
],
],
[
'apiName' => 'ListRegisteredLocations',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListRegisteredLocations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RunMigrationWorkflow',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:RunMigrationWorkflow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListFunctions',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListFunctions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTableVersions',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:ListTableVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RefreshUserSession',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dlf:RefreshUserSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListFunctionNames',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListFunctionNames',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteTableVersion',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteTableVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchDeleteTableVersions',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:BatchDeleteTableVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPartitionsProfile',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dlf:ListPartitionsProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckPermissions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dlf:CheckPermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteFunction',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:DeleteFunction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetUnarchiveDetail',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'dlf:GetUnarchiveDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataLake', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'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' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];