summaryrefslogtreecommitdiff
path: root/data/en_us/datalake/2020-07-10/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/datalake/2020-07-10/api-docs.php
downloadacs-metadata-full-1.0.0+20260212.tar.gz
acs-metadata-full-1.0.0+20260212.zip
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/datalake/2020-07-10/api-docs.php')
-rw-r--r--data/en_us/datalake/2020-07-10/api-docs.php15829
1 files changed, 15829 insertions, 0 deletions
diff --git a/data/en_us/datalake/2020-07-10/api-docs.php b/data/en_us/datalake/2020-07-10/api-docs.php
new file mode 100644
index 0000000..3302c4c
--- /dev/null
+++ b/data/en_us/datalake/2020-07-10/api-docs.php
@@ -0,0 +1,15829 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'ROA',
+ 'product' => 'DataLake',
+ 'version' => '2020-07-10',
+ ],
+ 'directories' => [
+ [
+ 'id' => 167316,
+ 'title' => 'Metadata',
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 169629,
+ 'title' => 'Catalog',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateCatalog',
+ 'DeleteCatalog',
+ 'UpdateCatalog',
+ 'ListCatalogs',
+ 'GetCatalog',
+ ],
+ ],
+ [
+ 'id' => 161865,
+ 'title' => 'Database',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDatabase',
+ 'DeleteDatabase',
+ 'UpdateDatabase',
+ 'GetDatabase',
+ 'ListDatabases',
+ ],
+ ],
+ [
+ 'id' => 161889,
+ 'title' => 'Table',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateTable',
+ 'DeleteTable',
+ 'DeleteTableColumnStatistics',
+ 'DeleteTableVersion',
+ 'UpdateTable',
+ 'UpdateTableColumnStatistics',
+ 'GetTable',
+ 'GetTableColumnStatistics',
+ 'GetTableVersion',
+ 'ListTableNames',
+ 'ListTables',
+ 'ListTableVersions',
+ 'GetTableProfile',
+ 'RenameTable',
+ 'BatchGetTables',
+ 'BatchCreateTables',
+ 'BatchDeleteTables',
+ 'BatchDeleteTableVersions',
+ 'BatchUpdateTables',
+ ],
+ ],
+ [
+ 'id' => 161872,
+ 'title' => 'Partition',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreatePartition',
+ 'DeletePartition',
+ 'DeletePartitionColumnStatistics',
+ 'UpdatePartitionColumnStatistics',
+ 'GetPartition',
+ 'GetPartitionColumnStatistics',
+ 'ListPartitionNames',
+ 'ListPartitions',
+ 'ListPartitionsByFilter',
+ 'BatchCreatePartitions',
+ 'BatchDeletePartitions',
+ 'BatchGetPartitionColumnStatistics',
+ 'BatchGetPartitions',
+ 'BatchUpdatePartitions',
+ 'RenamePartition',
+ ],
+ ],
+ [
+ 'id' => 161908,
+ 'title' => 'Function',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateFunction',
+ 'DeleteFunction',
+ 'UpdateFunction',
+ 'ListFunctionNames',
+ 'ListFunctions',
+ 'GetFunction',
+ ],
+ ],
+ [
+ 'id' => 161845,
+ 'title' => 'Lock',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateLock',
+ 'GetLock',
+ 'AbortLock',
+ 'RefreshLock',
+ 'UnLock',
+ ],
+ ],
+ [
+ 'id' => 166936,
+ 'title' => 'Metadata Migration',
+ 'type' => 'directory',
+ 'children' => [
+ 'StopMigrationWorkflow',
+ 'RunMigrationWorkflow',
+ ],
+ ],
+ 'GetAsyncTaskStatus',
+ 'Search',
+ ],
+ ],
+ [
+ 'id' => 161796,
+ 'title' => 'Permissions',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateRole',
+ 'GrantRoleToUsers',
+ 'GrantRolesToUser',
+ 'GrantPermissions',
+ 'BatchGrantPermissions',
+ 'DeleteRole',
+ 'RevokeRoleFromUsers',
+ 'RevokeRolesFromUser',
+ 'RevokePermissions',
+ 'BatchRevokePermissions',
+ 'UpdateRole',
+ 'UpdateRoleUsers',
+ 'UpdatePermissions',
+ 'UpdateCatalogSettings',
+ 'GetRole',
+ 'ListRoles',
+ 'ListRoleUsers',
+ 'ListUserRoles',
+ 'ListPermissions',
+ 'CheckPermissions',
+ 'GetCatalogSettings',
+ ],
+ ],
+ [
+ 'id' => 166939,
+ 'title' => 'Data exploration',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetQueryResult',
+ 'SubmitQuery',
+ 'CancelQuery',
+ ],
+ ],
+ [
+ 'id' => 161818,
+ 'title' => 'Universal Services',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetRegionStatus',
+ 'GetServiceStatus',
+ 'DescribeRegions',
+ ],
+ ],
+ [
+ 'id' => 178756,
+ 'title' => 'Other',
+ 'type' => 'directory',
+ 'children' => [
+ 'SearchAcrossCatalog',
+ 'RegisterLocation',
+ 'DeregisterLocation',
+ 'UpdateRegisteredLocation',
+ 'ListPartitionsByExpr',
+ 'GetDatabaseProfile',
+ 'GetLifecycleRule',
+ 'ListPartitionsProfile',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'AccessRequest' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The information about the access request.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'PrivilegeResources' => [
+ 'description' => 'resource list to be authorized.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'PrivilegeResources',
+ '$ref' => '#/components/schemas/PrivilegeResources',
+ ],
+ 'Principal' => [
+ 'description' => 'Visitors.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Principal',
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The category ID.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '1344371',
+ 'backendName' => 'CatalogId',
+ ],
+ ],
+ ],
+ 'Catalog' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The information about the data directory.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '1344371',
+ 'backendName' => 'CatalogId',
+ ],
+ 'Description' => [
+ 'title' => 'Description',
+ 'description' => 'The description of the cluster.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '',
+ 'backendName' => 'Description',
+ ],
+ 'LocationUri' => [
+ 'title' => 'LocationUri',
+ 'description' => 'The path of the directory.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'oss://dlf-test-oss-location/',
+ 'backendName' => 'LocationUri',
+ ],
+ 'Owner' => [
+ 'title' => '',
+ 'description' => 'Owner: Principal format.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'acs:ram::[accountId]:root',
+ 'backendName' => 'Owner',
+ ],
+ 'CreatedBy' => [
+ 'title' => '',
+ 'description' => 'Created by: principal format.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'acs:ram::[accountId]:root'."\n",
+ 'backendName' => 'CreatedBy',
+ ],
+ 'CreateTime' => [
+ 'title' => '',
+ 'description' => 'Creation time: the number of seconds in a UNIX timestamp.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1640662815603',
+ 'backendName' => 'CreateTime',
+ ],
+ 'UpdateTime' => [
+ 'title' => '',
+ 'description' => 'Update time: the number of seconds in the UNIX timestamp.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1640662815603',
+ 'backendName' => 'UpdateTime',
+ ],
+ 'Status' => [
+ 'title' => '',
+ 'description' => 'The status of the catalog.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'CREATED',
+ 'backendName' => 'Status',
+ ],
+ 'CatalogType' => [
+ 'title' => '',
+ 'description' => 'The catalog type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* NATIVE: NATIVE.'."\n"
+ .'* HMS: HMS.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'NATIVE' => 'NATIVE',
+ 'HMS' => 'HMS',
+ ],
+ 'example' => 'HMS',
+ 'backendName' => 'CatalogType',
+ ],
+ 'DefaultCatalog' => [
+ 'title' => '',
+ 'description' => 'Whether it is the default data directory.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'DefaultCatalog',
+ ],
+ 'ThriftEnabled' => [
+ 'title' => 'ThriftEnabled',
+ 'description' => 'Whether to enable Thrift port access.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'ThriftEnabled',
+ ],
+ 'JdbcEnabled' => [
+ 'title' => 'JdbcEnabled',
+ 'description' => 'Whether to enable JDBC port access.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'JdbcEnabled',
+ ],
+ 'StorageAccessConfig' => [
+ 'title' => 'StorageAccessConfig',
+ 'description' => 'Storage access configuration.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'StorageAccessConfig',
+ ],
+ ],
+ ],
+ 'CatalogInput' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Creates or updates the structure of a catalog.',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The ID of the catalog.',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'catalog_test',
+ 'backendName' => 'CatalogId',
+ ],
+ 'Description' => [
+ 'title' => 'Description',
+ 'description' => 'The description of the catalog.',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'The test data catalog.',
+ 'backendName' => 'Description',
+ ],
+ 'LocationUri' => [
+ 'title' => 'LocationUri',
+ 'description' => 'The path to the catalog.',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'oss://dlf-test-oss-location/',
+ 'backendName' => 'LocationUri',
+ ],
+ 'Owner' => [
+ 'title' => '',
+ 'description' => 'Owner: Principal format.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'acs:ram::[accountId]:root',
+ 'backendName' => 'Owner',
+ ],
+ 'CatalogType' => [
+ 'title' => '',
+ 'description' => 'The catalog type.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'CatalogType',
+ 'default' => 'NATIVE',
+ ],
+ 'ThriftEnabled' => [
+ 'title' => 'ThriftEnabled',
+ 'description' => 'Specifies whether to enable Thrift port access.',
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'ThriftEnabled',
+ ],
+ 'JdbcEnabled' => [
+ 'title' => 'JdbcEnabled',
+ 'description' => 'Specifies whether to enable JDBC port access.',
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'JdbcEnabled',
+ ],
+ 'StorageAccessConfig' => [
+ 'title' => 'StorageAccessConfig',
+ 'description' => 'The storage access configuration.',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'StorageAccessConfig',
+ ],
+ ],
+ ],
+ 'CatalogResource' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Authentication resource structure: data directory.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'Catalog id',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '1344371',
+ 'backendName' => 'CatalogId',
+ ],
+ ],
+ ],
+ 'CatalogSettings' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Data Lake-related configurations'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Config' => [
+ 'title' => '',
+ 'description' => 'The metadata of the sample.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'The permission configuration of the data lake. auth.permission.check.enable indicates whether to enable metadata server-side authentication. After metadata access through API is enabled, authentication is performed. auth.super.principal indicates that a super user is configured and the super user bypasses all authentication.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .'"auth.permission.check.enable":'."\n"
+ .'"true",'."\n"
+ .'"auth.super.principal":'."\n"
+ .'"acs:ram::[aliyunAccountId]:role/aliyundlfworkflowdefaultrole"'."\n"
+ .'}',
+ ],
+ 'backendName' => 'Config',
+ ],
+ ],
+ ],
+ 'ColumnResource' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Authentication resource structure-Column'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the metatable.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test',
+ 'backendName' => 'TableName',
+ ],
+ 'ColumnNames' => [
+ 'title' => 'ColumnName',
+ 'description' => 'The list of field names.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The field name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'name',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'ColumnNames',
+ 'itemName' => 'ColumnName',
+ ],
+ ],
+ ],
+ 'ColumnStatistics' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The field statistics.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnStatisticsDesc' => [
+ 'description' => 'The description of the field statistics.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'ColumnStatisticsDesc',
+ '$ref' => '#/components/schemas/ColumnStatisticsDesc',
+ ],
+ 'ColumnStatisticsObjList' => [
+ 'title' => 'ColumnStatisticsObjList',
+ 'description' => 'The field statistics.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The field statistics.'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/ColumnStatisticsObj',
+ ],
+ 'backendName' => 'ColumnStatisticsObjectList',
+ ],
+ 'Engine' => [
+ 'title' => 'Engine for hive3+',
+ 'description' => 'The database engine version of the instance.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '',
+ 'backendName' => 'Engine',
+ ],
+ 'IsStatsCompliant' => [
+ 'title' => 'IsStatsCompliant for hive3+',
+ 'description' => 'Whether the field statistics comply with the statistical specifications. Valid values:'."\n"
+ ."\n"
+ .'* true: The column statistics comply with Hive specifications and can be used by the query optimizer.'."\n"
+ .'* false: indicates that the column statistics do not conform to the specifications. The query optimizer may not use these statistics for query optimization.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ 'backendName' => 'IsStatsCompliant',
+ ],
+ ],
+ ],
+ 'ColumnStatisticsDesc' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'ColumnStatisticsDesc'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'LastAnalyzedTime' => [
+ 'title' => 'optional',
+ 'description' => 'Last Analysis Time'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12312323',
+ 'backendName' => 'LastAnalyzedTime',
+ ],
+ 'PartitionName' => [
+ 'title' => 'required',
+ 'description' => 'The name of the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'ds=201212/hh=23',
+ 'backendName' => 'PartitionName',
+ ],
+ ],
+ ],
+ 'ColumnStatisticsObj' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'ColumnStatisticsObj'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'title' => 'ColumnName of the table',
+ 'description' => 'The name of the field.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'col1',
+ 'backendName' => 'ColumnName',
+ ],
+ 'ColumnType' => [
+ 'title' => 'ColumnType',
+ 'description' => 'Field type, including array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'int',
+ 'backendName' => 'ColumnType',
+ ],
+ 'ColumnStatisticsData' => [
+ 'title' => 'ColumnStatisticsData',
+ 'description' => 'The statistics on the field.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'StatisticsData' => [
+ 'title' => 'StatisticsData',
+ 'description' => 'The statistical results of the field.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '{"numNulls":0,"numTrues":1,"numFalses":5}',
+ 'backendName' => 'StatisticsData',
+ ],
+ 'StatisticsType' => [
+ 'title' => 'StatisticsType',
+ 'description' => 'Statistics type: BOOLEAN_STATS,LONG_STATS,DOUBLE_STATS,STRING_STATS,BINARY_STATS,DECIMAL_STATS, and DATE_STATS'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'BOOLEAN_STATS',
+ 'backendName' => 'StatisticsType',
+ ],
+ ],
+ 'backendName' => 'ColumnStatisticsData',
+ ],
+ ],
+ ],
+ 'Database' => [
+ 'title' => 'Database Object',
+ 'description' => 'Database object'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => [
+ 'title' => 'createTime',
+ 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'CreateTime',
+ ],
+ 'Description' => [
+ 'title' => 'description',
+ 'description' => 'The description of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'this is a hive database',
+ 'backendName' => 'Description',
+ ],
+ 'LocationUri' => [
+ 'title' => 'locationUri',
+ 'description' => 'Metabase storage path, such as HDFS path'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '/hdfs/hivedb/data',
+ 'backendName' => 'LocationUri',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'Name',
+ ],
+ 'OwnerName' => [
+ 'title' => 'ownerName',
+ 'description' => 'The name of the owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'OwnerName',
+ ],
+ 'OwnerType' => [
+ 'title' => 'ownerType',
+ 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'OwnerType',
+ ],
+ 'Parameters' => [
+ 'description' => 'The key-value pairs (KVPs) that define the parameters and attributes of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Parameters',
+ '$ref' => '#/components/schemas/Parameters',
+ ],
+ 'Privileges' => [
+ 'description' => 'The permissions on the metadatabase. This parameter is optional.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Privileges',
+ '$ref' => '#/components/schemas/PrincipalPrivilegeSet',
+ ],
+ 'UpdateTime' => [
+ 'title' => 'updateTime',
+ 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'UpdateTime',
+ ],
+ 'CreatedBy' => [
+ 'title' => 'CreatedBy',
+ 'description' => 'The user who created the drive.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'root',
+ 'backendName' => 'CreatedBy',
+ ],
+ ],
+ ],
+ 'DatabaseInput' => [
+ 'title' => 'Database input',
+ 'description' => 'Database object'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => [
+ 'title' => 'Description',
+ 'description' => 'The description of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'this is a hive database',
+ 'backendName' => 'Description',
+ ],
+ 'LocationUri' => [
+ 'title' => 'locationUri',
+ 'description' => 'The storage path of the metabase. For example, you can enter the HDFS path.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '/hdfs/hivedb/data',
+ 'backendName' => 'LocationUri',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of the metabase. The verification length is 128. Special characters other than underscores are not supported.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'name',
+ 'backendName' => 'Name',
+ ],
+ 'OwnerName' => [
+ 'title' => 'ownerName',
+ 'description' => 'The name of the owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'OwnerName',
+ ],
+ 'OwnerType' => [
+ 'title' => 'ownerType',
+ 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'OwnerType',
+ ],
+ 'Parameters' => [
+ 'description' => 'The key-value pairs (KVPs) that define the parameters and attributes of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Parameters',
+ '$ref' => '#/components/schemas/Parameters',
+ ],
+ 'Privileges' => [
+ 'description' => 'The permissions on the metadatabase. This parameter is optional.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Privileges',
+ '$ref' => '#/components/schemas/PrincipalPrivilegeSet',
+ ],
+ 'CreateTime' => [
+ 'title' => 'createTime',
+ 'description' => 'Creation time, required.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1580869631',
+ 'backendName' => 'CreateTime',
+ ],
+ ],
+ ],
+ 'DatabaseProfile' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Database Data Overview'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileCnt' => [
+ 'title' => '',
+ 'description' => 'Total library files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3234',
+ 'backendName' => 'fileCnt',
+ ],
+ 'FileSize' => [
+ 'title' => '',
+ 'description' => 'Library storage size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1254312',
+ 'backendName' => 'fileSize',
+ ],
+ 'Name' => [
+ 'title' => '',
+ 'description' => 'The library name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_db',
+ 'backendName' => 'databaseName',
+ ],
+ 'CreateTime' => [
+ 'title' => '',
+ 'description' => 'The time when the data address was created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-08-16 18:02:22',
+ 'backendName' => 'createTime',
+ ],
+ 'Location' => [
+ 'title' => '',
+ 'description' => 'The location where the sample is stored.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/',
+ 'backendName' => 'location',
+ ],
+ 'ObjectSize' => [
+ 'title' => '',
+ 'description' => 'OSS file size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1254312',
+ 'backendName' => 'objectSize',
+ ],
+ 'ObjectCnt' => [
+ 'title' => '',
+ 'description' => 'Number of OSS files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3234',
+ 'backendName' => 'objectCnt',
+ ],
+ 'LatestDate' => [
+ 'title' => '',
+ 'description' => 'The time when the metadata warehouse was updated.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-08-30 19:16:10',
+ 'backendName' => 'latestDate',
+ ],
+ ],
+ ],
+ 'DatabaseResource' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Authentication resource structure: database.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseName' => [
+ 'title' => 'Database name',
+ 'description' => 'The name of the queried database.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'DatabaseWildcard' => [
+ 'title' => 'A wildcard member representing every resource under a database',
+ 'description' => 'Database wildcard.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '*',
+ 'backendName' => 'DatabaseWildcard',
+ ],
+ ],
+ 'parseType' => 'struct',
+ ],
+ 'DbStorageRank' => [
+ 'title' => '',
+ 'description' => 'Library storage ranking'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Quantity' => [
+ 'title' => '',
+ 'description' => 'Library storage size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9897183010448',
+ 'backendName' => 'Quantity',
+ ],
+ 'DbName' => [
+ 'title' => '',
+ 'description' => 'The library name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'tpcds_text_parquet_10000"',
+ 'backendName' => 'DbName',
+ ],
+ ],
+ ],
+ 'ErrorDetail' => [
+ 'title' => 'ErrorDetail',
+ 'description' => 'ErrorDetail'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The error code.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The error message.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'auth failed',
+ ],
+ ],
+ ],
+ 'FieldSchema' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'FieldSchema'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Comment' => [
+ 'title' => 'Comment',
+ 'description' => 'The comments on the field.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'comment_day',
+ ],
+ 'Name' => [
+ 'title' => 'Name',
+ 'description' => 'The name of the field.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'day',
+ ],
+ 'Parameters' => [
+ 'description' => 'The KVPs that define the attributes associated with the field.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/Parameters',
+ ],
+ 'Type' => [
+ 'title' => 'Type',
+ 'description' => 'Field type, including array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'int',
+ ],
+ ],
+ ],
+ 'FileCnt' => [
+ 'title' => '',
+ 'description' => 'Small file distribution information'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Small' => [
+ 'title' => '',
+ 'description' => 'Number of small files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ 'backendName' => 'Small',
+ ],
+ 'Large' => [
+ 'title' => '',
+ 'description' => 'Number of large files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ 'backendName' => 'Large',
+ ],
+ 'Tiny' => [
+ 'title' => '',
+ 'description' => 'Number of very small files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '124',
+ 'backendName' => 'Tiny',
+ ],
+ 'Middle' => [
+ 'title' => '',
+ 'description' => 'Number of files in'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33',
+ 'backendName' => 'Middle',
+ ],
+ ],
+ ],
+ 'Function' => [
+ 'title' => 'Function Object',
+ 'description' => 'Functions'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '1344371',
+ 'backendName' => 'CatalogId',
+ ],
+ 'ClassName' => [
+ 'title' => 'ClassName',
+ 'description' => 'The name of the Java class that contains the implementation of the function'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'com.xxx.xxxxFunction',
+ 'backendName' => 'ClassName',
+ ],
+ 'CreateTime' => [
+ 'title' => 'CreateTime',
+ 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608863962',
+ 'backendName' => 'CreateTime',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'FunctionName' => [
+ 'title' => 'FunctionName',
+ 'description' => 'The function name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'function1',
+ 'backendName' => 'FunctionName',
+ ],
+ 'FunctionType' => [
+ 'title' => 'FunctionType',
+ 'description' => 'The type of the function. Currently, the supported enumeration is JAVA.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'JAVA',
+ 'backendName' => 'FunctionType',
+ ],
+ 'OwnerName' => [
+ 'title' => 'OwnerName',
+ 'description' => 'The name of the owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'OwnerName',
+ ],
+ 'OwnerType' => [
+ 'title' => 'OwnerType',
+ 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'OwnerType',
+ ],
+ 'ResourceUri' => [
+ 'title' => 'ResourceUri',
+ 'description' => 'Resource URI of the function'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Resource URI of the function'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/ResourceUri',
+ ],
+ 'backendName' => 'ResourceUri',
+ ],
+ 'UpdateTime' => [
+ 'title' => 'UpdateTime',
+ 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608863962',
+ 'backendName' => 'UpdateTime',
+ ],
+ 'CreatedBy' => [
+ 'title' => 'CreatedBy',
+ 'description' => 'The user who created the drive.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'CreatedBy',
+ 'backendName' => 'CreatedBy',
+ ],
+ ],
+ ],
+ 'FunctionInput' => [
+ 'title' => 'Function Input',
+ 'description' => 'Functions'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClassName' => [
+ 'title' => 'ClassName',
+ 'description' => 'The name of the Java class that contains the implementation of the function'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'com.xxx.xxxxFunction',
+ 'backendName' => 'ClassName',
+ ],
+ 'FunctionName' => [
+ 'title' => 'FunctionName',
+ 'description' => 'The function name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'function1',
+ 'backendName' => 'FunctionName',
+ ],
+ 'FunctionType' => [
+ 'title' => 'FunctionType',
+ 'description' => 'The type of the function. Currently, the supported enumeration is JAVA.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'JAVA',
+ 'backendName' => 'FunctionType',
+ ],
+ 'OwnerName' => [
+ 'title' => 'OwnerName',
+ 'description' => 'The name of the owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'OwnerName',
+ ],
+ 'OwnerType' => [
+ 'title' => 'OwnerType',
+ 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'OwnerType',
+ ],
+ 'ResourceUri' => [
+ 'title' => 'ResourceUri',
+ 'description' => 'Resource URI of the function'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Resource URI of the function'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/ResourceUri',
+ ],
+ 'backendName' => 'ResourceUri',
+ ],
+ 'CreateTime' => [
+ 'title' => 'createTime',
+ 'description' => 'The time when the rule was created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1638501155',
+ 'backendName' => 'CreateTime',
+ ],
+ ],
+ ],
+ 'FunctionResource' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Authentication resource structure: Function.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseName' => [
+ 'title' => 'Database name',
+ 'description' => 'The name of the database.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'FunctionName' => [
+ 'title' => 'Function name',
+ 'description' => 'The name of the function.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'FunctioName',
+ ],
+ ],
+ ],
+ 'GrantRevokeEntry' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'A short description of struct'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'MetaResource' => [
+ 'title' => '',
+ 'description' => 'Authorized resource structure'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'MetaResource',
+ '$ref' => '#/components/schemas/MetaResource',
+ ],
+ 'Accesses' => [
+ 'title' => '',
+ 'description' => 'Permissions Access List'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Accesses',
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'DelegateAccesses' => [
+ 'title' => '',
+ 'description' => 'Later through the server extension support'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'DelegateAccesses',
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'Principal' => [
+ 'title' => '',
+ 'description' => 'The ARN of the unique identity.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Principal',
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ 'Id' => [
+ 'title' => 'identifier for this entry',
+ 'description' => 'The entry ID is used to process exception messages.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'CRW-7A1EC3D73BF419AF',
+ 'backendName' => 'Id',
+ ],
+ ],
+ ],
+ 'IndicatorStatistic' => [
+ 'title' => '',
+ 'description' => 'Metric Detail Record'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'Detail Data'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Data',
+ ],
+ 'Date' => [
+ 'title' => '',
+ 'description' => 'Detail Date'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '202401',
+ 'backendName' => 'Date',
+ ],
+ ],
+ ],
+ 'LifecycleRule' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The information about the lifecycle rule.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'BizId' => [
+ 'title' => 'bizId',
+ 'description' => 'The business ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'bizId',
+ ],
+ 'GmtCreate' => [
+ 'title' => '',
+ 'description' => 'The time when the tunnel was created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'gmtCreate',
+ ],
+ 'GmtModified' => [
+ 'title' => '',
+ 'description' => 'The time when the data address was last modified.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'gmtModified',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The rule name.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'name',
+ ],
+ 'ResourceType' => [
+ 'title' => 'resourceType',
+ 'description' => 'The resource type that supports the drift detection feature.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'resourceType',
+ ],
+ 'BindCount' => [
+ 'title' => 'bindCount',
+ 'description' => 'The number of resources bound to the lifecycle rule.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'backendName' => 'bindCount',
+ ],
+ 'Description' => [
+ 'title' => 'description',
+ 'description' => 'The description of the synchronization task.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'description',
+ ],
+ 'RuleType' => [
+ 'title' => 'ruleType',
+ 'description' => 'The WAF rule type.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'ruleType',
+ ],
+ 'Config' => [
+ 'title' => 'Config',
+ 'description' => 'The configuration of the data.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'config',
+ ],
+ 'IaDays' => [
+ 'title' => 'iaDays',
+ 'description' => 'The number of days in which the lifecycle is set.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ 'backendName' => 'iaDays',
+ ],
+ 'ArchiveDays' => [
+ 'title' => 'archiveDays',
+ 'description' => 'The number of days to archive in the lifecycle settings.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ 'backendName' => 'archiveDays',
+ ],
+ 'ColdArchiveDays' => [
+ 'title' => 'coldArchiveDays',
+ 'description' => 'The number of days to transfer to Cold Archive.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ 'backendName' => 'coldArchiveDays',
+ ],
+ 'ScheduleStatus' => [
+ 'title' => 'scheduleStatus',
+ 'description' => 'The scheduling status.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'scheduleStatus',
+ ],
+ 'Workflow' => [
+ 'title' => '',
+ 'description' => 'The workflow.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'workflow',
+ '$ref' => '#/components/schemas/Workflow',
+ ],
+ 'WorkflowId' => [
+ 'title' => '',
+ 'description' => 'The workflow ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'workflowId',
+ ],
+ 'WorkflowInstance' => [
+ 'title' => '',
+ 'description' => 'The workflow instance.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'workflowInstance',
+ '$ref' => '#/components/schemas/WorkflowInstance',
+ ],
+ 'CatalogId' => [
+ 'title' => '',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'catalogName',
+ ],
+ ],
+ ],
+ 'ListFieldSchema' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'ListFieldSchema array'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The definitions of table fields.'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/FieldSchema',
+ ],
+ 'parseType' => 'json',
+ ],
+ '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' => 'ListString Object',
+ 'description' => 'ListString'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The key value.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2010',
+ 'extendType' => 'true',
+ ],
+ 'parseType' => 'json',
+ ],
+ 'LockObj' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'LockObj'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '1344371',
+ 'backendName' => 'CatalogId',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'PartitionName' => [
+ 'title' => 'PartitionName',
+ 'description' => 'The name of the partition. This parameter is optional.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'dt',
+ 'backendName' => 'PartitionName',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the metadata table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_table',
+ 'backendName' => 'TableName',
+ ],
+ ],
+ ],
+ 'LockStatus' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'LockStatus'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'LockId' => [
+ 'title' => 'LockId',
+ 'description' => 'Unique lock ID'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ 'backendName' => 'LockId',
+ ],
+ 'LockState' => [
+ 'title' => 'ACQUIRED/NOT_ACQUIRED',
+ 'description' => 'The status of the lock. Valid values: ACQUIRED and NOT_ACQUIRED.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'ACQUIRED',
+ 'backendName' => 'LockState',
+ ],
+ ],
+ ],
+ 'LogInfo' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'View logs.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'GmtCreate' => [
+ 'title' => '',
+ 'description' => 'The time when the data address was created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'gmtCreate',
+ ],
+ 'InstanceId' => [
+ 'title' => '',
+ 'description' => 'The instance ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'instanceId',
+ ],
+ 'BizTime' => [
+ 'title' => '',
+ 'description' => 'Business up time'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'bizTime',
+ ],
+ 'LogType' => [
+ 'title' => '',
+ 'description' => 'The log level.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'logType',
+ ],
+ 'LogId' => [
+ 'title' => '',
+ 'description' => 'log id'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'logId',
+ ],
+ 'LogSummary' => [
+ 'title' => '',
+ 'description' => 'Log Summary'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'logSummary',
+ ],
+ 'LogContent' => [
+ 'title' => '',
+ 'description' => 'The returned entries.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'logContent',
+ ],
+ ],
+ ],
+ 'MetaResource' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Authentication resource structure'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'title' => '',
+ 'description' => 'Metadata resource object type'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* TABLE: metadata table.'."\n"
+ .'* DATABASE: metabase.'."\n"
+ .'* COLUMN: field.'."\n"
+ .'* CATALOG: the metadata directory.'."\n"
+ .'* FUNCTION: function.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'TABLE' => 'TABLE',
+ 'DATABASE' => 'DATABASE',
+ 'COLUMN' => 'COLUMN',
+ ' CATALOG' => ' CATALOG',
+ ' FUNCTION' => ' FUNCTION',
+ ],
+ 'example' => 'TABLE',
+ 'backendName' => 'ResourceType',
+ ],
+ 'CatalogResource' => [
+ 'title' => 'catalog resource',
+ 'description' => 'Catalog resources'."\n",
+ 'visibility' => 'public',
+ 'example' => '',
+ 'backendName' => 'CatalogResource',
+ '$ref' => '#/components/schemas/CatalogResource',
+ ],
+ 'DatabaseResource' => [
+ 'title' => 'database resource',
+ 'description' => 'Database resources'."\n",
+ 'visibility' => 'public',
+ 'example' => '',
+ 'backendName' => 'DatabaseResource',
+ '$ref' => '#/components/schemas/DatabaseResource',
+ ],
+ 'TableResource' => [
+ 'title' => 'table resource',
+ 'description' => 'Table resources'."\n",
+ 'visibility' => 'public',
+ 'example' => '',
+ 'backendName' => 'TableResource',
+ '$ref' => '#/components/schemas/TableResource',
+ ],
+ 'FunctionResource' => [
+ 'title' => 'function resource',
+ 'description' => 'Function resources'."\n",
+ 'visibility' => 'public',
+ 'example' => '',
+ 'backendName' => 'FunctionResource',
+ '$ref' => '#/components/schemas/FunctionResource',
+ ],
+ 'ColumnResource' => [
+ 'title' => 'column resource',
+ 'description' => 'Column resources'."\n",
+ 'visibility' => 'public',
+ 'example' => '',
+ 'backendName' => 'ColumnResource',
+ '$ref' => '#/components/schemas/ColumnResource',
+ ],
+ ],
+ ],
+ 'Order' => [
+ 'title' => 'Order Object',
+ 'description' => 'Order'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Col' => [
+ 'title' => 'Col',
+ 'description' => 'The name of the field.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'col1',
+ ],
+ 'Order' => [
+ 'title' => 'Order',
+ 'description' => '1 indicates ascending order, 0 indicates descending order'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'Parameters' => [
+ 'title' => 'parameter map',
+ 'description' => 'Parameters'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'Parameter key/value'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'key',
+ ],
+ 'parseType' => 'json',
+ ],
+ 'Partition' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Partition'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => [
+ 'title' => 'CreateTime',
+ 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608730999',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ ],
+ 'LastAccessTime' => [
+ 'title' => 'LastAccessTime',
+ 'description' => 'The time when the partition was last accessed. The value is in the UNIX timestamp format. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608730999',
+ ],
+ 'LastAnalyzedTime' => [
+ 'title' => 'LastAnalyzedTime',
+ 'description' => 'The time when the last statistical operation was performed. The value is in the UNIX timestamp format. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608730999',
+ ],
+ 'Parameters' => [
+ 'title' => 'Parameters',
+ 'description' => 'The KVPs that are related to the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'Key-value pair'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'key',
+ ],
+ ],
+ 'Privileges' => [
+ 'description' => 'The configurations of permissions. This parameter can be left empty.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/PrincipalPrivilegeSet',
+ ],
+ 'Sd' => [
+ 'description' => 'The descriptor of the storage.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/StorageDescriptor',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the metadata table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_table_20201223',
+ ],
+ 'Values' => [
+ 'title' => 'Values',
+ 'description' => 'The values in the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The values in the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'part1',
+ 'extendType' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'PartitionError' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'PartitionError'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorDetail' => [
+ 'description' => 'Error message'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/ErrorDetail',
+ ],
+ 'PartitionValues' => [
+ 'description' => 'The value in a partition key column.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ ],
+ 'PartitionInput' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Partition'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'LastAccessTime' => [
+ 'title' => 'LastAccessTime',
+ 'description' => 'The time when the partition was last accessed. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608730999',
+ 'backendName' => 'LastAccessTime',
+ ],
+ 'LastAnalyzedTime' => [
+ 'title' => 'LastAnalyzedTime',
+ 'description' => 'The time when the statistical operation was last performed. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608730999',
+ 'backendName' => 'LastAnalyzedTime',
+ ],
+ 'Parameters' => [
+ 'title' => 'Parameters',
+ 'description' => 'The KVPs that are related to the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'Key-value pair'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'key',
+ ],
+ 'backendName' => 'Parameters',
+ ],
+ 'Privileges' => [
+ 'description' => 'The configurations of permissions. This parameter can be left empty.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Privileges',
+ '$ref' => '#/components/schemas/PrincipalPrivilegeSet',
+ ],
+ 'Sd' => [
+ 'description' => 'The descriptor of the storage.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Sd',
+ '$ref' => '#/components/schemas/StorageDescriptor',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the metadata table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_table_20201223',
+ 'backendName' => 'TableName',
+ ],
+ 'Values' => [
+ 'title' => 'Values',
+ 'description' => 'The values in the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The values in the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'part1',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'Values',
+ ],
+ 'CreateTime' => [
+ 'title' => 'createTime',
+ 'description' => 'The time when the rule was created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1635147901',
+ 'backendName' => 'CreateTime',
+ ],
+ ],
+ ],
+ 'PartitionProfile' => [
+ 'title' => '',
+ 'description' => 'Partition data profile'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseName' => [
+ 'title' => '',
+ 'description' => 'The library name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_db',
+ 'backendName' => 'databaseName',
+ ],
+ 'TableName' => [
+ 'title' => '',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_tbl',
+ 'backendName' => 'tableName',
+ ],
+ 'PartitionName' => [
+ 'title' => '',
+ 'description' => 'The name of the partition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'year=2023/month=1',
+ 'backendName' => 'partitionName',
+ ],
+ 'ArchiveStatus' => [
+ 'title' => '',
+ 'description' => 'oss storage type'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'STANDARD',
+ 'backendName' => 'archiveStatus',
+ ],
+ 'CreateTime' => [
+ 'title' => '',
+ 'description' => 'The time when the data address was created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-08-16 18:02:22',
+ 'backendName' => 'createTime',
+ ],
+ 'LastModifyTime' => [
+ 'title' => '',
+ 'description' => 'The time when the configurations of the domain name were updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-08-16 18:02:25',
+ 'backendName' => 'lastModifyTime',
+ ],
+ 'LastAccessTime' => [
+ 'title' => '',
+ 'description' => 'last access time (from oss or oss-hdfs audit logs)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-08-22 12:14:42',
+ 'backendName' => 'lastAccessTime',
+ ],
+ 'LastAccessNumTime' => [
+ 'title' => '',
+ 'description' => 'Last Access Time (Discarded)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'lastAccessNumTime',
+ ],
+ 'Location' => [
+ 'title' => '',
+ 'description' => 'The location where the sample is stored.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1',
+ 'backendName' => 'location',
+ ],
+ 'FileSize' => [
+ 'title' => '',
+ 'description' => 'Partition size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '13',
+ 'backendName' => 'fileSize',
+ ],
+ 'ObjectSize' => [
+ 'title' => '',
+ 'description' => 'partition size (from oss or oss-hdfs inventory)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '13',
+ 'backendName' => 'objectSize',
+ ],
+ 'FileCnt' => [
+ 'title' => '',
+ 'description' => 'Number of local files to synchronize'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ 'backendName' => 'fileCnt',
+ ],
+ 'ObjectCnt' => [
+ 'title' => '',
+ 'description' => 'Number of files (from oss or oss-hdfs list)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ 'backendName' => 'objectCnt',
+ ],
+ 'AccessNum' => [
+ 'title' => '',
+ 'description' => 'Visits of the Day (Deprecated)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'accessNum',
+ ],
+ 'AccessNumWeekly' => [
+ 'title' => '',
+ 'description' => 'Visits in Last 7 Days (Deprecated)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'accessNumWeekly',
+ ],
+ 'AccessNumMonthly' => [
+ 'title' => '',
+ 'description' => 'Visits in Last 30 Days (Deprecated)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'accessNumMonthly',
+ ],
+ 'ObjectAccessNum' => [
+ 'title' => '',
+ 'description' => 'Number of file accesses in the last day (from oss-hdfs audit logs)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'objectAccessNum',
+ ],
+ 'ObjectAccessNumWeekly' => [
+ 'title' => '',
+ 'description' => 'Number of file accesses in the last seven days (from oss-hdfs audit logs)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4',
+ 'backendName' => 'objectAccessNumWeekly',
+ ],
+ 'ObjectAccessNumMonthly' => [
+ 'title' => '',
+ 'description' => 'Number of file accesses in the last 30 days (from oss-hdfs audit logs)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4',
+ 'backendName' => 'objectAccessNumMonthly',
+ ],
+ 'DataSourceType' => [
+ 'title' => '',
+ 'description' => 'The type of the source from which storage is collected.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'OSS_HDFS',
+ 'backendName' => 'dataSourceType',
+ ],
+ ],
+ ],
+ 'PartitionSpec' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Partition structure of shared sd'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'SharedSDPartitions' => [
+ 'title' => 'SharedSDPartitions',
+ 'description' => 'Shared partition list, which indicates the common parts of multiple partitions'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Shard'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/Partition',
+ ],
+ 'backendName' => 'SharedSDPartitions',
+ ],
+ 'SharedStorageDescriptor' => [
+ 'title' => 'SharedStorageDescriptor',
+ 'description' => 'Shared SD information, indicating that multiple partitions share the same SD'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cols' => [
+ 'title' => 'Cols',
+ 'description' => 'The column content.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Details of each column'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/FieldSchema',
+ ],
+ 'backendName' => 'Cols',
+ ],
+ 'Location' => [
+ 'title' => 'Location',
+ 'description' => 'The location of the data.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '',
+ 'backendName' => 'Location',
+ ],
+ ],
+ 'backendName' => 'SharedStorageDescriptor',
+ ],
+ ],
+ ],
+ 'PartitionValueList' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'PartitionValueList'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Object of partition value'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Values' => [
+ 'description' => 'Partition value'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ 'extendType' => 'true',
+ ],
+ 'parseType' => 'json',
+ ],
+ 'Principal' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The ARN of the unique identity.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'PrincipalArn' => [
+ 'title' => '',
+ 'description' => 'ram user/ram role principal, in the format of acs:ram::\\[accountId]:user/userName, acs:ram::\\[accountId]:role/roleName'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'acs:ram::[AliyunAccountId]:user/username_abc',
+ 'backendName' => 'PrincipalArn',
+ ],
+ ],
+ ],
+ 'PrincipalPrivilegeSet' => [
+ 'title' => 'PrincipalPrivilegeSet Object',
+ 'description' => 'The set of permissions owned by the principal.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupPrivileges' => [
+ 'description' => 'The permission set of the user group.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/Privileges',
+ ],
+ 'RolePrivileges' => [
+ 'description' => 'The permission set of the role.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/Privileges',
+ ],
+ 'UserPrivileges' => [
+ 'description' => 'The permission set of the user.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/Privileges',
+ ],
+ ],
+ 'parseType' => 'json',
+ ],
+ 'Principals' => [
+ 'title' => '',
+ 'description' => 'Principal list'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Principal'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ 'parseType' => 'struct',
+ ],
+ 'PrivilegeGrantInfo' => [
+ 'title' => 'PrivilegeGrantInfo',
+ 'description' => 'The information about permissions.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => [
+ 'title' => 'createTime',
+ 'description' => 'The time when the instance was created. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1606226844',
+ ],
+ 'GrantOption' => [
+ 'title' => 'grantOption',
+ 'description' => 'Whether to grant the authorization permission.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Grantor' => [
+ 'title' => 'grantor',
+ 'description' => 'The subject of the authorization.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'Grantor',
+ ],
+ 'GrantorType' => [
+ 'title' => 'grantorType',
+ 'description' => 'The type of the authorization principal.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'GrantorType',
+ ],
+ 'Privilege' => [
+ 'title' => 'privilege',
+ 'description' => 'The permission information.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'Privilege',
+ ],
+ ],
+ ],
+ 'PrivilegeResource' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Privilege Resource'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'MetaResource' => [
+ 'title' => 'resource',
+ 'description' => 'Metadata resources.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'MetaResource',
+ '$ref' => '#/components/schemas/MetaResource',
+ ],
+ 'Access' => [
+ 'title' => 'Access type',
+ 'description' => 'Access type'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'Drop',
+ 'backendName' => 'Access',
+ ],
+ ],
+ ],
+ 'PrivilegeResources' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Authentication resource list'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about resource permissions.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/PrivilegeResource',
+ ],
+ 'parseType' => 'struct',
+ 'itemName' => 'PrivilegeResource',
+ ],
+ 'Privileges' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The permission information.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'The permissions.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about permissions.'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/PrivilegeGrantInfo',
+ ],
+ ],
+ 'parseType' => 'json',
+ ],
+ 'ResourceUri' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'ResourceUri'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'title' => 'ResourceType',
+ 'description' => 'resource type, the enumeration includes JAR FILE ARCHIVE'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'JAR',
+ ],
+ 'Uri' => [
+ 'title' => 'Uri',
+ 'description' => 'URI resource address'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'hdfs:///tmp/jar1.jar',
+ ],
+ ],
+ ],
+ 'Role' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Data Lake Metadata Role'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of the role.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'role_name',
+ 'backendName' => 'Name',
+ ],
+ 'Description' => [
+ 'title' => '',
+ 'description' => 'The description of the role.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'role description',
+ 'backendName' => 'Description',
+ ],
+ 'Users' => [
+ 'description' => 'The ram user/ram role principal list, in the format of acs:ram::\\[accountId]:user/userName, acs:ram::\\[accountId]:role/roleName'."\n",
+ 'visibility' => 'public',
+ 'example' => '["acs:ram::111:role/role_name", "acs:ram::111:role/role_name"]',
+ 'backendName' => 'Users',
+ '$ref' => '#/components/schemas/Principals',
+ ],
+ 'DisplayName' => [
+ 'title' => 'DisplayName',
+ 'description' => 'Role display name'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '',
+ 'backendName' => 'DisplayName',
+ ],
+ 'PrincipalArn' => [
+ 'title' => 'PrincipalArn',
+ 'description' => 'The principal ARN of the data lake role, in the format of acs:dlf::\\[accountId]:role/\\[roleName]'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'acs:dlf::111:role/role_name',
+ 'backendName' => 'PrincipalArn',
+ ],
+ 'CreateTime' => [
+ 'title' => 'CreateTime',
+ 'description' => 'The time when the role was created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1647323053',
+ 'backendName' => 'CreateTime',
+ ],
+ 'UpdateTime' => [
+ 'title' => 'UpdateTime',
+ 'description' => 'The time when the role was updated.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1647323053',
+ 'backendName' => 'UpdateTime',
+ ],
+ 'IsPredefined' => [
+ 'title' => 'IsPredefined',
+ 'description' => 'Built-in role'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'backendName' => 'IsPredefined',
+ ],
+ ],
+ ],
+ 'RoleInput' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'role input'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'Data Lake Role Name'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test',
+ 'backendName' => 'Name',
+ ],
+ 'Description' => [
+ 'title' => '',
+ 'description' => 'The description of the role.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '',
+ 'backendName' => 'Description',
+ ],
+ 'DisplayName' => [
+ 'title' => 'DisplayName',
+ 'description' => 'Role Display Name'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '',
+ 'backendName' => 'DisplayName',
+ ],
+ ],
+ ],
+ 'Roles' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'A short description of struct'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The role.'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/Role',
+ ],
+ 'parseType' => 'struct',
+ 'itemName' => 'Role',
+ ],
+ 'SerDeInfo' => [
+ 'title' => 'SerDeInfo Object',
+ 'description' => 'SerDeInfo'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'title' => 'Name',
+ 'description' => 'The name of the data.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'Parameters' => [
+ 'description' => 'The request parameters. Key-value pair form'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/Parameters',
+ ],
+ 'SerializationLib' => [
+ 'title' => 'SerializationLib',
+ 'description' => 'Implementation class of SerDe'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.hive.serde2.OpenCSVSerde',
+ ],
+ ],
+ ],
+ 'SingleIndicatorDTO' => [
+ 'title' => '',
+ 'description' => 'Statistical results of indicators'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DayOnDay' => [
+ 'title' => '',
+ 'description' => 'Compare (Day to Day)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'backendName' => 'DayOnDay',
+ ],
+ 'MonthOnMonth' => [
+ 'title' => '',
+ 'description' => 'Compare (Month to Month)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'backendName' => 'MonthOnMonth',
+ ],
+ 'DayIncrement' => [
+ 'title' => '',
+ 'description' => 'Daily Add'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'DayIncrement',
+ ],
+ 'MonthIncrement' => [
+ 'title' => '',
+ 'description' => 'Month Added'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'MonthIncrement',
+ ],
+ 'Total' => [
+ 'title' => '',
+ 'description' => 'Total storage capacity'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Total',
+ ],
+ ],
+ ],
+ 'SkewedInfo' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'SkewedInfo'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'SkewedColNames' => [
+ 'title' => 'SkewedColNames',
+ 'description' => 'List of fields that contain skewed values'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The names of the skewed fields.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'col1',
+ 'extendType' => 'true',
+ ],
+ ],
+ 'SkewedColValueLocationMaps' => [
+ 'title' => 'SkewedColValueLocationMaps',
+ 'description' => 'Mapping Map of skew values and fields'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'Mapping Map of skew values and fields'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '{“col1”:"val1"}',
+ ],
+ ],
+ 'SkewedColValues' => [
+ 'title' => 'SkewedColValueLocationMaps',
+ 'description' => 'Tilt Value List'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The values of the skewed fields.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The values of the skewed fields.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '"123"',
+ 'extendType' => 'true',
+ ],
+ 'extendType' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'SmallFileCntRank' => [
+ 'title' => '',
+ 'description' => 'Small File Quantity Ranking'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'title' => '',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'delta_partition_1',
+ 'backendName' => 'TableName',
+ ],
+ 'Quantity' => [
+ 'title' => '',
+ 'description' => 'Number of small documents'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '52250',
+ 'backendName' => 'Quantity',
+ ],
+ 'DbName' => [
+ 'title' => '',
+ 'description' => 'The library name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'qingwei_repo',
+ 'backendName' => 'DbName',
+ ],
+ 'Location' => [
+ 'title' => '',
+ 'description' => 'Table storage location'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'oss://qingwei-hz/repo/delta_partition_1',
+ 'backendName' => 'Location',
+ ],
+ ],
+ ],
+ 'SortCriterion' => [
+ 'title' => '',
+ 'description' => 'Search sort structure'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldName' => [
+ 'title' => '',
+ 'description' => 'The column name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'name',
+ 'backendName' => 'FieldName',
+ ],
+ 'Sort' => [
+ 'title' => '',
+ 'description' => 'The order in which you want to sort the queried instances. Default value desc'."\n"
+ ."\n"
+ .'Type: asc: ascending order. desc: reverse order'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'asc/desc',
+ 'backendName' => 'Sort',
+ ],
+ ],
+ ],
+ 'StorageCollectTaskOperationResult' => [
+ 'title' => '',
+ 'description' => 'Modifies the result of a collection task.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'title' => '',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'success',
+ ],
+ 'TaskId' => [
+ 'title' => '',
+ 'description' => 'The task ID.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'taskId',
+ ],
+ 'TaskType' => [
+ 'title' => '',
+ 'description' => 'The job type.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'taskType',
+ ],
+ 'DlfCreated' => [
+ 'title' => '',
+ 'description' => 'Whether the DLF is automatically created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'backendName' => 'dlfCreated',
+ ],
+ 'ErrCode' => [
+ 'title' => '',
+ 'description' => 'The error code returned if the call failed.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'errCode',
+ ],
+ 'ErrMessage' => [
+ 'title' => '',
+ 'description' => 'The error message.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'errMessage',
+ ],
+ ],
+ ],
+ 'StorageDescriptor' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'StorageDescriptor'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'BucketCols' => [
+ 'description' => 'The array of bucket fields.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'Cols' => [
+ 'title' => 'Cols',
+ 'description' => 'All the fields in a table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The definitions of table fields.'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/FieldSchema',
+ ],
+ ],
+ 'Compressed' => [
+ 'title' => 'Compressed',
+ 'description' => 'Specifies whether to enable compression.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'InputFormat' => [
+ 'title' => 'InputFormat',
+ 'description' => 'The input format. For more information, see the API description of CreateTable.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat',
+ ],
+ 'Location' => [
+ 'title' => 'Location',
+ 'description' => 'The physical location of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'file:///tmp/table',
+ ],
+ 'NumBuckets' => [
+ 'title' => 'NumBuckets',
+ 'description' => 'The number of buckets to be split. This field is required if BucketCols is set.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'OutputFormat' => [
+ 'title' => 'OutputFormat',
+ 'description' => 'The output format. For more information, see the API description of CreateTable.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat',
+ ],
+ 'Parameters' => [
+ 'title' => 'Parameters',
+ 'description' => 'The mapping array of KVPs.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'Key-value pair'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'key',
+ ],
+ ],
+ 'SerDeInfo' => [
+ 'description' => 'The information about serialization and deserialization.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/SerDeInfo',
+ ],
+ 'SkewedInfo' => [
+ 'description' => 'The duplicate values or skewed values in a field.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/SkewedInfo',
+ ],
+ 'SortCols' => [
+ 'title' => 'SortCols',
+ 'description' => 'The sort fields.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The field based on which the categories are sorted.'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/Order',
+ ],
+ ],
+ 'StoredAsSubDirectories' => [
+ 'title' => 'StoredAsSubDirectories',
+ 'description' => 'Specifies whether table data is stored in a subdirectory.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'StorageFormat' => [
+ 'title' => '',
+ 'description' => 'Storage format distribution information'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Parquet' => [
+ 'title' => 'Parquet',
+ 'description' => 'Number of Parquet format files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Parquet',
+ ],
+ 'Orc' => [
+ 'title' => 'Orc',
+ 'description' => 'Number of Orc format files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Orc',
+ ],
+ 'Delta' => [
+ 'title' => 'Delta',
+ 'description' => 'Number of Delta format files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Delta',
+ ],
+ 'Csv' => [
+ 'title' => 'Csv',
+ 'description' => 'Number of files in Csv format'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Csv',
+ ],
+ 'Iceberg' => [
+ 'title' => 'Iceberg',
+ 'description' => 'Number of Iceberg format files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Iceberg',
+ ],
+ 'Uncategorized' => [
+ 'title' => 'Uncategorized',
+ 'description' => 'Format Unclassified File Quantity'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Uncategorized',
+ ],
+ 'Json' => [
+ 'title' => 'Json',
+ 'description' => 'Number of JSON format files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Json',
+ ],
+ 'Avro' => [
+ 'title' => 'Avro',
+ 'description' => 'Number of Avro format files'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Avro',
+ ],
+ 'Hudi' => [
+ 'title' => 'Hudi',
+ 'description' => 'Number of files in Hudi format'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'Hudi',
+ ],
+ ],
+ ],
+ 'StorageLayer' => [
+ 'title' => '',
+ 'description' => 'Storage Tiering Distribution Information'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Archive' => [
+ 'title' => '',
+ 'description' => 'Archive File Size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'Archive',
+ ],
+ 'ColdArchive' => [
+ 'title' => '',
+ 'description' => 'Size of a Cold Archive file'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'ColdArchive',
+ ],
+ 'Standard' => [
+ 'title' => '',
+ 'description' => 'Standard file size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'Standard',
+ ],
+ 'Infrequent' => [
+ 'title' => '',
+ 'description' => 'Low-frequency file size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1,099,511',
+ 'backendName' => 'Infrequent',
+ ],
+ 'Unknown' => [
+ 'title' => '',
+ 'description' => 'The file status.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'Unknown',
+ ],
+ ],
+ ],
+ 'StorageRankDTO' => [
+ 'title' => '',
+ 'description' => 'Storage ranking'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'dbStorageRank' => [
+ 'title' => '',
+ 'description' => 'Library storage ranking list'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Library storage ranking'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DbStorageRank',
+ ],
+ 'required' => false,
+ 'backendName' => 'dbStorageRank',
+ ],
+ 'tableStorageRank' => [
+ 'title' => '',
+ 'description' => 'Table storage ranking list'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Table Storage Ranking'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/TableStorageRank',
+ ],
+ 'backendName' => 'tableStorageRank',
+ ],
+ 'smallFileCntRank' => [
+ 'title' => '',
+ 'description' => 'Small file quantity ranking list'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Small File Quantity Ranking'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/SmallFileCntRank',
+ ],
+ 'backendName' => 'smallFileCntRank',
+ ],
+ ],
+ 'required' => false,
+ 'parseType' => 'struct',
+ ],
+ 'Table' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Table'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cascade' => [
+ 'title' => 'Cascade',
+ 'description' => 'Specifies whether to perform cascade deletion.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ 'backendName' => 'Cascade',
+ ],
+ 'CreateTime' => [
+ 'title' => 'CreateTime',
+ 'description' => 'The creation time, in seconds, of a Unix timestamp.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'CreateTime',
+ ],
+ 'CreatedBy' => [
+ 'title' => 'CreatedBy',
+ 'description' => 'The name of the user who created the version.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'CreatedBy',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'LastAccessTime' => [
+ 'title' => 'LastAccessTime',
+ 'description' => 'The timestamp of the last access to this table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'LastAccessTime',
+ ],
+ 'LastAnalyzedTime' => [
+ 'title' => 'LastAnalyzedTime',
+ 'description' => 'The time when the last statistical operation was performed on columns. The value is in the UNIX timestamp format. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'LastAnalyzedTime',
+ ],
+ 'Owner' => [
+ 'title' => 'Owner',
+ 'description' => 'The name of the owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'Owner',
+ ],
+ 'OwnerType' => [
+ 'title' => 'OwnerType',
+ 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'OwnerType',
+ ],
+ 'Parameters' => [
+ 'description' => 'The KVPs that define the attributes related to the table.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Parameters',
+ '$ref' => '#/components/schemas/Parameters',
+ ],
+ 'PartitionKeys' => [
+ 'description' => 'List of partition table'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'PartitionKeys',
+ '$ref' => '#/components/schemas/ListFieldSchema',
+ ],
+ 'Privileges' => [
+ 'description' => 'Permission Settings'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Privileges',
+ '$ref' => '#/components/schemas/PrincipalPrivilegeSet',
+ ],
+ 'Retention' => [
+ 'title' => 'Retention',
+ 'description' => 'The retention time of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30000',
+ 'backendName' => 'Retention',
+ ],
+ 'RewriteEnabled' => [
+ 'title' => 'RewriteEnabled',
+ 'description' => 'Whether the view can be used by overridden queries'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'RewriteEnabled',
+ ],
+ 'Sd' => [
+ 'description' => 'The descriptor of the storage, which contains physical storage information about this table.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Sd',
+ '$ref' => '#/components/schemas/StorageDescriptor',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'table_name',
+ 'backendName' => 'TableName',
+ ],
+ 'TableType' => [
+ 'title' => 'TableType',
+ 'description' => 'The type of the metadata table. Example: MANAGED_TABLE,EXTERNAL_TABLE,VIRTUAL_VIEW,INDEX_TABLE,MATERIALIZED_VIEW.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'MANAGED_TABLE',
+ 'backendName' => 'TableType',
+ ],
+ 'Temporary' => [
+ 'title' => 'Temporary',
+ 'description' => 'Specifies whether the table is a temporary table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ 'backendName' => 'Temporary',
+ ],
+ 'UpdateTime' => [
+ 'title' => 'UpdateTime',
+ 'description' => 'The time when the timestamp was updated. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'UpdateTime',
+ ],
+ 'ViewExpandedText' => [
+ 'title' => 'ViewExpandedText',
+ 'description' => 'The expanded text of the view.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '\'\'',
+ 'backendName' => 'ViewExpandedText',
+ ],
+ 'ViewOriginalText' => [
+ 'title' => 'ViewOriginalText',
+ 'description' => 'The original text of the view.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '\'\'',
+ 'backendName' => 'ViewOriginalText',
+ ],
+ 'TableId' => [
+ 'title' => 'TableId',
+ 'description' => 'TableId'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '59c6c8fefeaa46d8b599c1f790c59a19',
+ 'backendName' => 'TableId',
+ ],
+ 'TableVersion' => [
+ 'title' => 'TableVersion',
+ 'description' => 'TableVersion'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'TableVersion',
+ '$ref' => '#/components/schemas/TableVersion',
+ ],
+ ],
+ ],
+ 'TableError' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'TableError'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorDetail' => [
+ 'description' => 'The information about the error.'."\n",
+ 'visibility' => 'public',
+ '$ref' => '#/components/schemas/ErrorDetail',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the table in which the error occurs.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'TableInput' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Table'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cascade' => [
+ 'title' => 'Cascade',
+ 'description' => 'Specifies whether to perform cascade deletion.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ 'backendName' => 'Cascade',
+ ],
+ 'CreatedBy' => [
+ 'title' => 'CreatedBy',
+ 'description' => 'The name of the user who created the version.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'CreatedBy',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'LastAccessTime' => [
+ 'title' => 'LastAccessTime',
+ 'description' => 'The timestamp of the last access to this table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'LastAccessTime',
+ ],
+ 'LastAnalyzedTime' => [
+ 'title' => 'LastAnalyzedTime',
+ 'description' => 'The time when the last statistical operation was performed on columns. The value is in the UNIX timestamp format. Unit: seconds.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'LastAnalyzedTime',
+ ],
+ 'Owner' => [
+ 'title' => 'Owner',
+ 'description' => 'The name of the owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'Owner',
+ ],
+ 'OwnerType' => [
+ 'title' => 'OwnerType',
+ 'description' => 'The type of the owner. You can set this field to USER, ROLE, or GROUP.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'OwnerType',
+ ],
+ 'Parameters' => [
+ 'description' => 'The KVPs that define the attributes related to the table.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Parameters',
+ '$ref' => '#/components/schemas/Parameters',
+ ],
+ 'PartitionKeys' => [
+ 'description' => 'List of partition table. Only the partition keys of the basic types are supported. If no partitionKeys is specified, you need to set the value of partitionKeys to an empty list.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'PartitionKeys',
+ '$ref' => '#/components/schemas/ListFieldSchema',
+ ],
+ 'Privileges' => [
+ 'description' => 'The configurations of permissions. This parameter can be left empty.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Privileges',
+ '$ref' => '#/components/schemas/PrincipalPrivilegeSet',
+ ],
+ 'Retention' => [
+ 'title' => 'Retention',
+ 'description' => 'The retention time of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30000',
+ 'backendName' => 'Retention',
+ ],
+ 'RewriteEnabled' => [
+ 'title' => 'RewriteEnabled',
+ 'description' => 'Whether the view can be used by overridden queries'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'RewriteEnabled',
+ ],
+ 'Sd' => [
+ 'description' => 'The descriptor of the storage, which contains physical storage information about this table.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Sd',
+ '$ref' => '#/components/schemas/StorageDescriptor',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'table_name',
+ 'backendName' => 'TableName',
+ ],
+ 'TableType' => [
+ 'title' => 'TableType',
+ 'description' => 'The type of the metadata table. Example: MANAGED_TABLE,EXTERNAL_TABLE,VIRTUAL_VIEW,INDEX_TABLE,MATERIALIZED_VIEW.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'MANAGED_TABLE',
+ 'backendName' => 'TableType',
+ ],
+ 'Temporary' => [
+ 'title' => 'Temporary',
+ 'description' => 'Specifies whether the table is a temporary table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ 'backendName' => 'Temporary',
+ ],
+ 'ViewExpandedText' => [
+ 'title' => 'ViewExpandedText',
+ 'description' => 'The expanded text of the view.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '\'\'',
+ 'backendName' => 'ViewExpandedText',
+ ],
+ 'ViewOriginalText' => [
+ 'title' => 'ViewOriginalText',
+ 'description' => 'The original text of the view.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '\'\'',
+ 'backendName' => 'ViewOriginalText',
+ ],
+ 'CreateTime' => [
+ 'title' => 'CreateTime',
+ 'description' => 'The time when the rule was created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1645437703000',
+ 'backendName' => 'CreateTime',
+ ],
+ ],
+ ],
+ 'TableProfile' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Table Data Overview'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'PartitionCnt' => [
+ 'title' => '',
+ 'description' => 'Number of Partitions'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ 'backendName' => 'partitionCnt',
+ ],
+ 'FileCnt' => [
+ 'title' => '',
+ 'description' => 'Number of local files to synchronize'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ 'backendName' => 'fileCnt',
+ ],
+ 'ObjectCnt' => [
+ 'title' => '',
+ 'description' => 'Number of files (from oss or oss-hdfs list)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '5',
+ 'backendName' => 'objectCnt',
+ ],
+ 'FileSize' => [
+ 'title' => '',
+ 'description' => 'File-related parameters'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '192841',
+ 'backendName' => 'fileSize',
+ ],
+ 'ObjectSize' => [
+ 'title' => '',
+ 'description' => 'file size (from oss or oss-hdfs manifest)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '31',
+ 'backendName' => 'objectSize',
+ ],
+ 'RecordCnt' => [
+ 'title' => '',
+ 'description' => 'Records'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ 'backendName' => 'recordCnt',
+ ],
+ 'IsPartitioned' => [
+ 'title' => '',
+ 'description' => 'Whether partition table'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'isPartitioned',
+ ],
+ 'LastModifyTime' => [
+ 'title' => '',
+ 'description' => 'The time when the configurations of the domain name were updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-02-01 19:33:00',
+ 'backendName' => 'lastModifiedTime',
+ ],
+ 'LastAccessTime' => [
+ 'title' => '',
+ 'description' => 'Lifecycle rules based on the last access time'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-02-02 19:00:00',
+ 'backendName' => 'lastAccessTime',
+ ],
+ 'DatabaseName' => [
+ 'title' => '',
+ 'description' => 'The library name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '530_db',
+ 'backendName' => 'databaseName',
+ ],
+ 'TableName' => [
+ 'title' => '',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_table_20201223',
+ 'backendName' => 'tableName',
+ ],
+ 'CreateTime' => [
+ 'title' => '',
+ 'description' => 'The time when the data address was created.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-02-01 19:29:12',
+ 'backendName' => 'createTime',
+ ],
+ 'Location' => [
+ 'title' => '',
+ 'description' => 'The location where the sample is stored.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'oss://opg211-prod-ds-lake/datalake/tvapp_push_content/_delta_log/00000000000000000005.json',
+ 'backendName' => 'location',
+ ],
+ 'AccessNum' => [
+ 'title' => '',
+ 'description' => 'Visits of the Day (Deprecated)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ 'backendName' => 'accessNum',
+ ],
+ 'AccessNumWeekly' => [
+ 'title' => '',
+ 'description' => 'Visits per week (obsolete)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '5',
+ 'backendName' => 'accessNumWeekly',
+ ],
+ 'AccessNumMonthly' => [
+ 'title' => '',
+ 'description' => 'Number of visits in the current month (obsolete)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ 'backendName' => 'accessNumMonthly',
+ ],
+ 'LastAccessNumTime' => [
+ 'title' => '',
+ 'description' => 'Last Access Time (Discarded)'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'lastAccessNumTime',
+ ],
+ 'LatestDate' => [
+ 'title' => '',
+ 'description' => 'The time when the metadata warehouse was updated.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-03-13',
+ 'backendName' => 'latestDate',
+ ],
+ 'LatestAccessNumDate' => [
+ 'title' => '',
+ 'description' => 'The time when the access frequency is updated. This parameter is obsolete.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'latestAccessNumDate',
+ ],
+ 'LastDdlTime' => [
+ 'title' => '',
+ 'description' => 'Last DDL update time'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '2023-08-16 18:02:24',
+ 'backendName' => 'lastDdlTime',
+ ],
+ 'ObjectAccessNum' => [
+ 'title' => '',
+ 'description' => 'Number of file accesses in the last day (from oss-hdfs audit logs)'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ 'backendName' => 'objectAccessNum',
+ ],
+ 'ObjectAccessNumWeekly' => [
+ 'title' => '',
+ 'description' => 'Number of file accesses in the last seven days (from oss-hdfs audit logs)'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '18',
+ 'backendName' => 'objectAccessNumWeekly',
+ ],
+ 'ObjectAccessNumMonthly' => [
+ 'title' => '',
+ 'description' => 'Number of file accesses in the last 30 days (from oss-hdfs audit logs)'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '18',
+ 'backendName' => 'objectAccessNumMonthly',
+ ],
+ 'DataSourceType' => [
+ 'title' => '',
+ 'description' => 'The type of the source from which storage is collected.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'OSS_HDFS',
+ 'backendName' => 'dataSourceType',
+ ],
+ ],
+ ],
+ 'TableResource' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Authentication resource structure-Table'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseName' => [
+ 'title' => 'database name',
+ 'description' => 'The database name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'TableName' => [
+ 'title' => 'tablename',
+ 'description' => 'The name of the queried table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'test_parquet',
+ 'backendName' => 'TableName',
+ ],
+ ],
+ ],
+ 'TableStorageRank' => [
+ 'title' => '',
+ 'description' => 'Table Storage Ranking'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'title' => '',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'store_sales',
+ 'backendName' => 'TableName',
+ ],
+ 'Quantity' => [
+ 'title' => '',
+ 'description' => 'Size'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4277873188582',
+ 'backendName' => 'Quantity',
+ ],
+ 'DbName' => [
+ 'title' => '',
+ 'description' => 'The library name.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'tpcds_text_parquet_10000',
+ 'backendName' => 'DbName',
+ ],
+ ],
+ ],
+ 'TableVersion' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The schema of a table version.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Table' => [
+ 'description' => 'The details about the metadata table.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Table',
+ '$ref' => '#/components/schemas/Table',
+ ],
+ 'VersionId' => [
+ 'title' => 'table version',
+ 'description' => 'The version number.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ 'backendName' => 'VersionId',
+ ],
+ ],
+ ],
+ 'TaskStatus' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'status and message'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'title' => 'status of the task',
+ 'description' => 'The state of the task.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'KILLED',
+ 'backendName' => 'Status',
+ ],
+ 'Message' => [
+ 'title' => 'message of the task',
+ 'description' => 'Task status messages.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'successful',
+ 'backendName' => 'Message',
+ ],
+ ],
+ ],
+ 'UpdateTablePartitionColumnStatisticsRequest' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'UpdateTableColumnStatistics'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '1344371',
+ 'backendName' => 'CatalogId',
+ ],
+ 'ColumnStatisticsList' => [
+ 'title' => 'ColumnStatisticsList',
+ 'description' => 'The list of field statistics.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The statistics on the field.'."\n",
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/ColumnStatistics',
+ ],
+ 'backendName' => 'ColumnStatisticsList',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'database_test',
+ 'backendName' => 'DatabaseName',
+ ],
+ 'Engine' => [
+ 'title' => 'Engine',
+ 'description' => 'Engine'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ 'backendName' => 'Engine',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the metadata table.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'tabletest',
+ 'backendName' => 'TableName',
+ ],
+ 'ValidWriteIdList' => [
+ 'title' => 'ValidWriteIdList, optional',
+ 'description' => 'This parameter is not supported and can be left empty.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'ValidWriteIdList',
+ ],
+ 'WriteId' => [
+ 'title' => 'WriteId, optional',
+ 'description' => 'This parameter is not supported and can be left empty.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'WriteId',
+ ],
+ 'IsStatsCompliant' => [
+ 'title' => 'IsStatsCompliant',
+ 'description' => 'IsStatsCompliant'."\n",
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'backendName' => 'IsStatsCompliant',
+ ],
+ ],
+ ],
+ 'UserRole' => [
+ 'description' => 'Data Lake Metadata Role'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => [
+ 'title' => '',
+ 'description' => 'The role.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'Role',
+ '$ref' => '#/components/schemas/Role',
+ ],
+ 'GrantTime' => [
+ 'title' => '',
+ 'description' => 'The grant time.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => 'DatabaseWildcard',
+ 'backendName' => 'GrantTime',
+ ],
+ 'User' => [
+ 'title' => '',
+ 'description' => 'The identity of the user.'."\n",
+ 'visibility' => 'public',
+ 'backendName' => 'User',
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ ],
+ 'parseType' => 'struct',
+ ],
+ 'UserRoles' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The list of metadata roles and user relationships in the data lake.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the user role.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/UserRole',
+ ],
+ 'parseType' => 'struct',
+ 'itemName' => 'UserRoles',
+ ],
+ 'Workflow' => [
+ 'title' => '',
+ 'description' => 'The workflow.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'LatestInstanceId' => [
+ 'title' => '',
+ 'description' => 'The ID of the instance.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'latestInstanceId',
+ ],
+ 'LatestInstanceStatus' => [
+ 'title' => '',
+ 'description' => 'The status of the last running instance.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'latestInstanceStatus',
+ ],
+ 'LatestStartTime' => [
+ 'title' => '',
+ 'description' => 'The start time of the last run.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'latestStartTime',
+ ],
+ 'LatestEndTime' => [
+ 'title' => '',
+ 'description' => 'The end time of the most recent run.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'latestEndTime',
+ ],
+ ],
+ 'parseType' => 'struct',
+ ],
+ 'WorkflowInstance' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'The workflow running instance.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'DlfWorkflowId' => [
+ 'title' => '',
+ 'description' => 'The workflow ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'dlfWorkflowId',
+ ],
+ 'ExternalInstanceId' => [
+ 'title' => '',
+ 'description' => 'The ID of the workflow instance.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'externalInstanceId',
+ ],
+ 'StartTime' => [
+ 'title' => '',
+ 'description' => 'The beginning of the date range within which data is queried.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'startTime',
+ ],
+ 'EndTime' => [
+ 'title' => '',
+ 'description' => 'The time when the DAG finished running.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'endTime',
+ ],
+ 'Status' => [
+ 'title' => '',
+ 'description' => 'The execution state of the query. Valid values:'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'status',
+ ],
+ 'RuntimeLogs' => [
+ 'title' => '',
+ 'description' => 'Run logs.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The log information.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/LogInfo',
+ ],
+ 'backendName' => 'runtimeLogs',
+ ],
+ 'BatchProgress' => [
+ 'title' => '',
+ 'description' => 'The progress of the de-identification task.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'backendName' => 'batchProgress',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'CreateCatalog' => [
+ 'summary' => 'Create a Data Catalog for Data Lake.',
+ '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' => 'Body',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogInput' => [
+ 'description' => 'The structure that is used to create or update the catalog.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/CatalogInput',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The status code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Response Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'BA84F8D4-5160-5544-BE76-3A306CD3A7B0',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"BA84F8D4-5160-5544-BE76-3A306CD3A7B0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateCatalog',
+ ],
+ 'DeleteCatalog' => [
+ 'summary' => 'Deletes a data directory.',
+ 'path' => '/api/metastore/catalogs',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'catalog_test',
+ ],
+ ],
+ [
+ 'name' => 'IsAsync',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否异步，默认同步',
+ 'description' => 'Whether asynchronous, synchronous by default.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Response Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Request is success or not',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskId' => [
+ 'title' => '异步删除Catalog的taskId',
+ 'description' => 'The ID of the task for asynchronously deleting a catalog.'."\n",
+ 'type' => 'string',
+ 'example' => 'c38206c3aca0c41332ffe49294243009',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteCatalog',
+ ],
+ 'UpdateCatalog' => [
+ 'summary' => 'Updates the contents of the Data Catalog.',
+ 'path' => '/api/metastore/catalogs',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogInput' => [
+ 'description' => 'The structure that is used to create or update the catalog.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/CatalogInput',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response encoding.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Response Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '64E46067-49EA-5A91-A7B1-E812E18FC243',
+ ],
+ 'Success' => [
+ 'title' => 'Request is success or not',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"64E46067-49EA-5A91-A7B1-E812E18FC243\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateCatalog',
+ ],
+ 'ListCatalogs' => [
+ 'summary' => 'You can call this operation to query the list of metabase namespaces (catalogs).',
+ 'path' => '/api/metastore/catalogs/list',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'catalogId',
+ 'description' => 'Regular matching of CatalogId'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'namePattern',
+ 'description' => 'The page turning token, which is returned from the returned result. If none is returned, an empty string or\'\''."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '‘’',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'pageSize',
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000000',
+ 'minimum' => '-2',
+ 'example' => '10',
+ 'default' => '1000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Catalog Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Catalogs' => [
+ 'title' => 'Catalogs',
+ 'description' => 'The catalogs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The catalog details.'."\n",
+ '$ref' => '#/components/schemas/Catalog',
+ ],
+ 'example' => '[{"CatalogId":"xx"}]',
+ ],
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Status Code Description'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'Page Flip token'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the test feature is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Catalogs\\": [\\n {\\n \\"CatalogId\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"CreatedBy\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CatalogType\\": \\"\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListCatalogs',
+ 'requestParamsDescription' => '* IdPattern: the name of the catalog to be queried. \\*\\*.\\*\\*\\* matching is supported. indicates that one character is matched, and \\* indicates that n characters are matched.'."\n"
+ .'* NextPageToken: the start position of the page. You can enter an empty string for the first time, and then enter the NextPageToken returned in the previous response. If the returned NextPageToken is an empty string, no data is found.'."\n"
+ .'* pagesize: the number of entries returned at a time.'."\n",
+ 'responseParamsDescription' => 'Code error codes\\'."\n"
+ .'InternalError: other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'GetCatalog' => [
+ 'summary' => 'Obtains the details of a data directory.',
+ 'path' => '/api/metastore/catalogs',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'catalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'catalog_test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Databases Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Catalog' => [
+ 'description' => 'The catalog details.'."\n",
+ 'example' => '',
+ '$ref' => '#/components/schemas/Catalog',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85\\",\\n \\"Success\\": true,\\n \\"Catalog\\": {\\n \\"CatalogId\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"CreatedBy\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CatalogType\\": \\"\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetCatalog',
+ ],
+ 'CreateDatabase' => [
+ 'summary' => 'Create a metadabase in the data lake metadata.',
+ 'path' => '/api/metastore/catalogs/databases',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseInput' => [
+ 'description' => 'The database details.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/DatabaseInput',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Response Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'CreateDatabase',
+ 'responseParamsDescription' => 'Code error codes\\'."\n"
+ .'InvalidObject:name/partition/column/skewCol verification fails\\'."\n"
+ .'AlreadyExists: The corresponding metadase already exists.\\'."\n"
+ .'InternalError: other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'DeleteDatabase' => [
+ 'summary' => 'Deletes a database in the data lake by name.',
+ 'path' => '/api/metastore/catalogs/databases',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'Name',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'Cascade',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'Cascade',
+ 'description' => 'Whether to cascade delete data. Valid values:'."\n"
+ ."\n"
+ .'* true: deletes a table from the database.'."\n"
+ .'* false: does not delete tables from the database. If a table still exists in the database, the deletion fails.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Async',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Whether to asynchronously execute.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The description of the distribution status.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Response Message',
+ 'description' => 'A related error message is displayed.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '73201200-4C1A-4FEF-BD6B-C0DA7994FFA2',
+ ],
+ 'Success' => [
+ 'title' => 'Request is success or not',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskId' => [
+ 'description' => 'The ID of the task that is used to asynchronously delete a database.'."\n",
+ 'type' => 'string',
+ 'example' => 'c38206c3aca0c41332ffe49294243009',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Response Object',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"73201200-4C1A-4FEF-BD6B-C0DA7994FFA2\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteDatabase',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database does not exist.'."\n"
+ .'* InvalidOperation: The table or function still exists in the database and cannot be deleted.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'UpdateDatabase' => [
+ 'summary' => 'Update the details of a database in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseInput' => [
+ 'description' => 'The information about the updated database.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/DatabaseInput',
+ ],
+ 'Name' => [
+ 'title' => 'Name',
+ 'description' => 'The name of the database before the update. If the database name remains the same after the update, only other information in the DatabaseInput parameter is updated.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The description of the distribution status.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Response Message',
+ 'description' => 'A related error message is displayed.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '161F5EFC-E97E-43C0-AACF-FF18FAC912F0',
+ ],
+ 'Success' => [
+ 'title' => 'Request is success or not',
+ 'description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"161F5EFC-E97E-43C0-AACF-FF18FAC912F0\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateDatabase',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* AlreadyExists: The new database name already exists.'."\n"
+ .'* NoSuchObject: The specified database does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'GetDatabase' => [
+ 'summary' => 'Obtains the details of a database in a data lake.',
+ 'path' => '/api/metastore/catalogs/databases',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'The name of the database to query.',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Database' => [
+ 'description' => 'The database object.'."\n",
+ 'example' => '{"name":"test"}',
+ '$ref' => '#/components/schemas/Database',
+ ],
+ 'Message' => [
+ 'title' => 'Response Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'D659761F-29C3-409D-805A-0CF33A320128',
+ ],
+ 'Success' => [
+ 'title' => 'API is success or not',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Database\\": {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"D659761F-29C3-409D-805A-0CF33A320128\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'GetDatabase',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListDatabases' => [
+ 'summary' => 'Obtains a list of databases in the data lake and queries them by page. You can match them based on the database name.',
+ 'path' => '/api/metastore/catalogs/databases/list',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'catalogId',
+ 'description' => 'The namespace of the database category. By default, the Uid of the primary account is entered.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'NamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'namePattern',
+ 'description' => 'The regular expression used to match the database name. If all matches are specified, this parameter is specified. \\*'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'namePattern',
+ 'description' => 'The paging token, which is returned by the result. For example, you can specify "" for the first page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa!',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'pageSize',
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000000',
+ 'minimum' => '-2',
+ 'example' => '10',
+ 'default' => '1000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Databases Response',
+ 'description' => 'The returned data body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Description'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Databases' => [
+ 'title' => 'Database List',
+ 'description' => 'The list of databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The database query results.'."\n",
+ '$ref' => '#/components/schemas/Database',
+ ],
+ 'example' => '[{"name":"test"}]',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'Page Flip token'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the test feature is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'Response Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Databases\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListDatabases',
+ 'requestParamsDescription' => '* NamePattern: the name of the database to be queried. \\*\\*.\\*\\*\\* matching is supported. indicates that one character is matched, and \\* indicates that n characters are matched.'."\n"
+ .'* NextPageToken: the start position of the page. You can enter an empty string for the first time, and then enter the NextPageToken returned in the previous response. If the returned NextPageToken is an empty string, no data is found.'."\n"
+ .'* pagesize: the number of entries returned at a time.'."\n",
+ 'responseParamsDescription' => 'Code error codes\\'."\n"
+ .'InternalError: other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'CreateTable' => [
+ 'summary' => 'Add a data table for the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'TableInput' => [
+ 'description' => 'The details about the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/TableInput',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'CreateTable',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidObject:name/partition/column/skewCol does not pass the verification.'."\n"
+ .'* AlreadyExists: The specified table already exists.'."\n"
+ .'* NoSuchObject: The specified database does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'DeleteTable' => [
+ 'summary' => 'Deletes a data table in a data lake by name.',
+ 'path' => '/api/metastore/catalogs/databases/tables',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteTable',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified data table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'DeleteTableColumnStatistics' => [
+ 'summary' => 'Recycle field statistics for data tables in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ [
+ 'name' => 'ColumnNames',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of column names.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteTableColumnStatistics',
+ 'responseParamsDescription' => '* code: the error code.'."\n"
+ .'* message: the error message.'."\n"
+ .'* requestId: the unique ID of the current request.'."\n"
+ .'* Success:true/false to determine whether the request is successful.'."\n",
+ ],
+ 'DeleteTableVersion' => [
+ 'summary' => 'Deletes a specified version of a data table in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/versions',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ ],
+ [
+ 'name' => 'VersionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'table version id',
+ 'description' => 'The version number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteTableVersion',
+ ],
+ 'UpdateTable' => [
+ 'summary' => 'Update the data table information in the data lake based on the name.',
+ 'path' => '/api/metastore/catalogs/databases/tables',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'SkipArchive' => [
+ 'title' => 'SkipArchive',
+ 'description' => 'By default, if a data table is updated, a backup version of the data table is created. However, if you set the skipArchive parameter to true, no backup version is created.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ 'TableInput' => [
+ 'description' => 'The details about the updated data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/TableInput',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ 'IsAsync' => [
+ 'title' => 'IsAsync',
+ 'description' => 'Specifies whether to synchronously update the data table.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'AllowPartitionKeyChange' => [
+ 'title' => 'AllowPartitionKeyChange',
+ 'description' => 'Specifies whether the partition key can be updated.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskId' => [
+ 'title' => 'Async task Id',
+ 'description' => 'The ID of the asynchronous task.'."\n",
+ 'type' => 'string',
+ 'example' => 'aa689782deb97265701f57324fc4ae42',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"aa689782deb97265701f57324fc4ae42\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateTable',
+ 'requestParamsDescription' => 'IsAsync:'."\n"
+ ."\n"
+ .'* true: The API operation is called asynchronously and does not wait for the background task to be returned. The response contains a taskid. In this way, the client can query the status of the task by using the taskid.'."\n"
+ .'* false: indicates a synchronous call. The interface returns results only when the background task is completed. Then the risk of false is that if the background task needs to be done very long, the interface will time out.'."\n",
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidOperation: The database or table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n"
+ .'* taskid: because the updatetable also updates all partitions information of the table. if the task is submitted asynchronously, a taskid is returned to track the execution status of the asynchronous task. If the data is submitted synchronously, this value is meaningless.'."\n",
+ ],
+ 'UpdateTableColumnStatistics' => [
+ 'summary' => 'Creates or updates field statistics for a data table.',
+ 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics',
+ 'methods' => [
+ 'put',
+ ],
+ '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 request to update statistics.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/UpdateTablePartitionColumnStatisticsRequest',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'object',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateTableColumnStatistics',
+ ],
+ 'GetTable' => [
+ 'summary' => 'Get detailed information about the data tables in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The message returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Table' => [
+ 'description' => 'The details about the data table.'."\n",
+ '$ref' => '#/components/schemas/Table',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'GetTable',
+ 'responseParamsDescription' => 'Code: the error code.\\'."\n"
+ .'NoSuchObject: The specified metadata table does not exist.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'GetTableColumnStatistics' => [
+ 'summary' => 'You can call this operation to obtain statistics about a specified field in a data table in a data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/columnstatistics',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ [
+ 'name' => 'ColumnNames',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The names of the columns in the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'ColumnStatisticsObjList' => [
+ 'title' => 'ColumnStatisticsObjList',
+ 'description' => 'The list of column statistics.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The column statistics.'."\n",
+ '$ref' => '#/components/schemas/ColumnStatisticsObj',
+ ],
+ 'example' => '[]',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* true and'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"ColumnStatisticsObjList\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"ColumnType\\": \\"\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"\\",\\n \\"StatisticsType\\": \\"\\"\\n }\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'GetTableColumnStatistics',
+ 'responseParamsDescription' => '* code: the error code.'."\n"
+ .'* message: the error message.'."\n"
+ .'* requestId: the unique ID of the current request.'."\n"
+ .'* Success:true/false to determine whether the request is successful. If true, then the ColumnStatisticsObjList has a value.'."\n",
+ ],
+ 'GetTableVersion' => [
+ 'summary' => 'Gets a specified version of a data table in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/versions',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ ],
+ [
+ 'name' => 'VersionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'Table Version',
+ 'description' => 'The version number of the data table.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableVersion' => [
+ 'description' => 'The information about the data table of the specified version.'."\n",
+ 'example' => '{"VersionId":123,"Table":{}}',
+ '$ref' => '#/components/schemas/TableVersion',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\"\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'GetTableVersion',
+ 'responseParamsDescription' => 'Code: the error code.\\'."\n"
+ .'NoSuchObject: The specified metadata table does not exist.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListTableNames' => [
+ 'summary' => 'This function is used only to query the names of data tables in Data Lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/names',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'TableNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableNamePattern',
+ 'description' => 'The data table name matches the regular expression.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '\'\'',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000000',
+ 'minimum' => '-1',
+ 'example' => '10',
+ 'default' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableType filter',
+ 'description' => 'The type of the data table. Valid values:'."\n"
+ ."\n"
+ .'MANAGED_TABLE: internal table'."\n"
+ ."\n"
+ .'EXTERNAL_TABLE: foreign table'."\n"
+ ."\n"
+ .'VIRTUAL_VIEW: virtual view'."\n"
+ ."\n"
+ .'INDEX_TABLE: index table'."\n"
+ ."\n"
+ .'MATERIALIZED_VIEW: materialized view.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MANAGED_TABLE',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The paging token.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableNames' => [
+ 'title' => 'TableNames',
+ 'description' => 'The names of the data tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'table1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableNames\\": [\\n \\"table1\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListTableNames',
+ 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListTables' => [
+ 'summary' => 'You can call this operation to obtain a list of data tables in the data lake.',
+ 'path' => '/api/metastore/databases/tables/list',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'TableNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableNamePattern',
+ 'description' => 'The name of the data table, which is matched by a regular expression.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '\'\'',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000000',
+ 'minimum' => '-1',
+ 'example' => '10',
+ 'default' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableType filter',
+ 'description' => 'The type of the data table. Valid values:'."\n"
+ ."\n"
+ .'* MANAGED_TABLE: internal table'."\n"
+ .'* EXTERNAL_TABLE: foreign table'."\n"
+ .'* VIRTUAL_VIEW: virtual view'."\n"
+ .'* INDEX_TABLE: index table'."\n"
+ .'* MATERIALIZED_VIEW: materialized view.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MANAGED_TABLE',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The paging token.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'RequestId' => [
+ 'title' => ' RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tables' => [
+ 'title' => 'Tables',
+ 'description' => 'The list of data tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about the data table.'."\n",
+ '$ref' => '#/components/schemas/Table',
+ ],
+ 'example' => '[{"TableName":"xx"}]',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"Tables\\": [\\n {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListTables',
+ 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListTableVersions' => [
+ 'summary' => 'Queries the list of specified versions of data tables in a data lake by page.',
+ 'path' => '/api/metastore/catalogs/databases/tables/versions/list',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '\'\'',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'max result of this query',
+ 'description' => 'The size of each page. The maximum value is 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableVersions' => [
+ 'title' => 'table versions',
+ 'description' => 'The data tables of multiple versions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data table of a specific version.'."\n",
+ 'example' => '{"table":{},"versionId":123}',
+ '$ref' => '#/components/schemas/TableVersion',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableVersions\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\"\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListTableVersions',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified data table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'GetTableProfile' => [
+ 'summary' => 'Obtains the details of a table data profile.',
+ 'path' => '/webapi/metastorehouse/catalog/database/tableprofile',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory. By default, the ID of the primary account is entered.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'exp_table',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the metadata table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'admin_user',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'None',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C742A04F-F304-5440-9ED8-AD58C36D1915',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableProfile' => [
+ 'description' => 'The data profile of the table.'."\n",
+ '$ref' => '#/components/schemas/TableProfile',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"97434FA4-A6B2-1AE4-A174-76964F29C759\\",\\n \\"Success\\": true,\\n \\"TableProfile\\": {\\n \\"PartitionCnt\\": 3,\\n \\"FileCnt\\": 5,\\n \\"ObjectCnt\\": 5,\\n \\"FileSize\\": 31,\\n \\"ObjectSize\\": 31,\\n \\"RecordCnt\\": 0,\\n \\"IsPartitioned\\": true,\\n \\"LastModifyTime\\": \\"2023-08-16 18:02:25\\",\\n \\"LastAccessTime\\": \\"2023-08-22 12:14:42\\",\\n \\"DatabaseName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"CreateTime\\": \\"2023-08-14 10:44:13\\",\\n \\"Location\\": \\"oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/\\",\\n \\"AccessNum\\": 0,\\n \\"AccessNumWeekly\\": 0,\\n \\"AccessNumMonthly\\": 0,\\n \\"LastAccessNumTime\\": \\"\\",\\n \\"LatestDate\\": \\"2023-08-30 19:16:10\\",\\n \\"LatestAccessNumDate\\": \\"\\",\\n \\"LastDdlTime\\": \\"2023-08-16 18:02:24\\",\\n \\"ObjectAccessNum\\": 0,\\n \\"ObjectAccessNumWeekly\\": 18,\\n \\"ObjectAccessNumMonthly\\": 18,\\n \\"DataSourceType\\": \\"OSS_HDFS\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTableProfileResponse>\\n <TableProfile>\\n <ObjectCnt>5</ObjectCnt>\\n <AccessNum>0</AccessNum>\\n <ObjectAccessNumMonthly>18</ObjectAccessNumMonthly>\\n <ObjectAccessNumWeekly>0</ObjectAccessNumWeekly>\\n <LastDdlTime>2023-08-16 18:02:24</LastDdlTime>\\n <CreateTime>2023-08-14 10:44:13</CreateTime>\\n <ObjectSize>31</ObjectSize>\\n <DatabaseName>test_db</DatabaseName>\\n <FileCnt>2</FileCnt>\\n <LastModifyTime>2023-08-16 18:02:25</LastModifyTime>\\n <LastAccessTime>2023-08-22 12:14:42</LastAccessTime>\\n <LatestDate>2023-08-30 19:16:10</LatestDate>\\n <ObjectAccessNum>0</ObjectAccessNum>\\n <TableName>test_tbl</TableName>\\n <AccessNumMonthly>0</AccessNumMonthly>\\n <PartitionCnt>3</PartitionCnt>\\n <AccessNumWeekly>0</AccessNumWeekly>\\n <DataSourceType>OSS_HDFS</DataSourceType>\\n <FileSize>31</FileSize>\\n </TableProfile>\\n <RequestId>97434FA4-A6B2-1AE4-A174-76964F29C759</RequestId>\\n <Success>true</Success>\\n</GetTableProfileResponse>","errorExample":""}]',
+ 'title' => 'GetTableProfile',
+ 'description' => 'To use a data profile, you must first host the OSS bucket of the table.'."\n",
+ ],
+ 'RenameTable' => [
+ 'summary' => 'is used only to update the name of a data table in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/rename',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'TableInput' => [
+ 'description' => 'The data table object. You need only to specify the TableName parameter in this object.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/TableInput',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ 'IsAsync' => [
+ 'title' => 'IsAsync',
+ 'description' => 'Specifies whether to asynchronously rename the data table. Valid values:'."\n"
+ ."\n"
+ .'* false (default): The operation is synchronously called. The update result is returned after the background task is complete. If the execution of the background task requires an extended period of time, a timeout occurs.'."\n"
+ .'* true: The operation is asynchronously called. The update result is immediately returned. You can query the task status by TaskId in the returned result.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskId' => [
+ 'title' => 'Async task Id',
+ 'description' => 'The ID of the asynchronous task.'."\n",
+ 'type' => 'string',
+ 'example' => 'c38206c3aca0c41332ffe49294243009',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"c38206c3aca0c41332ffe49294243009\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'RenameTable',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidOperation: The corresponding database or table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchGetTables' => [
+ 'summary' => 'Obtain detailed information about data tables in the data lake in batches.',
+ 'path' => '/api/metastore/catalogs/databases/tables/batchget',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'TableNames' => [
+ 'description' => 'The name of the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableErrors' => [
+ 'title' => 'TableErrors',
+ 'description' => 'The returned errors.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned error.'."\n",
+ '$ref' => '#/components/schemas/TableError',
+ ],
+ ],
+ 'Tables' => [
+ 'title' => 'Tables',
+ 'description' => 'The returned data tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data table.'."\n",
+ '$ref' => '#/components/schemas/Table',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchGetTables',
+ 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n"
+ .'NoSuchObject: The specified data table does not exist.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchCreateTables' => [
+ 'summary' => 'Add data tables to a data lake at a time.',
+ 'path' => '/api/metastore/catalogs/databases/tables/batchcreate',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'IfNotExists' => [
+ 'title' => 'IfNotExists',
+ 'description' => 'Specifies whether to ignore errors if the table name already exists.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'TableInputs' => [
+ 'title' => 'TableInputs',
+ 'description' => 'The list of data tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data table details.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/TableInput',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '返回结构',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => '响应代码',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => '响应消息',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => '请求ID',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => '是否成功',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableErrors' => [
+ 'title' => '表出错信息',
+ 'description' => 'The list of errors occurred when you created the data table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The error occurred when you created the data table.'."\n",
+ '$ref' => '#/components/schemas/TableError',
+ ],
+ 'example' => '["ErrorDetail":{},"TableName":"test"]',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchCreateTables',
+ 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n"
+ .'InvalidObject:name/partition/column/skewCol does not pass the verification.\\'."\n"
+ .'AlreadyExists: The metadata table already exists.\\'."\n"
+ .'NoSuchObject: The specified metadatabase does not exist.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchDeleteTables' => [
+ 'summary' => 'Deletes multiple data 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' => 'Body',
+ 'description' => 'The HTTP request body, which is in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'IfExists' => [
+ 'title' => 'IfExists',
+ 'description' => 'Specifies whether to ignore errors if the partition with the specified name has been deleted.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'TableNames' => [
+ 'title' => 'TableName',
+ 'description' => 'The list of data table names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableErrors' => [
+ 'title' => 'PartitionErrors',
+ 'description' => 'The collection of error messages.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The error message.'."\n",
+ '$ref' => '#/components/schemas/TableError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchDeleteTables',
+ 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n"
+ .'NoSuchObject: The specified data table does not exist.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchDeleteTableVersions' => [
+ 'summary' => 'Deletes a specified version of a data table in a data lake at a time.',
+ 'path' => '/api/metastore/catalogs/databases/tables/versions/batchdelete',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, which is in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ 'VersionIds' => [
+ 'title' => 'Table versionIds',
+ 'description' => 'The list of version numbers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The version number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchDeleteTableVersions',
+ 'responseParamsDescription' => 'Code: the description of the error code.\\'."\n"
+ .'NoSuchObject: The specified data table does not exist.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchUpdateTables' => [
+ 'summary' => 'Update the details of data tables in the data lake in batches.',
+ 'path' => '/api/metastore/catalogs/databases/tables/batchupdate',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'TableInputs' => [
+ 'title' => 'TableInputs',
+ 'description' => 'The details about the updated data table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about the updated data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/TableInput',
+ ],
+ 'required' => false,
+ ],
+ 'IsAsync' => [
+ 'title' => '是否异步',
+ 'description' => 'Specifies whether to asynchronously update the data table. Valid values:'."\n"
+ ."\n"
+ .'* true: The operation is asynchronously called. The update result is immediately returned. You can query the task status by taskid in the returned results.'."\n"
+ .'* false: The operation is synchronously called. The update result is returned after the background task is complete. If the execution of the background task requires an extended period of time, a timeout occurs.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '返回结构',
+ 'description' => 'The returned result 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' => '请求ID',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => '是否成功',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableErrors' => [
+ 'title' => '表出错信息',
+ 'description' => 'The returned errors.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned error.'."\n",
+ '$ref' => '#/components/schemas/TableError',
+ ],
+ 'example' => '{"ErrorDetails":{},"TableName":"test"}',
+ ],
+ 'TaskId' => [
+ 'title' => '异步更新 taskId',
+ 'description' => 'The ID of the asynchronous update task.'."\n",
+ 'type' => 'string',
+ 'example' => 'f8deec55f54ac566e7ec8944fbe01588',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TableErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"TableName\\": \\"\\"\\n }\\n ],\\n \\"TaskId\\": \\"f8deec55f54ac566e7ec8944fbe01588\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchUpdateTables',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidOperation: The input data table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'CreatePartition' => [
+ 'summary' => 'Add a partition to the data table of the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'IfNotExists' => [
+ 'title' => 'IfNotExists',
+ 'description' => 'Specifies whether to ignore errors if the name of the partition to be created already exists.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'NeedResult' => [
+ 'title' => 'NeedResult',
+ 'description' => 'Specifies whether to return partition information. If this parameter is set to true, the Partition parameter is returned.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'PartitionInput' => [
+ 'description' => 'The information about the partition to be created.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/PartitionInput',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Partition' => [
+ 'description' => 'The partition information. This parameter is returned if the NeedResult parameter is set to true.'."\n",
+ '$ref' => '#/components/schemas/Partition',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Partition\\": {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n },\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'CreatePartition',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidObject: The corresponding database or table cannot be found.'."\n"
+ .'* AlreadyExists: The corresponding partition already exists.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'DeletePartition' => [
+ 'summary' => 'Deletes a specified partition from a data table in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/delete',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'IfExists' => [
+ 'title' => 'IfExists',
+ 'description' => 'Specifies whether to ignore errors if the partition that you want to delete does not exist. Valid values:'."\n"
+ ."\n"
+ .'* true: ignores errors and no error will be reported.'."\n"
+ .'* false: does not ignore errors and errors will be reported.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'PartitionValues' => [
+ 'description' => 'The values of the partition key columns.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201225',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeletePartition',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidOperation: The corresponding data table or partition does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'DeletePartitionColumnStatistics' => [
+ 'summary' => 'Reclaim the field statistics of data table partitions in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ [
+ 'name' => 'PartitionNames',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The names of the partitions.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ [
+ 'name' => 'ColumnNames',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The key columns of the partitions.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeletePartitionColumnStatistics',
+ ],
+ 'UpdatePartitionColumnStatistics' => [
+ 'summary' => 'Creates or updates the field statistics of a data table partition.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics',
+ 'methods' => [
+ 'put',
+ ],
+ '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 request to update partition column statistics in the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/UpdateTablePartitionColumnStatisticsRequest',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdatePartitionColumnStatistics',
+ ],
+ 'GetPartition' => [
+ 'summary' => 'Get details about the database partitions in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/get',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'PartitionValues' => [
+ 'description' => 'The partitions.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Partition' => [
+ 'description' => 'The partition details.'."\n",
+ '$ref' => '#/components/schemas/Partition',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Partition\\": {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n },\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'GetPartition',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database, table, or partition does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'GetPartitionColumnStatistics' => [
+ 'summary' => 'Obtains the statistics of a specified field for a data partition in a data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ [
+ 'name' => 'PartitionNames',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The names of the partitions in the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ [
+ 'name' => 'ColumnNames',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The names of the fields in the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'PartitionStatisticsMap' => [
+ 'title' => 'PartitionStatisticsMap',
+ 'description' => 'The partition statistics.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => [
+ '$ref' => '#/components/schemas/ColumnStatisticsObj',
+ 'description' => 'The partition statistics.'."\n",
+ ],
+ 'description' => 'The list of partition statistics.'."\n",
+ ],
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"PartitionStatisticsMap\\": {\\n \\"key\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"ColumnType\\": \\"\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"\\",\\n \\"StatisticsType\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'GetPartitionColumnStatistics',
+ ],
+ 'ListPartitionNames' => [
+ 'summary' => 'You can call this operation to obtain a list of partition names of data tables in a data lake. This method is usually used for multi-level partitioning.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/names',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The pagination token. The token is obtained in the returned results. If no pagination token is returned, set this parameter to an empty string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'PageSize' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries per page. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'PartialPartValues' => [
+ 'description' => 'The values of the partition key columns. You can pass in only the values of specific partition key columns to query the names of all lower-level partitions.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'code',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The paging token.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'PartitionNames' => [
+ 'title' => 'PartitionNames',
+ 'description' => 'The list of partition names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the partition.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds=20201124/hour=10',
+ ],
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"PartitionNames\\": [\\n \\"ds=20201124/hour=10\\"\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListPartitionNames',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database or table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListPartitions' => [
+ 'summary' => 'Obtains a list of database partition details in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/list',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The pagination token. The token is obtained in the return results. If no pagination token is returned, set this parameter to an empty string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'PageSize' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries per page. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'PartialPartValues' => [
+ 'description' => 'The list of partition values. You can pass in only the values of specific partitions to query the names of all lower-level partitions.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ 'IsShareSd' => [
+ 'title' => 'IsShareSd',
+ 'description' => 'Specifies whether to share the column information of SD in the partition. Valid values:'."\n"
+ ."\n"
+ .'* true: The column information of SD in the partition is shared. In this case, only one copy of data is returned for columns with the same name. This reduces the volume of transferred data and improves the performance of this API operation.'."\n"
+ .'* false: The column information of SD in the partition is not shared.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'code',
+ 'description' => 'The returned result body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The paging token.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'Partitions' => [
+ 'title' => 'Partitions',
+ 'description' => 'The list of partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about the partition.'."\n",
+ '$ref' => '#/components/schemas/Partition',
+ ],
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PartitionSpecs' => [
+ 'title' => 'PartitionSpecs',
+ 'description' => 'The list of partition specifications.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition specification.'."\n",
+ '$ref' => '#/components/schemas/PartitionSpec',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListPartitions',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database or table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListPartitionsByFilter' => [
+ 'summary' => 'Obtain the list of data table partitions in the data lake and query them by filter condition.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/listbyfilter',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'Filter' => [
+ 'title' => 'Filter',
+ 'description' => 'The expression of the query condition. The following operators are supported:'."\n"
+ ."\n"
+ .'* Comparison operators: =, <>, ! =, <, <=, >, >=. For example: ds > 20240101.'."\n"
+ .'* Logical operators: AND, OR, and NOT. Example: ds like \'20240%\'.'."\n"
+ .'* BETWEEN operator: specifies a range. For example: ds BETWEEN 20240101 AND 20241201.'."\n"
+ .'* IN operator: Used to specify a specific set of values. Example: ds IN (20240101, 20240102).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ds>20201201',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '\'\'',
+ ],
+ 'PageSize' => [
+ 'title' => 'PageSize',
+ 'description' => 'The size of each page. The maximum size is 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'Indicates the name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ 'IsShareSd' => [
+ 'title' => 'IsShareSd',
+ 'description' => 'Specifies whether to share the column information in the SD of the partition. Valid values:'."\n"
+ ."\n"
+ .'* true: shared'."\n"
+ .'* false: does not share the data.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'code',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'Partitions' => [
+ 'title' => 'Partitions',
+ 'description' => 'The details about the partitions that are queried based on the filter condition.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about the partition that is queried based on the filter condition.'."\n",
+ '$ref' => '#/components/schemas/Partition',
+ ],
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PartitionSpecs' => [
+ 'title' => 'PartitionSpecs',
+ 'description' => 'The partition specifications.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition specification.'."\n",
+ '$ref' => '#/components/schemas/PartitionSpec',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListPartitionsByFilter',
+ 'requestParamsDescription' => 'isShareSd: whether to share the column information in the SD of the partition. In the list of partitions returned by listpartitions, it is more likely that the columns in the sd of different partitions are the same. Therefore, enabling sharing can reduce the amount of data transmitted over the network and help improve performance.'."\n",
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database or table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchCreatePartitions' => [
+ 'summary' => 'Add multiple partitions to a data table in a data lake at a time.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchcreate',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'IfNotExists' => [
+ 'title' => 'IfNotExists',
+ 'description' => 'Specifies whether to ignore errors if the name of the partition to be created already exists.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'NeedResult' => [
+ 'title' => 'NeedResult',
+ 'description' => 'Specifies whether to return partition information. If the value is true, the partitions are returned.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'PartitionInputs' => [
+ 'title' => 'PartitionInputs',
+ 'description' => 'The information about the partitions to be created.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the partition to be created.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/PartitionInput',
+ ],
+ 'required' => false,
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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' => '.',
+ ],
+ 'PartitionErrors' => [
+ 'title' => '分区出错信息',
+ 'description' => 'The returned errors.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned error.'."\n",
+ '$ref' => '#/components/schemas/PartitionError',
+ ],
+ ],
+ 'Partitions' => [
+ 'title' => 'Partitions',
+ 'description' => 'The partitions, which are returned if the NeedResult parameter is set to true.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned partition.'."\n",
+ '$ref' => '#/components/schemas/Partition',
+ ],
+ ],
+ 'RequestId' => [
+ 'title' => '请求ID',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => '是否成功',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchCreatePartitions',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidObject: The corresponding Table or Database cannot be found.'."\n"
+ .'* AlreadyExists: The corresponding partition already exists.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchDeletePartitions' => [
+ 'summary' => 'Deletes multiple partitions of a data table in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchdelete',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'IfExists' => [
+ 'title' => 'IfExists',
+ 'description' => 'Specifies whether to ignore errors if the partition that you want to delete does not exist.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'PartitionValueList' => [
+ 'description' => 'The partition key column values of the partitions to be deleted.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/PartitionValueList',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201225',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'PartitionErrors' => [
+ 'title' => 'PartitionErrors',
+ 'description' => 'The returned errors.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned error.'."\n",
+ '$ref' => '#/components/schemas/PartitionError',
+ ],
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchDeletePartitions',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* UnknownTable: The specified data table does not exist.'."\n"
+ .'* UnknownPartition: The specified partition does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchGetPartitionColumnStatistics' => [
+ 'summary' => 'Obtains the field statistics of data table partitions in a data lake at a time.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/columnstatistics/batchget',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ 'PartitionNames' => [
+ 'description' => 'The names of the partitions in the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'ColumnNames' => [
+ 'description' => 'The names of the columns in the data table.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'PartitionStatisticsMap' => [
+ 'title' => 'PartitionStatisticsMap',
+ 'description' => 'The partition statistics.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => [
+ '$ref' => '#/components/schemas/ColumnStatisticsObj',
+ 'description' => 'The partition statistics.'."\n",
+ ],
+ 'description' => 'The list of partition statistics.'."\n",
+ ],
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"PartitionStatisticsMap\\": {\\n \\"key\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"ColumnType\\": \\"\\",\\n \\"ColumnStatisticsData\\": {\\n \\"StatisticsData\\": \\"\\",\\n \\"StatisticsType\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchGetPartitionColumnStatistics',
+ ],
+ 'BatchGetPartitions' => [
+ 'summary' => 'Obtains the details of database partitions in a data lake in batches.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchget',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'PartitionValueList' => [
+ 'description' => 'The values of the partition key columns.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/PartitionValueList',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ 'IsShareSd' => [
+ 'title' => 'IsShareSd',
+ 'description' => 'Specifies whether to share the column information of SD in the partition.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'PartitionErrors' => [
+ 'title' => 'PartitionErrors',
+ 'description' => 'The error messages.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The error message.'."\n",
+ '$ref' => '#/components/schemas/PartitionError',
+ ],
+ ],
+ 'Partitions' => [
+ 'title' => 'Partitions',
+ 'description' => 'The list of partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about a partition.'."\n",
+ '$ref' => '#/components/schemas/Partition',
+ ],
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PartitionSpecs' => [
+ 'title' => 'PartitionSpecs',
+ 'description' => 'The list of partition specifications.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition specification.'."\n",
+ '$ref' => '#/components/schemas/PartitionSpec',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Partitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"PartitionSpecs\\": [\\n {\\n \\"SharedSDPartitions\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {},\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SharedStorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Location\\": \\"相对路径\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchGetPartitions',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database or table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'BatchUpdatePartitions' => [
+ 'summary' => 'Batch update multiple partitions for a data table in a data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/batchupdate',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'PartitionInputs' => [
+ 'title' => 'PartitionInputs',
+ 'description' => 'The information about the partitions to be updated.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the partition to be updated.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/PartitionInput',
+ ],
+ 'required' => false,
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20201223',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'object',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'PartitionErrors' => [
+ 'title' => 'PartitionErrors',
+ 'description' => 'The returned errors.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned error.'."\n",
+ '$ref' => '#/components/schemas/PartitionError',
+ ],
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n },\\n \\"PartitionValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'BatchUpdatePartitions',
+ ],
+ 'RenamePartition' => [
+ 'summary' => 'Update the partition name of the data table in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/rename',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'Body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'PartitionInput' => [
+ 'description' => 'The renamed partition information, which is the same as the partition information you specify for the CreatePartition operation.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/PartitionInput',
+ ],
+ 'PartitionValues' => [
+ 'description' => 'The values of the partition key columns.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'TableName' => [
+ 'title' => 'TableName',
+ 'description' => 'The name of the data table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table_20200715162543389',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'RenamePartition',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* InvalidOperation: The corresponding database or table cannot be found, or the new partition name already exists.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'CreateFunction' => [
+ 'summary' => 'Added user-defined functions for databases in the data lake.',
+ 'path' => '/api/metastore/catalogs/databases/functions',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'FunctionInput' => [
+ 'description' => 'The details about the function definition.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/FunctionInput',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'CreateFunction',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* AlreadyExists: The same function already exists.'."\n"
+ .'* NoSuchObject: The specified database or table does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'DeleteFunction' => [
+ 'summary' => 'Deletes a user-defined function for a database in the data lake by name.',
+ 'path' => '/api/metastore/catalogs/databases/functions',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'FunctionName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'FunctionName',
+ 'description' => 'The function name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'func2',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The information returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteFunction',
+ 'responseParamsDescription' => 'Code error code description:'."\n"
+ ."\n"
+ .'* NoSuchObject: The specified database, table, or function does not exist.'."\n"
+ .'* InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'UpdateFunction' => [
+ 'summary' => 'Updates the user-defined function information for a database in the data lake by name.',
+ 'path' => '/api/metastore/catalogs/databases/functions',
+ 'methods' => [
+ 'put',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ 'FunctionInput' => [
+ 'description' => 'The details about the function to be updated.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/FunctionInput',
+ ],
+ 'FunctionName' => [
+ 'description' => 'The function name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'func2',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Respones',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateFunction',
+ 'responseParamsDescription' => 'Code: the error code.\\'."\n"
+ .'InvalidObject: The corresponding metabase, table, or function does not exist, or the function parameter is empty.\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListFunctionNames' => [
+ 'summary' => 'Paged query to obtain the list of function names of the database.',
+ 'path' => '/api/metastore/catalogs/databases/functions/names',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'FunctionNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'FunctionNamePattern',
+ 'description' => 'The regular expression that matches the function name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '\'\'',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries per page. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000000',
+ 'minimum' => '-1',
+ 'example' => '10',
+ 'default' => '1000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'FunctionNames' => [
+ 'title' => 'FunctionNames',
+ 'description' => 'The list of function names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The routine name.'."\n",
+ 'type' => 'string',
+ 'example' => 'func2',
+ ],
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The paging token.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"FunctionNames\\": [\\n \\"func2\\"\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListFunctionNames',
+ 'responseParamsDescription' => 'Code error code description:\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'ListFunctions' => [
+ 'summary' => 'Obtains a list of user-defined functions for databases in the data lake in bulk.',
+ 'path' => '/api/metastore/catalogs/databases/functions/list',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'FunctionNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'FunctionNamePattern',
+ 'description' => 'The regular match expression for the user-defined function name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries per page. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000000',
+ 'minimum' => '-1',
+ 'example' => '10',
+ 'default' => '1000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Functions' => [
+ 'title' => 'Functions',
+ 'description' => 'The details of the functions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about the function.'."\n",
+ '$ref' => '#/components/schemas/Function',
+ ],
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'example' => ' ',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Functions\\": [\\n {\\n \\"CatalogId\\": \\"\\",\\n \\"ClassName\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"FunctionName\\": \\"\\",\\n \\"FunctionType\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ResourceUri\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"CreatedBy\\"\\n }\\n ],\\n \\"Message\\": \\".\\",\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ListFunctions',
+ 'responseParamsDescription' => 'Code error code description:\\'."\n"
+ .'InternalError: Other types of errors. For more information, see Message tips.'."\n",
+ ],
+ 'GetFunction' => [
+ 'summary' => 'Obtain the user-defined function of the database in the data lake based on the function name.',
+ 'path' => '/api/metastore/catalogs/databases/functions',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of a database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'database_test',
+ ],
+ ],
+ [
+ 'name' => 'FunctionName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'FunctionName',
+ 'description' => 'The name of the user-defined function.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'func2',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Function' => [
+ 'description' => 'The details about the function.'."\n",
+ 'example' => '{"FunctionName":test}',
+ '$ref' => '#/components/schemas/Function',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Function\\": {\\n \\"CatalogId\\": \\"\\",\\n \\"ClassName\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"DatabaseName\\": \\"\\",\\n \\"FunctionName\\": \\"\\",\\n \\"FunctionType\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ResourceUri\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"CreatedBy\\"\\n },\\n \\"Message\\": \\"error\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'GetFunction',
+ 'responseParamsDescription' => 'Code error code description:\\'."\n"
+ .'InternalError: For more information, see the message prompt.'."\n",
+ ],
+ 'CreateLock' => [
+ 'summary' => 'Creates a specified metadata lock.',
+ 'path' => '/api/metastore/catalogs/databases/tables/locks',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'body',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'LockObjList' => [
+ 'title' => 'LockObjList',
+ 'description' => 'The list of locks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The lock.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/LockObj',
+ ],
+ 'required' => false,
+ 'example' => '{"databaseName":"db","tableName":"test"}',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'lock response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '73201200-4C1A-4FEF-BD6B-C0DA7994FFA2',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'LockStatus' => [
+ 'description' => 'The lock status.'."\n",
+ 'example' => '{"lockId":12323,"lockStatus":"ACQUIRED"}',
+ '$ref' => '#/components/schemas/LockStatus',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"73201200-4C1A-4FEF-BD6B-C0DA7994FFA2\\",\\n \\"Success\\": true,\\n \\"LockStatus\\": {\\n \\"LockId\\": 0,\\n \\"LockState\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'CreateLock',
+ 'requestParamsDescription' => '1. Currently, LockObjList only supports size 1, which means that only one object can be locked.'."\n"
+ .'2. LockObj supports only table locks and does not support partition-level locks.'."\n",
+ 'responseParamsDescription' => '* code: the error code.'."\n"
+ .'* message: the error message.'."\n"
+ .'* requestId: the unique ID of the current request.'."\n"
+ .'* Success:true/false to determine whether the request is successful.'."\n"
+ .'* LockStatus: The field has a value if it is successful. Otherwise, it is empty. LockStatus contains two fields: lockId and Lockstate. If lockstate is Acquired, lockid has a value. Otherwise, it is empty.'."\n",
+ ],
+ 'GetLock' => [
+ 'summary' => 'Queries the specified metadata lock.',
+ 'path' => '/api/metastore/catalogs/databases/tables/locks',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'LockId',
+ 'description' => 'The lock ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '16533',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Lock response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'LockStatus' => [
+ 'description' => 'The lock status.'."\n",
+ 'example' => '{"lockId":123,"lockStatus":"Acquired"}',
+ '$ref' => '#/components/schemas/LockStatus',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Success\\": true,\\n \\"LockStatus\\": {\\n \\"LockId\\": 0,\\n \\"LockState\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetLock',
+ 'requestParamsDescription' => 'lockid, that is, lockid returned from createlock'."\n",
+ ],
+ 'AbortLock' => [
+ 'summary' => 'Aborts the specified metadata lock.',
+ 'path' => '/api/metastore/catalogs/databases/tables/locks/abort',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'LockId',
+ 'description' => 'The lock ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '16530',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'transaction response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '01D8DD6B-4929-5999-9BB3-950AA30E3BD0',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"01D8DD6B-4929-5999-9BB3-950AA30E3BD0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AbortLock',
+ 'requestParamsDescription' => 'lockid, the lockid obtained from the createlock request'."\n",
+ ],
+ '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' => 'LockId',
+ 'description' => 'The lock ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12324',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Lock response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RefreshLock',
+ 'requestParamsDescription' => 'lockid, that is, lockid returned from createlock'."\n",
+ ],
+ 'UnLock' => [
+ 'summary' => 'Unlocks the specified metadata lock.',
+ 'path' => '/api/metastore/catalogs/databases/tables/locks',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'LockId',
+ 'description' => 'The lock ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '11709',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'transaction response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '37C8470A-5E6D-5E4E-AEF0-EA3EBE9C89EE',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"37C8470A-5E6D-5E4E-AEF0-EA3EBE9C89EE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UnLock',
+ 'requestParamsDescription' => 'LockId, that is, the lockId obtained from CreateLock'."\n",
+ ],
+ 'StopMigrationWorkflow' => [
+ 'summary' => 'Stop the metadata migration task.',
+ 'path' => '/webapi/migration/workflow/stop',
+ 'methods' => [
+ 'put',
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'M-6DCF5D8EF92E2195',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the test feature is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\"\\n}","type":"json"}]',
+ 'title' => 'StopMigrationWorkflow',
+ ],
+ 'RunMigrationWorkflow' => [
+ 'summary' => 'Runs a metadata migration task.',
+ 'path' => '/webapi/migration/workflow/run',
+ 'methods' => [
+ 'post',
+ ],
+ '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 instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'M-EDD8BF959BB97345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The returned data. The value is the ID of the workflow instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'FI-7193B85809CAD95C',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'A048EA8E-3519-5B18-B81E-EE3E0B6DBE0C',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"FI-7193B85809CAD95C\\",\\n \\"RequestId\\": \\"A048EA8E-3519-5B18-B81E-EE3E0B6DBE0C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RunMigrationWorkflow',
+ ],
+ 'GetAsyncTaskStatus' => [
+ 'summary' => 'Used in metadata-related asynchronous APIs to check the status of asynchronous execution tasks.',
+ 'path' => '/api/metastore/catalogs/tasks',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'TaskId',
+ 'description' => 'The result returned by the asynchronous task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f546c761570e5efc8146a1986f7890d2',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskStatus' => [
+ 'description' => 'The task status.'."\n",
+ 'example' => 'Success',
+ '$ref' => '#/components/schemas/TaskStatus',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'Code',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"TaskStatus\\": {\\n \\"Status\\": \\"\\",\\n \\"Message\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetAsyncTaskStatus',
+ ],
+ 'Search' => [
+ 'summary' => 'Metadata retrieval.',
+ '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' => 'A short description of struct',
+ 'description' => 'A short description of struct'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'catalogid',
+ 'description' => 'catalogid'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'SearchText' => [
+ 'title' => '搜索问题',
+ 'description' => 'The search text.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'tags:tag1 or comment:^iso and name=aliyun and (createTime > "20211111" and createTime < "20211117") and has category',
+ ],
+ 'SortCriteria' => [
+ 'title' => '排序结构',
+ 'description' => 'The sorting rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The sorting rule.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/SortCriterion',
+ ],
+ 'required' => false,
+ ],
+ 'PageSize' => [
+ 'title' => '当前查询的页大小',
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1000',
+ ],
+ 'PageNumber' => [
+ 'title' => '当前查询的页号',
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'SearchType' => [
+ 'description' => 'The search type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TABLE/DATABASE/CATALOG',
+ 'enum' => [
+ 'table',
+ 'all',
+ 'database',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => '响应代码',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => '响应消息',
+ 'description' => 'Response'."\n",
+ 'type' => 'string',
+ 'example' => '""',
+ ],
+ 'RequestId' => [
+ 'title' => '请求ID',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '460C862F-BB91-5C04-BC3F-946EEF467862',
+ ],
+ 'Success' => [
+ 'title' => '是否成功',
+ 'description' => 'Indicates whether the information about the service was queried.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'DatabaseResult' => [
+ 'title' => '返回的db结果',
+ 'description' => 'The returned database information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Databases' => [
+ 'title' => '返回的DatabaseList',
+ 'description' => 'The returned databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The database information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Database' => [
+ 'title' => '返回的Database',
+ 'description' => 'The returned database.'."\n",
+ '$ref' => '#/components/schemas/Database',
+ ],
+ 'HighLightList' => [
+ 'title' => '返回高亮文本',
+ 'description' => 'The returned highlighted text.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned highlighted text.'."\n",
+ '$ref' => '#/components/schemas/HighLight',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'title' => '满足匹配条件的总的Database个数',
+ 'description' => 'Total number of databases that meet the match conditions'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11000',
+ ],
+ ],
+ ],
+ 'TableResult' => [
+ 'title' => '返回的table result',
+ 'description' => 'The returned table information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Tables' => [
+ 'title' => '返回的TableList',
+ 'description' => 'The returned tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The metadata table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Table' => [
+ 'title' => '返回的Table',
+ 'description' => 'The returned table.'."\n",
+ '$ref' => '#/components/schemas/Table',
+ ],
+ 'HighLightList' => [
+ 'title' => '返回的高亮文本',
+ 'description' => 'The returned highlighted text.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned highlighted text.'."\n",
+ '$ref' => '#/components/schemas/HighLight',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'title' => '满足匹配条件的总的Table个数',
+ 'description' => 'The total number of tables that meet the match conditions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1100',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"460C862F-BB91-5C04-BC3F-946EEF467862\\",\\n \\"Success\\": true,\\n \\"DatabaseResult\\": {\\n \\"Databases\\": [\\n {\\n \\"Database\\": {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 11000\\n },\\n \\"TableResult\\": {\\n \\"Tables\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1100\\n }\\n}","type":"json"}]',
+ 'title' => 'Search',
+ 'description' => 'Metadata search'."\n",
+ ],
+ 'CreateRole' => [
+ 'summary' => 'In the Data Lake Permissions section, add a role.',
+ 'path' => '/api/metastore/auth/roles',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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 the JSON format.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/RoleInput',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '77BC2016-BA80-570F-BD15-2FB80281FED6',
+ ],
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"77BC2016-BA80-570F-BD15-2FB80281FED6\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateRole',
+ ],
+ 'GrantRoleToUsers' => [
+ 'summary' => 'Grant a Data Lake role to multiple users.',
+ 'path' => '/api/metastore/auth/roles/grantusers',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'A short description of struct',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleName' => [
+ 'title' => 'RoleName',
+ 'description' => 'The name of the role.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_role_8',
+ ],
+ 'Users' => [
+ 'description' => 'The RAM users or roles to which you want to assign the role. Format:'."\n"
+ ."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n"
+ .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/Principals',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4316D7DA-9816-596D-A3D7-12676FA59BDA',
+ ],
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4316D7DA-9816-596D-A3D7-12676FA59BDA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GrantRoleToUsers',
+ ],
+ 'GrantRolesToUser' => [
+ 'summary' => 'Grant multiple roles to a single user.',
+ 'path' => '/api/metastore/auth/roles/grantroles',
+ 'methods' => [
+ 'post',
+ ],
+ '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 parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleNames' => [
+ 'title' => '待授权的角色名列表',
+ 'description' => 'The roles to be assigned to the user.',
+ 'required' => true,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'User' => [
+ 'description' => 'The user to which you want to assign roles. Format:'."\n"
+ ."\n"
+ .'* RAM roles: acs:ram::\\[accountId]:role/\\[roleName].'."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].',
+ 'required' => true,
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876',
+ ],
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GrantRolesToUser',
+ ],
+ 'GrantPermissions' => [
+ 'summary' => 'Grant the operation permissions on resources to the User /Data Lake role.',
+ 'path' => '/api/metastore/auth/permissions/grant',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '授权的类型，目前仅支持hive',
+ 'description' => 'The authorization type. Only Hive is supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Hive',
+ 'enum' => [
+ 'hive',
+ ],
+ ],
+ 'MetaResource' => [
+ 'title' => '授权meta资源',
+ 'description' => 'The metadata resource to be authorized.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/MetaResource',
+ ],
+ 'Accesses' => [
+ 'title' => '授权的accesses列表',
+ 'description' => 'The list of the access permissions to be granted.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'DelegateAccesses' => [
+ 'title' => '授权的grantable accesses列表',
+ 'description' => 'The list of the grantable access permissions to be granted.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'Principal' => [
+ 'title' => '授权的用户/角色principal',
+ 'description' => 'The users or roles to be authorized. Formats:'."\n"
+ ."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n"
+ .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n"
+ .'* Data lake role: acs:dlf::\\[accountId]:role/\\[roleName]'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message Code',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4912024D-2A06-5E9F-9667-35D9319917D7',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"4912024D-2A06-5E9F-9667-35D9319917D7\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GrantPermissions',
+ ],
+ 'BatchGrantPermissions' => [
+ 'summary' => 'Grant the operation permissions on resources to a user or a data lake role at a time.',
+ 'path' => '/api/metastore/auth/permissions/batchgrant',
+ 'methods' => [
+ 'post',
+ ],
+ '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 HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '授权的类型，目前仅支持hive',
+ 'description' => 'The authorization type. Only Hive is supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Hive',
+ 'enum' => [
+ 'hive',
+ ],
+ ],
+ 'GrantRevokeEntries' => [
+ 'title' => '待授权列表',
+ 'description' => 'The list of the items to be authorized.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the item to be authorized.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/GrantRevokeEntry',
+ ],
+ 'required' => false,
+ ],
+ 'CatalogId' => [
+ 'title' => 'catalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message Code',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'BatchGrantRevokeFailureResult' => [
+ 'title' => 'result',
+ 'description' => 'The result returned when batch authorization failed.'."\n",
+ 'example' => '',
+ '$ref' => '#/components/schemas/BatchGrantRevokeFailureResult',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true,\\n \\"BatchGrantRevokeFailureResult\\": [\\n {\\n \\"GrantRevokeEntry\\": {\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"Id\\": \\"\\"\\n },\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'BatchGrantPermissions',
+ ],
+ 'DeleteRole' => [
+ 'summary' => 'Delete a role from Data Lake Permissions.',
+ 'path' => '/api/metastore/auth/roles',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'roleName',
+ 'description' => 'The name of the role to be deleted.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'roleId/roleName至少有一个是非空',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'requestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteRole',
+ ],
+ 'RevokeRoleFromUsers' => [
+ 'summary' => 'Removes multiple users from a single data lake role.',
+ 'path' => '/api/metastore/auth/roles/revokeusers',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'A short description of struct',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleName' => [
+ 'title' => '待revoke的角色',
+ 'description' => 'The role that you want to revoke from users.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_role_3',
+ ],
+ 'Users' => [
+ 'title' => '待revoke的用户列表',
+ 'description' => 'The RAM users or roles from which you want to revoke the role. Format:'."\n"
+ ."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n"
+ .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/Principals',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RevokeRoleFromUsers',
+ ],
+ 'RevokeRolesFromUser' => [
+ 'summary' => 'Removes multiple roles from a single user.',
+ 'path' => '/api/metastore/auth/roles/revokeroles',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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',
+ ],
+ 'User' => [
+ 'title' => '针对该用户进行revoke',
+ 'description' => 'The RAM user from whom you want to revoke roles. Format:'."\n"
+ ."\n"
+ .'* RAM roles: acs:ram::\\[accountId]:role/\\[roleName].'."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].',
+ 'required' => true,
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RevokeRolesFromUser',
+ ],
+ 'RevokePermissions' => [
+ 'summary' => 'Cancels the operation permissions on resources granted to a User /Data Lake role.',
+ 'path' => '/api/metastore/auth/permissions/revoke',
+ 'methods' => [
+ 'post',
+ ],
+ '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 HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '取消授权的类型，目前仅支持hive',
+ 'description' => 'The permission revocation type. Only Hive is supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Hive',
+ 'enum' => [
+ 'hive',
+ ],
+ ],
+ 'MetaResource' => [
+ 'title' => '取消授权meta资源',
+ 'description' => 'The metadata resource for which permissions need to be revoked.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/MetaResource',
+ ],
+ 'Accesses' => [
+ 'title' => '取消授权的accesses列表',
+ 'description' => 'The access permissions that need to be revoked.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'DelegateAccesses' => [
+ 'title' => '取消授权的grantable accesses列表',
+ 'description' => 'The grantable access permissions that need to be revoked. This parameter is unavailable.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'Principal' => [
+ 'title' => '取消授权的用户/角色principal',
+ 'description' => 'The user or role whose permissions need to be revoked. Formats:'."\n"
+ ."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n"
+ .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n"
+ .'* Data lake role: acs:dlf::\\[accountId]:role/\\[roleName]'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '7CB5765C-F209-5B10-8792-D2BE9156ABE8',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"7CB5765C-F209-5B10-8792-D2BE9156ABE8\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RevokePermissions',
+ ],
+ 'BatchRevokePermissions' => [
+ 'summary' => 'You can call this operation to revoke permissions on resources from a user or data lake role at a time.',
+ 'path' => '/api/metastore/auth/permissions/batchrevoke',
+ 'methods' => [
+ 'post',
+ ],
+ '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 HTTP request body, in the JSON format.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '授权的类型，目前仅支持hive',
+ 'description' => 'The authorization type. Set the value to Hive.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Hive',
+ 'enum' => [
+ 'hive',
+ ],
+ ],
+ 'GrantRevokeEntries' => [
+ 'title' => '待授权列表',
+ 'description' => 'The permissions to be revoked.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details the permissions to be revoked.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/GrantRevokeEntry',
+ ],
+ 'required' => false,
+ ],
+ 'CatalogId' => [
+ 'title' => 'catalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message Code',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C9E535E1-F040-56F4-B4EE-592B555DAE19',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'BatchGrantRevokeFailureResult' => [
+ 'title' => 'result',
+ 'description' => 'The result returned when batch permission revocation failed.'."\n",
+ 'example' => '',
+ '$ref' => '#/components/schemas/BatchGrantRevokeFailureResult',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"C9E535E1-F040-56F4-B4EE-592B555DAE19\\",\\n \\"Success\\": true,\\n \\"BatchGrantRevokeFailureResult\\": [\\n {\\n \\"GrantRevokeEntry\\": {\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"Id\\": \\"\\"\\n },\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'BatchRevokePermissions',
+ ],
+ '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' => 'RoleName',
+ 'description' => 'The role name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '原始名称',
+ ],
+ 'RoleInput' => [
+ 'description' => 'The input information of the updated role.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/RoleInput',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'requestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '604E5919-C6FF-54CE-9C23-C5350E6F5415',
+ ],
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'The status of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'message',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'success',
+ 'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"604E5919-C6FF-54CE-9C23-C5350E6F5415\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateRole',
+ ],
+ 'UpdateRoleUsers' => [
+ 'summary' => 'Update the user in the role to include ram user/ram 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' => 'A short description of struct',
+ 'description' => 'The HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleName' => [
+ 'title' => 'Role名称',
+ 'description' => 'The name of the role.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_role_8',
+ ],
+ 'Users' => [
+ 'description' => 'The list of users or roles. Format:'."\n"
+ ."\n"
+ .'RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n"
+ ."\n"
+ .'RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/Principals',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'requestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateRoleUsers',
+ ],
+ 'UpdatePermissions' => [
+ 'summary' => 'Update the permissions of the User /Data Lake role.',
+ 'path' => '/api/metastore/auth/permissions/',
+ 'methods' => [
+ 'put',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '授权的类型，目前仅支持hive',
+ 'description' => 'The type of the authorization. Only Hive is supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Hive',
+ 'enum' => [
+ 'hive',
+ ],
+ ],
+ 'MetaResource' => [
+ 'title' => '授权meta资源',
+ 'description' => 'The metadata resource to be authorized.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/MetaResource',
+ ],
+ 'Accesses' => [
+ 'title' => '授权的accesses列表',
+ 'description' => 'The list of access permissions to be authorized.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'DelegateAccesses' => [
+ 'title' => '授权的grantable accesses列表',
+ 'description' => 'The list of access permissions that can be delegated. This parameter is unavailable.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Accesses',
+ ],
+ 'Principal' => [
+ 'title' => '授权的用户/角色principal',
+ 'description' => 'The authorized users or roles. Formats:'."\n"
+ ."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName]'."\n"
+ .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName]'."\n"
+ .'* Data lake role: acs:dlf::\\[accountId]:role/\\[roleName]'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message Code',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdatePermissions',
+ ],
+ 'UpdateCatalogSettings' => [
+ 'summary' => 'To update the configurations of Data Lake Catalog, you must assume the admin role or more.',
+ 'path' => '/api/metastore/catalogs/settings',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ '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 HTTP request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ 'CatalogSettings' => [
+ 'description' => 'The catalog configuration.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/CatalogSettings',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '01D8DD6B-4929-5999-9BB3-950AA30E3BD0',
+ ],
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Whether the operation is successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The operation failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D8DD6B-4929-5999-9BB3-950AA30E3BD0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateCatalogSettings',
+ ],
+ 'GetRole' => [
+ 'summary' => 'Obtain the role in Data Lake Permissions based on the role name.',
+ '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' => 'roleName',
+ 'description' => 'The name of the role.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'role_name',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'requestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4316D7DA-9816-596D-A3D7-12676FA59BDA',
+ ],
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Role' => [
+ 'title' => 'role',
+ 'description' => 'The information about the role.'."\n",
+ '$ref' => '#/components/schemas/Role',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4316D7DA-9816-596D-A3D7-12676FA59BDA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"Role\\": {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'GetRole',
+ ],
+ 'ListRoles' => [
+ 'summary' => 'You can query the list of data lake roles.',
+ 'path' => '/api/metastore/auth/roles/list',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'Next PageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token!',
+ ],
+ ],
+ [
+ 'name' => 'RoleNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The regular expression that matches the role name. Fuzzy search is supported, such as.\\*test.\\*.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*test.*',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'PageSize',
+ 'description' => 'the number of entries returned on each page, the maximum value is 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '-1/100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'requestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Code' => [
+ 'title' => 'code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'data',
+ 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ 'Roles' => [
+ 'title' => 'role list data',
+ 'description' => 'The list of the roles.'."\n",
+ 'example' => '['."\n"
+ .' {'."\n"
+ .' "Description":"reserved by the system",'."\n"
+ .' "DisplayName":"admin",'."\n"
+ .' "UpdateTime":0,'."\n"
+ .' "IsPredefined":1,'."\n"
+ .' "Name":"admin"'."\n"
+ .' }'."\n"
+ .']',
+ '$ref' => '#/components/schemas/Roles',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\",\\n \\"Roles\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListRoles',
+ ],
+ 'ListRoleUsers' => [
+ 'summary' => 'Gets the list of users for a single role.',
+ 'path' => '/api/metastore/auth/roles/roleusers',
+ 'methods' => [
+ 'get',
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'admin',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'PageSize',
+ 'description' => 'The size of each page. The maximum value is 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '-1/100',
+ ],
+ ],
+ [
+ 'name' => 'UserNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'use name pattern filter',
+ 'description' => 'The regular expression that matches the user name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*user.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The pagination token, which is returned from the returned result. If none is returned, an empty string or \'\'is passed.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token!',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '558D764F-8C55-49CA-BF38-80EA532FC08F',
+ ],
+ 'Code' => [
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'UserRoles' => [
+ 'title' => 'user roles',
+ 'description' => 'The roles assigned to the user.'."\n",
+ 'example' => '',
+ '$ref' => '#/components/schemas/UserRoles',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The paging token.'."\n",
+ 'type' => 'string',
+ 'example' => 'token!',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"558D764F-8C55-49CA-BF38-80EA532FC08F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"UserRoles\\": [\\n {\\n \\"Role\\": {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n },\\n \\"GrantTime\\": 0,\\n \\"User\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"token!\\"\\n}","type":"json"}]',
+ 'title' => 'ListRoleUsers',
+ ],
+ 'ListUserRoles' => [
+ 'summary' => 'Obtains the list of data lake roles for a single user.',
+ 'path' => '/api/metastore/auth/roles/userroles',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'Used to uniquely identify a RAM user or RAM role. The OSS URL is in the following format:'."\n"
+ ."\n"
+ .'* RAM user: acs:ram::\\[accountId]:user/\\[userName].'."\n"
+ .'* RAM role: acs:ram::\\[accountId]:role/\\[roleName].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'acs:ram::1111:user/userName',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'PageSize',
+ 'description' => 'The size of each page. The maximum value is 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '-1/100',
+ ],
+ ],
+ [
+ 'name' => 'RoleNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'role name pattern filter',
+ 'description' => 'The regular expression that matches the role name. Fuzzy search is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*test.*',
+ ],
+ ],
+ [
+ 'name' => 'NextPageToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page turning token, which is used to obtain the next page of data. If not provided in the response result, a string ("") or empty string (") is empty string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token!',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Code' => [
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'UserRoles' => [
+ 'title' => 'Data',
+ 'description' => 'The roles assigned to the user.'."\n",
+ 'example' => '',
+ '$ref' => '#/components/schemas/UserRoles',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n",
+ 'type' => 'string',
+ 'example' => '2cb472ec1bf84f8d92f9c4baa0d21c19aa',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"UserRoles\\": [\\n {\\n \\"Role\\": {\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Users\\": [\\n {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n ],\\n \\"DisplayName\\": \\"显示名称，允许中文\\",\\n \\"PrincipalArn\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"IsPredefined\\": 0\\n },\\n \\"GrantTime\\": 0,\\n \\"User\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"2cb472ec1bf84f8d92f9c4baa0d21c19aa\\"\\n}","type":"json"}]',
+ 'title' => 'ListUserRoles',
+ ],
+ 'ListPermissions' => [
+ 'summary' => 'Queries permissions.',
+ 'path' => '/api/metastore/auth/permissions/list',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => '基于Principal对权限信息进行过滤',
+ 'description' => 'The principle based on which permission information is filtered.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/Principal',
+ ],
+ 'NextPageToken' => [
+ 'title' => '分页Token',
+ 'description' => 'A pagination token, which is used to obtain data on the next page. If no pagination token is returned in the response, set this parameter to an empty string ("") or an empty character (\'\').'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token!',
+ ],
+ 'PageSize' => [
+ 'title' => '分页大小',
+ 'description' => 'The number of entries to return on each page. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '100',
+ ],
+ 'Type' => [
+ 'title' => '获取权限信息的类型，目前仅支持hive',
+ 'description' => 'The type of permission information to be obtained. Only Hive is supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Hive',
+ 'enum' => [
+ 'hive',
+ ],
+ ],
+ 'MetaResource' => [
+ 'title' => '基于资源对权限信息进行过滤',
+ 'description' => 'The resource based on which permission information is filtered.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/MetaResource',
+ ],
+ 'IsListUserRolePermissions' => [
+ 'title' => '是否获取用户所属角色的权限',
+ 'description' => 'Specifies whether to obtain the permissions of the role to which the user belongs. This parameter takes effect only when you specify a specific resource object.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ 'MetaResourceType' => [
+ 'title' => '基于Resource Type进行过滤',
+ 'description' => 'The type of the resource based on which permission information is filtered, such as database or table. If you do not specify this parameter, permission information is filtered based on both databases and tables.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DATABASE',
+ ],
+ 'CatalogId' => [
+ 'title' => 'CatalogId',
+ 'description' => 'The catalog ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message Code',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '745EAAE2-5010-5C9F-A95C-B8FC5C1B03BF',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'NextPageToken' => [
+ 'title' => 'NextPageToken',
+ 'description' => 'The page turning token, which is used to obtain the next page of data.'."\n",
+ 'type' => 'string',
+ 'example' => 'token!',
+ ],
+ 'TotalCount' => [
+ 'title' => 'TotalCount',
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '',
+ ],
+ 'PrincipalResourcePermissionsList' => [
+ 'description' => 'The permissions.'."\n",
+ 'example' => '[]',
+ '$ref' => '#/components/schemas/PrincipalResourcePermissionsList',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"745EAAE2-5010-5C9F-A95C-B8FC5C1B03BF\\",\\n \\"Success\\": true,\\n \\"NextPageToken\\": \\"token!\\",\\n \\"TotalCount\\": 0,\\n \\"PrincipalResourcePermissionsList\\": [\\n {\\n \\"Principal\\": {\\n \\"PrincipalArn\\": \\"acs:ram::[AliyunAccountId]:user/username_abc\\"\\n },\\n \\"MetaResource\\": {\\n \\"ResourceType\\": \\"TABLE\\",\\n \\"CatalogResource\\": {\\n \\"CatalogId\\": \\"\\"\\n },\\n \\"DatabaseResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"DatabaseWildcard\\": \\"\\"\\n },\\n \\"TableResource\\": {\\n \\"DatabaseName\\": \\"\\",\\n \\"TableName\\": \\"\\"\\n },\\n \\"FunctionResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"FunctionName\\": \\"default\\"\\n },\\n \\"ColumnResource\\": {\\n \\"DatabaseName\\": \\"default\\",\\n \\"TableName\\": \\"test\\",\\n \\"ColumnNames\\": [\\n \\"name\\"\\n ]\\n }\\n },\\n \\"Accesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ],\\n \\"DelegateAccesses\\": [\\n \\"ALTER/SELECT/CREATE, etc.\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListPermissions',
+ ],
+ 'CheckPermissions' => [
+ 'summary' => 'Verify user permissions.',
+ 'path' => '/api/metastore/auth/permissions/check',
+ 'methods' => [
+ 'post',
+ ],
+ '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 HTTP request body, in the JSON format.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/AccessRequest',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response Object',
+ 'description' => 'Returns the message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Response Code',
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message Code',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '81B90E1B-7514-5817-9D59-0EA9E2215876',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"81B90E1B-7514-5817-9D59-0EA9E2215876\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CheckPermissions',
+ ],
+ 'GetCatalogSettings' => [
+ 'summary' => 'To obtain the configurations of Data Lake Catalog, you must assume the admin role or above.',
+ 'path' => '/api/metastore/catalogs/settings',
+ 'methods' => [
+ 'get',
+ ],
+ '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 ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The response message.'."\n",
+ 'type' => 'string',
+ 'example' => '.',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'CatalogSettings' => [
+ 'description' => 'The data lake configurations.'."\n",
+ '$ref' => '#/components/schemas/CatalogSettings',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\".\\",\\n \\"Success\\": true,\\n \\"CatalogSettings\\": {\\n \\"Config\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'GetCatalogSettings',
+ ],
+ 'GetQueryResult' => [
+ 'summary' => 'Obtains the results of a data exploration query.',
+ 'path' => '/webapi/query/getQueryResult',
+ 'methods' => [
+ 'get',
+ ],
+ '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"
+ .'> You can call the SubmitQuery operation to query the query ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'Q-41676378709440CE',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The size of each page. The maximum value is 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Obtain the query result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The query status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* AVAILABLE'."\n"
+ .'* CANCELLED: The has canceled.'."\n"
+ .'* RUNNING: The is running.'."\n"
+ .'* CANCELLING: The is being canceled.'."\n"
+ .'* WAITING: The is waiting for.'."\n"
+ .'* ERROR',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'AVAILABLE' => 'AVAILABLE',
+ 'CANCELLED' => 'CANCELLED',
+ 'RUNNING' => 'RUNNING',
+ 'CANCELLING' => 'CANCELLING',
+ 'WAITING' => 'WAITING',
+ 'ERROR' => 'ERROR',
+ ],
+ 'example' => 'AVAILABLE',
+ ],
+ 'ResultTmpTable' => [
+ 'description' => 'The result temporary table, which is not available.'."\n",
+ 'type' => 'string',
+ 'example' => 'table',
+ ],
+ 'Owner' => [
+ 'description' => 'The uid of the primary account of the creator.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '229167306180609***',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message of the query.'."\n",
+ 'type' => 'string',
+ 'example' => 'Table or view not found:',
+ ],
+ 'Progress' => [
+ 'description' => 'The progress of the query. The value ranges from 0 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '99',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Schema' => [
+ 'description' => 'The header field and type of the query result. This parameter is returned only when the status is AVAILABLE.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"name":"id","type":"INT"},{"name":"student_name","type":"VARCHAR"}]',
+ ],
+ 'ResultTmpDb' => [
+ 'description' => 'The result temporary library is not available.'."\n",
+ 'type' => 'string',
+ 'example' => 'db'."\n",
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the query result was updated.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-05-09 16:19:09',
+ ],
+ 'JobCompleted' => [
+ 'description' => 'Whether the query has been completed. false indicates that you need to continue polling this interface.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RowCount' => [
+ 'description' => 'The total number of rows in the result. This parameter is returned only when the status is AVAILABLE.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'RegionId' => [
+ 'description' => 'The region ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the query was completed.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-05-09 16:19:09',
+ ],
+ 'StartTime' => [
+ 'description' => 'The point in time when the query was initiated.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-05-09 16:18:09',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1D2BCFBA-7639-59A9-817B-944EC1339279',
+ ],
+ 'Rows' => [
+ 'description' => 'The returned result. This value is returned only when the status is AVAILABLE. The content is represented as a two-dimensional JSON array.'."\n",
+ 'type' => 'string',
+ 'example' => '[[10,"Tom"],[11,"Jerry"]]',
+ ],
+ 'Logs' => [
+ 'description' => 'Run logs.'."\n",
+ 'type' => 'string',
+ 'example' => '["this is log"]',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the query was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-05-09 16:18:09',
+ ],
+ 'Duration' => [
+ 'description' => 'up time in milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '8000',
+ ],
+ 'Sql' => [
+ 'description' => 'The original SQL statement.'."\n",
+ 'type' => 'string',
+ 'example' => 'select * from db.student',
+ ],
+ 'RowCountOverLimit' => [
+ 'description' => 'Whether the total number of rows in the result exceeds the maximum value.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Id' => [
+ 'description' => 'The query ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'Q-41676378709440CE'."\n",
+ ],
+ 'TotalBytesProcessed' => [
+ 'description' => 'The total amount of data scanned. Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1024',
+ ],
+ ],
+ 'example' => '{ "data" : }',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Query.ResultExpired',
+ 'errorMessage' => 'Query result cache expired, please export result in history query',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"ResultTmpTable\\": \\"table\\",\\n \\"Owner\\": 0,\\n \\"ErrorMessage\\": \\"Table or view not found:\\",\\n \\"Progress\\": 99,\\n \\"Success\\": true,\\n \\"Schema\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"type\\\\\\":\\\\\\"INT\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"student_name\\\\\\",\\\\\\"type\\\\\\":\\\\\\"VARCHAR\\\\\\"}]\\",\\n \\"ResultTmpDb\\": \\"db\\\\n\\",\\n \\"GmtModified\\": \\"2022-05-09 16:19:09\\",\\n \\"JobCompleted\\": true,\\n \\"RowCount\\": 100,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EndTime\\": \\"2022-05-09 16:19:09\\",\\n \\"StartTime\\": \\"2022-05-09 16:18:09\\",\\n \\"RequestId\\": \\"1D2BCFBA-7639-59A9-817B-944EC1339279\\",\\n \\"Rows\\": \\"[[10,\\\\\\"Tom\\\\\\"],[11,\\\\\\"Jerry\\\\\\"]]\\",\\n \\"Logs\\": \\"[\\\\\\"this is log\\\\\\"]\\",\\n \\"GmtCreate\\": \\"2022-05-09 16:18:09\\",\\n \\"Duration\\": 8000,\\n \\"Sql\\": \\"select * from db.student\\",\\n \\"RowCountOverLimit\\": false,\\n \\"Id\\": \\"Q-41676378709440CE\\\\n\\",\\n \\"TotalBytesProcessed\\": 1024\\n}","type":"json"}]',
+ 'title' => 'GetQueryResult',
+ ],
+ 'SubmitQuery' => [
+ 'summary' => 'Submit an SQL query task.',
+ 'path' => '/webapi/query/submitQueryRequestBody',
+ 'methods' => [
+ 'post',
+ ],
+ '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.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'sql' => [
+ 'description' => 'The SQL statement.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'show databases',
+ ],
+ 'workspaceId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'WS-A129E61C4892D2B4',
+ ],
+ 'catalogId' => [
+ 'description' => 'The ID of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'catalog1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Create the results of the query.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The data returned'."\n",
+ 'type' => 'string',
+ 'example' => 'Q-14475CF9B51FCE5E',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '279AA630-A8ED-5EA9-80A3-2E213D63548C',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'example' => '{ "success" : true }',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Query.ClusterNotReady',
+ 'errorMessage' => 'Query cluster is not ready. Please try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"Q-14475CF9B51FCE5E\\",\\n \\"RequestId\\": \\"279AA630-A8ED-5EA9-80A3-2E213D63548C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'SubmitQuery',
+ 'description' => '* Only suitable for submitting small and medium-sized queries. The execution time cannot exceed 1 hour.'."\n"
+ .'* A maximum of 10000 query results can be returned.'."\n"
+ .'* There are limits on concurrent execution under a single master account. If multiple queries are submitted at the same time, they will be queued.'."\n",
+ ],
+ 'CancelQuery' => [
+ 'summary' => 'Cancel a query request.',
+ 'path' => '/webapi/query/cancelQuery',
+ 'methods' => [
+ 'post',
+ ],
+ '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"
+ .'> You can call the SubmitQuery operation to query the query ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'Q-BCA5E96CB84BB8B8',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Query ID'."\n",
+ 'type' => 'string',
+ 'example' => 'Q-BCA5E96CB84BB8B8',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"Q-BCA5E96CB84BB8B8\\",\\n \\"RequestId\\": \\"DB07AAE9-4B88-5DEA-8F1D-4D1A9A864A85\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CancelQuery',
+ ],
+ 'GetRegionStatus' => [
+ 'summary' => 'You can Data Lake Formation the activation status of the service in the specified region.',
+ 'path' => '/webapi/service/getRegionStatus',
+ 'methods' => [
+ 'get',
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ 'title' => 'RegionId',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The result of the request.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'CC58A776-0662-5C6D-B467-FFD4CF7F4C40',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsDlfServiceOpen' => [
+ 'description' => 'Whether the DLF service is activated'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'RegionStatus' => [
+ 'description' => 'The status of the region. SERVICE_INVALID: The service is unavailable. UNITITIALIZED: Not initialized. READY: Normal.'."\n",
+ 'type' => 'string',
+ 'example' => 'READY',
+ ],
+ 'AccountStatus' => [
+ 'description' => 'Account status enabled or disabled'."\n",
+ 'type' => 'string',
+ 'example' => 'enabled',
+ ],
+ 'IsDependencyReady' => [
+ 'description' => 'Whether the dependency is ready'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RegionId' => [
+ 'description' => 'region id'."\n",
+ 'type' => 'string',
+ 'example' => 'cn_hangzhou',
+ ],
+ ],
+ 'example' => '{\'RegionId\': \'cn-shanghai\', \'RegionStatus\': \'SERVICE_INVALID\', \'AccountStatus\': \'\', \'IsDlfServiceOpen\': False}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": \\"true\\",\\n \\"RequestId\\": \\"CC58A776-0662-5C6D-B467-FFD4CF7F4C40\\",\\n \\"Data\\": {\\n \\"IsDlfServiceOpen\\": true,\\n \\"RegionStatus\\": \\"READY\\",\\n \\"AccountStatus\\": \\"enabled\\",\\n \\"IsDependencyReady\\": true,\\n \\"RegionId\\": \\"cn_hangzhou\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetRegionStatus',
+ ],
+ 'GetServiceStatus' => [
+ 'summary' => 'Obtains the service activation status of a Data Lake Formation user.',
+ 'path' => '/webapi/service/getServiceStatus',
+ 'methods' => [
+ 'get',
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ 'title' => 'RegionId',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the test feature is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Data' => [
+ 'description' => 'Service status'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsDlfServiceOpen' => [
+ 'description' => 'Whether the DLF service is activated'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'HasRamPermissions' => [
+ 'description' => 'Whether to complete RAM authorization'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'IsOssOpen' => [
+ 'description' => 'Whether the OSS service is enabled'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'example' => '{ "AccountStatus":"", "RegionStatus":"READY", "RegionId":"cn-shanghai", "IsDependencyReady":true, "IsDlfServiceOpen":true }',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Data\\": {\\n \\"IsDlfServiceOpen\\": true,\\n \\"HasRamPermissions\\": true,\\n \\"IsOssOpen\\": true\\n }\\n}","type":"json"}]',
+ 'title' => 'GetServiceStatus',
+ ],
+ 'DescribeRegions' => [
+ 'summary' => 'Obtains the list of open regions.',
+ 'path' => '/webapi/service/describeRegions',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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 test feature is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7F4B621-E41E-4C84-B97F-42B5380A32BB',
+ ],
+ 'Regions' => [
+ 'description' => 'The region list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The region.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type.'."\n",
+ 'type' => 'string',
+ 'example' => 'region',
+ ],
+ 'ShowName' => [
+ 'description' => 'The display name.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the data.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the filtering table.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B7F4B621-E41E-4C84-B97F-42B5380A32BB\\",\\n \\"Regions\\": [\\n {\\n \\"Type\\": \\"region\\",\\n \\"ShowName\\": \\"华东1（杭州）\\",\\n \\"Name\\": \\"cn-hangzhou\\",\\n \\"Description\\": \\"华东1\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeRegions',
+ ],
+ 'SearchAcrossCatalog' => [
+ 'summary' => 'Search across catalogs for content such as libraries, tables, and fields.',
+ 'path' => '/api/metastore/catalogs/search/search-across-catalog',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'A short description of struct',
+ 'description' => 'A short description of struct'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SearchText' => [
+ 'title' => '搜索问题',
+ 'description' => 'The search text.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'tags:tag1 or comment:^iso and name=aliyun and (createTime > "20211111" and createTime < "20211117") and has category',
+ ],
+ 'SortCriteria' => [
+ 'title' => '排序结构',
+ 'description' => 'The sorting rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The sorting rule.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/SortCriterion',
+ ],
+ 'required' => false,
+ ],
+ 'PageSize' => [
+ 'title' => '当前查询的页大小',
+ 'description' => 'The number of entries on the queried page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1000',
+ ],
+ 'PageNumber' => [
+ 'title' => '当前查询的页号',
+ 'description' => 'The page number of the queried page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'CatalogIds' => [
+ 'title' => 'CatalogId数组，为空则搜索所有Catalog',
+ 'description' => 'The catalog IDs. If this parameter is empty, all catalogs are queried.'."\n",
+ 'required' => false,
+ 'enumValueTitles' => [],
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ 'SearchTypes' => [
+ 'title' => 'SearchTypes数组，可选值为ALL/CATALOG/DATABASE/TABLE',
+ 'description' => 'The search types. Valid values: ALL, CATALOG, DATABASE, and TABLE.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/ListString',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => '响应代码',
+ 'description' => 'The response code.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Message' => [
+ 'title' => '响应消息',
+ 'description' => 'Response'."\n",
+ 'type' => 'string',
+ 'example' => '""',
+ ],
+ 'RequestId' => [
+ 'title' => '请求ID',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '460C862F-BB91-5C04-BC3F-946EEF467862',
+ ],
+ 'Success' => [
+ 'title' => '是否成功',
+ 'description' => 'Indicates whether the information about the service was queried.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'DatabaseResult' => [
+ 'title' => '返回的db结果',
+ 'description' => 'The returned database information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Databases' => [
+ 'title' => '返回的DatabaseList',
+ 'description' => 'The returned databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The database information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Database' => [
+ 'title' => '返回的Database',
+ 'description' => 'The returned database.'."\n",
+ '$ref' => '#/components/schemas/Database',
+ ],
+ 'HighLightList' => [
+ 'title' => '返回高亮文本',
+ 'description' => 'The returned highlighted text.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned highlighted text.'."\n",
+ '$ref' => '#/components/schemas/HighLight',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'title' => '满足匹配条件的总的Database个数',
+ 'description' => 'Total number of databases that meet the match conditions'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11000',
+ ],
+ ],
+ ],
+ 'TableResult' => [
+ 'title' => '返回的table result',
+ 'description' => 'The returned table information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Tables' => [
+ 'title' => '返回的TableList',
+ 'description' => 'The returned tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Table' => [
+ 'title' => '返回的Table',
+ 'description' => 'The returned table.'."\n",
+ '$ref' => '#/components/schemas/Table',
+ ],
+ 'HighLightList' => [
+ 'title' => '返回的高亮文本',
+ 'description' => 'The returned highlighted text.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned highlighted text.'."\n",
+ '$ref' => '#/components/schemas/HighLight',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'title' => '满足匹配条件的总的Table个数',
+ 'description' => 'The total number of tables that meet the match conditions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1100',
+ ],
+ ],
+ ],
+ 'CatalogResult' => [
+ 'title' => '返回的Catalog result',
+ 'description' => 'The returned catalog information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Catalogs' => [
+ 'description' => 'The returned catalogs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The catalog details.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Catalog' => [
+ 'description' => 'The returned catalog.'."\n",
+ '$ref' => '#/components/schemas/Catalog',
+ ],
+ 'HighLightList' => [
+ 'description' => 'The returned highlighted text.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned highlighted text.'."\n",
+ '$ref' => '#/components/schemas/HighLight',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'title' => '满足匹配条件的总的Catalog个数',
+ 'description' => 'Total number of catalogs that meet the match conditions'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"460C862F-BB91-5C04-BC3F-946EEF467862\\",\\n \\"Success\\": true,\\n \\"DatabaseResult\\": {\\n \\"Databases\\": [\\n {\\n \\"Database\\": {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"oss://examplebuket/exampledb\\",\\n \\"Name\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Privileges\\": {\\n \\"GroupPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"RolePrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserPrivileges\\": {\\n \\"key\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"GrantOption\\": true,\\n \\"Grantor\\": \\"\\",\\n \\"GrantorType\\": \\"\\",\\n \\"Privilege\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"UpdateTime\\": 0,\\n \\"CreatedBy\\": \\"\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 11000\\n },\\n \\"TableResult\\": {\\n \\"Tables\\": [\\n {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Privileges\\": {},\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"Table\\": {\\n \\"Cascade\\": true,\\n \\"CreateTime\\": 0,\\n \\"CreatedBy\\": \\"\\",\\n \\"DatabaseName\\": \\"\\",\\n \\"LastAccessTime\\": 0,\\n \\"LastAnalyzedTime\\": 0,\\n \\"Owner\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"PartitionKeys\\": [],\\n \\"Retention\\": 0,\\n \\"RewriteEnabled\\": true,\\n \\"Sd\\": {\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"Cols\\": [],\\n \\"Compressed\\": true,\\n \\"InputFormat\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"NumBuckets\\": 0,\\n \\"OutputFormat\\": \\"\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"\\",\\n \\"SerializationLib\\": \\"\\"\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ]\\n },\\n \\"SortCols\\": [\\n {\\n \\"Col\\": \\"\\",\\n \\"Order\\": 0\\n }\\n ],\\n \\"StoredAsSubDirectories\\": true\\n },\\n \\"TableName\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Temporary\\": true,\\n \\"UpdateTime\\": 0,\\n \\"ViewExpandedText\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableId\\": \\"59c6c8fefeaa46d8b599c1f790c59a19\\",\\n \\"TableVersion\\": {\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"VersionId\\": 0\\n }\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1100\\n },\\n \\"CatalogResult\\": {\\n \\"Catalogs\\": [\\n {\\n \\"Catalog\\": {\\n \\"CatalogId\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"LocationUri\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"CreatedBy\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CatalogType\\": \\"\\",\\n \\"DefaultCatalog\\": true,\\n \\"ThriftEnabled\\": true,\\n \\"JdbcEnabled\\": true,\\n \\"StorageAccessConfig\\": \\"\\"\\n },\\n \\"HighLightList\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"<em>tab</em>2\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100\\n }\\n}","type":"json"}]',
+ 'title' => 'SearchAcrossCatalog',
+ ],
+ 'RegisterLocation' => [
+ 'summary' => 'Register the OSS path to be managed by DLF.',
+ 'path' => '/webapi/locations',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => 'HTTP'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Location' => [
+ 'description' => 'Registered OSS path'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'oss://mybucket/',
+ ],
+ 'RoleName' => [
+ 'description' => 'RAM role name'."\n"
+ ."\n"
+ .'> Data Lake Formation read and write data in the OSS path. If you want to AliyunDLFWorkFlowDefaultRole a role, the role is automatically built in to the role. Alternatively, you can create a custom role, but you must manually ensure that the role has the read and write permissions on the corresponding path.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'AliyunDLFWorkFlowDefaultRole',
+ ],
+ 'InventoryCollectEnabled' => [
+ 'description' => 'Whether to enable OSS bucket inventory'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'OssLogCollectEnabled' => [
+ 'description' => 'Whether to enable OSS log storage'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The registration results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '3C2678BA-3451-14C3-90E2-D4EF5B4E7A84',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'LocationId' => [
+ 'description' => 'Location ID'."\n",
+ 'type' => 'string',
+ 'example' => 'LOC-AB8FBC17F95A4AF5',
+ ],
+ 'StorageCollectTaskOperationResultList' => [
+ 'description' => 'The list of collection tasks that are enabled.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The collection task that is enabled.',
+ '$ref' => '#/components/schemas/StorageCollectTaskOperationResult',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C2678BA-3451-14C3-90E2-D4EF5B4E7A84\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": true,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'RegisterLocation',
+ ],
+ 'DeregisterLocation' => [
+ 'summary' => 'Cancel Location registration.',
+ 'path' => '/webapi/locations',
+ 'methods' => [
+ 'delete',
+ ],
+ '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' => 'Location ID'."\n"
+ ."\n"
+ .'> You can call the RegisterLocation operation to obtain the Location ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'LOC-AB8FBC17F95A4AF5',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Deregister the location.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E47920CD-BAE6-1305-88DF-FBDD3D300845',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'Response parameters'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'LocationId' => [
+ 'description' => 'Location ID'."\n",
+ 'type' => 'string',
+ 'example' => 'LOC-AB8FBC17F95A4AF5',
+ ],
+ 'StorageCollectTaskOperationResultList' => [
+ 'description' => 'The list of the collection tasks that are disabled.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The collection task that is disabled.',
+ '$ref' => '#/components/schemas/StorageCollectTaskOperationResult',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E47920CD-BAE6-1305-88DF-FBDD3D300845\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": true,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DeregisterLocation',
+ ],
+ 'UpdateRegisteredLocation' => [
+ 'summary' => 'Edit a Registered Location.',
+ 'path' => '/webapi/locations',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => 'HTTP'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'LocationId' => [
+ 'description' => 'Location ID'."\n"
+ ."\n"
+ .'> You can call the RegisterLocation operation to obtain the Location ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'LOC-AB8FBC17F95A4AF5',
+ ],
+ 'InventoryCollectEnabled' => [
+ 'description' => 'Whether to enable OSS bucket inventory'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ 'OssLogCollectEnabled' => [
+ 'description' => 'Whether to enable OSS log storage'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The result of location edit operation.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '8030C902-C25B-1839-867D-E6F70A5B9810',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'LocationId' => [
+ 'description' => 'Location ID'."\n",
+ 'type' => 'string',
+ 'example' => 'LOC-AB8FBC17F95A4AF5',
+ ],
+ 'StorageCollectTaskOperationResultList' => [
+ 'description' => 'The list of collection tasks that are updated.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The collection task that is updated.'."\n",
+ '$ref' => '#/components/schemas/StorageCollectTaskOperationResult',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8030C902-C25B-1839-867D-E6F70A5B9810\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LocationId\\": \\"LOC-AB8FBC17F95A4AF5\\",\\n \\"StorageCollectTaskOperationResultList\\": [\\n {\\n \\"Success\\": true,\\n \\"TaskId\\": \\"\\",\\n \\"TaskType\\": \\"\\",\\n \\"DlfCreated\\": true,\\n \\"ErrCode\\": \\"\\",\\n \\"ErrMessage\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateRegisteredLocation',
+ ],
+ 'ListPartitionsByExpr' => [
+ 'summary' => 'Obtains a list of data table partitions in the data lake and queries them by condition.',
+ 'path' => '/api/metastore/catalogs/databases/tables/partitions/listbyexpr',
+ 'methods' => [
+ 'post',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ 'title' => 'ListPartitionsByExpr',
+ 'description' => 'You cannot specify expr to filter partitions. Currently, you need to call the listpartitionsbyfilter to complete the corresponding function.'."\n",
+ 'responseParamsDescription' => '* code: error code'."\n"
+ .'* message: the error message.'."\n"
+ .'* requestId: the unique ID of the current request.'."\n"
+ .'* Success:true/false to determine whether the request is successful.'."\n",
+ ],
+ 'GetDatabaseProfile' => [
+ 'summary' => 'Gets the details of the database data profile.',
+ 'path' => '/webapi/metastorehouse/catalog/database/databaseprofile',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory. By default, the ID of the primary account is entered.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371'."\n",
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '530_db',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => '-',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DatabaseProfile' => [
+ 'description' => 'The data profile of the database.'."\n",
+ 'example' => '{'."\n"
+ .' "FileCnt": 213,'."\n"
+ .' "FileSize": 34324'."\n"
+ .'}',
+ '$ref' => '#/components/schemas/DatabaseProfile',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB\\",\\n \\"Success\\": true,\\n \\"DatabaseProfile\\": {\\n \\"FileCnt\\": 0,\\n \\"FileSize\\": 0,\\n \\"Name\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"ObjectSize\\": 0,\\n \\"ObjectCnt\\": 0,\\n \\"LatestDate\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDatabaseProfileResponse>\\n <RequestId>AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB</RequestId>\\n <Success>true</Success>\\n <DatabaseProfile>\\n <FileCnt>3234</FileCnt>\\n <FileSize>1254312</FileSize>\\n <Name>test_db</Name>\\n <CreateTime>2023-08-16 18:02:22</CreateTime>\\n <Location>oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/</Location>\\n <ObjectSize>1254312</ObjectSize>\\n <ObjectCnt>3234</ObjectCnt>\\n <LatestDate>2023-08-30 19:16:10</LatestDate>\\n </DatabaseProfile>\\n</GetDatabaseProfileResponse>","errorExample":""}]',
+ 'title' => 'GetDatabaseProfile',
+ 'description' => 'To use a data profile, you must first host the OSS bucket of the database.'."\n",
+ ],
+ 'GetLifecycleRule' => [
+ 'summary' => 'Obtains the lifecycle rules of a database and table.',
+ 'path' => '/webapi/metastorehouse/lifecycle/rule/getLifecycleRule',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'DatabaseName',
+ 'description' => 'The name of the resource, which is a string that consists of the data directory, database, and table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'demo_catalog_id.demo_db_name.demo_table_name',
+ ],
+ ],
+ [
+ 'name' => 'BizId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The business ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'LCRU-17E7192705C365C0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'The returned message body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'EDBC848F-7CC7-52E3-9FBF-924D09B5C27A',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the lifecycle rule.'."\n",
+ '$ref' => '#/components/schemas/LifecycleRule',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBC848F-7CC7-52E3-9FBF-924D09B5C27A\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BizId\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ResourceType\\": \\"\\",\\n \\"BindCount\\": 0,\\n \\"Description\\": \\"\\",\\n \\"RuleType\\": \\"\\",\\n \\"Config\\": \\"\\",\\n \\"IaDays\\": 0,\\n \\"ArchiveDays\\": 0,\\n \\"ColdArchiveDays\\": 0,\\n \\"ScheduleStatus\\": \\"\\",\\n \\"Workflow\\": {\\n \\"LatestInstanceId\\": \\"\\",\\n \\"LatestInstanceStatus\\": \\"\\",\\n \\"LatestStartTime\\": \\"\\",\\n \\"LatestEndTime\\": \\"\\"\\n },\\n \\"WorkflowId\\": \\"\\",\\n \\"WorkflowInstance\\": {\\n \\"DlfWorkflowId\\": \\"\\",\\n \\"ExternalInstanceId\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"Status\\": \\"\\",\\n \\"RuntimeLogs\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"InstanceId\\": \\"\\",\\n \\"BizTime\\": \\"\\",\\n \\"LogType\\": \\"\\",\\n \\"LogId\\": \\"\\",\\n \\"LogSummary\\": \\"\\",\\n \\"LogContent\\": \\"\\"\\n }\\n ],\\n \\"BatchProgress\\": 0\\n },\\n \\"CatalogId\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetLifecycleRule',
+ ],
+ 'ListPartitionsProfile' => [
+ 'summary' => 'Obtains the details of a partition data profile.',
+ 'path' => '/webapi/metastorehouse/catalog/database/tableprofile/partitionprofile/listPartitionsProfile',
+ 'methods' => [
+ 'get',
+ ],
+ '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' => 'CatalogId',
+ 'description' => 'The ID of the data directory. By default, the ID of the primary account is entered.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1344371',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DatabaseName',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Page number'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PartitionNames',
+ 'in' => 'query',
+ 'style' => 'simple',
+ 'schema' => [
+ 'description' => 'The names of partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the partition.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'year=3/month=1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Response',
+ 'description' => 'Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => 'Code',
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '-',
+ ],
+ 'Message' => [
+ 'title' => 'Message',
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => '-',
+ ],
+ 'RequestId' => [
+ 'title' => 'RequestId',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '97434FA4-A6B2-1AE4-A174-76964F29C759',
+ ],
+ 'Success' => [
+ 'title' => 'Success',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Total' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'Data' => [
+ 'description' => 'The partition data profiles.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition data profile.'."\n",
+ '$ref' => '#/components/schemas/PartitionProfile',
+ ],
+ ],
+ 'LatestDate' => [
+ 'description' => 'The time when the metadata warehouse was updated.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-08-30 19:16:10',
+ ],
+ 'LatestAccessNumDate' => [
+ 'description' => 'The time when the access frequency is updated. This parameter is obsolete.'."\n",
+ 'type' => 'string',
+ 'example' => '-',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"-\\",\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"97434FA4-A6B2-1AE4-A174-76964F29C759\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"DatabaseName\\": \\"test_db\\",\\n \\"TableName\\": \\"test_tbl\\",\\n \\"PartitionName\\": \\"year=2023/month=1\\",\\n \\"ArchiveStatus\\": \\"STANDARD\\",\\n \\"CreateTime\\": \\"2023-08-16 18:02:22\\",\\n \\"LastModifyTime\\": \\"2023-08-16 18:02:25\\",\\n \\"LastAccessTime\\": \\"2023-08-22 12:14:42\\",\\n \\"LastAccessNumTime\\": \\"\\",\\n \\"Location\\": \\"oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1\\",\\n \\"FileSize\\": 13,\\n \\"ObjectSize\\": 13,\\n \\"FileCnt\\": 1,\\n \\"ObjectCnt\\": 1,\\n \\"AccessNum\\": 0,\\n \\"AccessNumWeekly\\": 0,\\n \\"AccessNumMonthly\\": 0,\\n \\"ObjectAccessNum\\": 0,\\n \\"ObjectAccessNumWeekly\\": 4,\\n \\"ObjectAccessNumMonthly\\": 4,\\n \\"DataSourceType\\": \\"OSS_HDFS\\"\\n }\\n ],\\n \\"LatestDate\\": \\"2023-08-30 19:16:10\\",\\n \\"LatestAccessNumDate\\": \\"-\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPartitionsProfileResponse>\\n <Code>-</Code>\\n <Message>-</Message>\\n <RequestId>97434FA4-A6B2-1AE4-A174-76964F29C759</RequestId>\\n <Success>true</Success>\\n <Total>1</Total>\\n <Data>\\n <DatabaseName>test_db</DatabaseName>\\n <TableName>test_tbl</TableName>\\n <PartitionName>year=2023/month=1</PartitionName>\\n <ArchiveStatus>STANDARD</ArchiveStatus>\\n <CreateTime>2023-08-16 18:02:22</CreateTime>\\n <LastModifyTime>2023-08-16 18:02:25</LastModifyTime>\\n <LastAccessTime>2023-08-22 12:14:42</LastAccessTime>\\n <Location>oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_tb/test_tbl/year=2023/month=1</Location>\\n <FileSize>13</FileSize>\\n <ObjectSize>13</ObjectSize>\\n <FileCnt>1</FileCnt>\\n <ObjectCnt>1</ObjectCnt>\\n <ObjectAccessNum>0</ObjectAccessNum>\\n <ObjectAccessNumWeekly>4</ObjectAccessNumWeekly>\\n <ObjectAccessNumMonthly>4</ObjectAccessNumMonthly>\\n <DataSourceType>OSS_HDFS</DataSourceType>\\n </Data>\\n <LatestDate>2023-08-30 19:16:10</LatestDate>\\n</ListPartitionsProfileResponse>","errorExample":""}]',
+ 'title' => 'ListPartitionsProfile',
+ 'description' => 'To use a data profile, you must first host the OSS bucket of the table.'."\n",
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'dlf.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'dlf.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'dlf.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'dlf.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'dlf.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'dlf.eu-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou',
+ 'endpoint' => 'dlf.cn-zhangjiakou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'dlf.us-east-1.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 15:37:37 +0000