diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/openanalytics-open/2020-09-28 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/openanalytics-open/2020-09-28')
| -rw-r--r-- | data/zh_cn/openanalytics-open/2020-09-28/api-docs.php | 1253 |
1 files changed, 1253 insertions, 0 deletions
diff --git a/data/zh_cn/openanalytics-open/2020-09-28/api-docs.php b/data/zh_cn/openanalytics-open/2020-09-28/api-docs.php new file mode 100644 index 0000000..d1ce0e7 --- /dev/null +++ b/data/zh_cn/openanalytics-open/2020-09-28/api-docs.php @@ -0,0 +1,1253 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'openanalytics-open', + 'version' => '2020-09-28', + ], + 'directories' => [ + [ + 'id' => 66508, + 'title' => '元数据', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 66512, + 'title' => '数据库管理', + 'type' => 'directory', + 'children' => [ + 'CreateDatabase', + 'GetAllDatabases', + ], + ], + [ + 'id' => 66518, + 'title' => '分区管理', + 'type' => 'directory', + 'children' => [ + 'AddPartitions', + ], + ], + [ + 'id' => 66523, + 'title' => '表管理', + 'type' => 'directory', + 'children' => [ + 'GetTable', + 'GetAllTables', + 'DropTable', + ], + ], + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'DatabaseModel' => [ + 'title' => '数据库结构', + 'description' => ' 数据库数据结构', + 'type' => 'object', + 'properties' => [ + 'DBId' => [ + 'title' => '数据库 ID', + 'type' => 'string', + ], + 'TenantId' => [ + 'title' => '数据库所属的阿里云UID ', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '数据库名称', + 'type' => 'string', + ], + 'LocationURI ' => [ + 'title' => '数据库地址', + 'type' => 'string', + ], + 'Description' => [ + 'title' => '数据库描述 ', + 'type' => 'string', + ], + 'Parameters' => [ + 'title' => '数据库参数 ', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'OwnerName' => [ + 'title' => '数据库所属 DLA userName ', + 'type' => 'string', + ], + 'OwnerType' => [ + 'title' => '数据库所属用户类型', + 'type' => 'string', + ], + 'CatalogType' => [ + 'title' => '数据库类型', + 'type' => 'string', + ], + ], + ], + 'FieldSchemaModel' => [ + 'title' => '列 数据结构', + 'description' => '列 数据结构', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '列名', + 'type' => 'string', + ], + 'Type' => [ + 'title' => '列的数据类型', + 'type' => 'string', + ], + 'Comment' => [ + 'title' => '列的描述信息', + 'type' => 'string', + ], + 'SchemaName' => [ + 'title' => '对应的数据库名', + 'type' => 'string', + ], + 'TableName' => [ + 'title' => '对应的表名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射名称', + 'type' => 'string', + ], + 'DataType' => [ + 'title' => '数据的类型', + 'type' => 'string', + ], + 'IsPrimaryKey' => [ + 'title' => '是否为主键', + 'type' => 'boolean', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + ], + ' PkPosition' => [ + 'title' => '主键位置', + 'type' => 'integer', + 'format' => 'int32', + ], + 'IsPartitionKey' => [ + 'title' => '是否为分区字段', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateDatabase' => [ + 'summary' => '创建数据库。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '创建数据库的名字', + 'description' => '数据库的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'db001', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库描述', + 'description' => '数据库的描述。', + 'type' => 'string', + 'required' => true, + 'example' => 'this is db description', + ], + ], + [ + 'name' => 'LocationUri', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库的 location', + 'description' => '数据库的OSS地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://data/xxx', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '数据库属性', + 'description' => '数据库的属性。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '数据库的属性。', + 'example' => 'key001=value001', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回值主题', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '如果后端处理出现错误,则表示错误的类型', + 'description' => '标记错误的Code。', + 'type' => 'string', + 'example' => 'ALREADY_EXISTS', + ], + 'Data' => [ + 'title' => '成功创建库的库ID', + 'description' => '表示创建成功时数据库的id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6666', + ], + 'Message' => [ + 'title' => '如果后端处理出现错误,则表示错误的信息', + 'description' => '如果有异常,返回异常的信息。', + 'type' => 'string', + 'example' => 'Database db001 already exists', + ], + 'RequestId' => [ + 'title' => '请求的 ID', + 'description' => '本次请求的RequestId。', + 'type' => 'string', + 'example' => '9BEAC206-0795-4DE3-B1FD-964BEF432B23', + ], + 'Success' => [ + 'title' => '标识本次请求是否成功', + 'description' => '标记本次请求是否成功。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"ALREADY_EXISTS\\",\\n \\"Data\\": 6666,\\n \\"Message\\": \\"Database db001 already exists\\",\\n \\"RequestId\\": \\"9BEAC206-0795-4DE3-B1FD-964BEF432B23\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<Message>Database db001 already exists</Message>\\n<RequestId>9BEAC206-0795-4DE3-B1FD-964BEF432B23</RequestId>\\n<Data>6666</Data>\\n<Code>ALREADY_EXISTS</Code>\\n<Success>false</Success>","errorExample":""}]', + 'title' => '创建一个新的数据库实例', + ], + 'GetAllDatabases' => [ + 'summary' => '调用GetAllDatabases获取当前用户所有有权限的数据库。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回对象', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '如果后端处理出现错误,则表示错误的类型', + 'description' => '如果有错误,则返回错误的类型。此API不会有异常。', + 'type' => 'string', + 'example' => 'ok', + ], + 'Data' => [ + 'title' => '返回的数据库列表', + 'description' => '有权限的数据库名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '有权限的数据库名称列表。', + 'type' => 'string', + 'example' => 'db001', + ], + ], + 'Message' => [ + 'title' => '如果后端处理出现错误,则表示错误的信息', + 'description' => '如果有异常,则返回异常详细信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => '请求的 ID', + 'description' => '本次请求的RequestId。', + 'type' => 'string', + 'example' => '9BEAC206-0795-4DE3-B1FD-964BEF432B23', + ], + 'Success' => [ + 'title' => '标识本次请求是否成功', + 'description' => '本次请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"ok\\",\\n \\"Data\\": [\\n \\"db001\\"\\n ],\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"9BEAC206-0795-4DE3-B1FD-964BEF432B23\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAllDatabasesResponse>\\n <Code>ok</Code>\\n <Data>db001</Data>\\n <Message>ok</Message>\\n <RequestId>9BEAC206-0795-4DE3-B1FD-964BEF432B23</RequestId>\\n <Success>true</Success>\\n</GetAllDatabasesResponse>","errorExample":""}]', + 'title' => '获取当前用户所有有权限的数据库名称', + ], + 'AddPartitions' => [ + 'summary' => '向 DLA 元数据系统里面添加分区信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Partition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '添加的分区', + 'description' => '<props="china">只发布国内站</props>'."\n" + .'<props="intl">只发布虚商站</props>'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '分区数组的内容。', + 'type' => 'object', + 'properties' => [ + 'DbName' => [ + 'title' => '数据库名称', + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'db001', + ], + 'Parameters' => [ + 'title' => '分区属性', + 'description' => '分区参数。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '分区参数。', + 'example' => 'key001=value002', + ], + ], + 'StorageDescriptor' => [ + 'title' => '分区的 StorageDescriptor ', + 'description' => '分区的SD信息。', + 'type' => 'object', + 'properties' => [ + 'Col' => [ + 'title' => '表的列信息', + 'description' => '表的列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表的列信息。', + 'type' => 'object', + 'properties' => [ + 'Comment' => [ + 'title' => '列注释', + 'description' => '列注释。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is comment', + ], + 'Name' => [ + 'title' => '列名', + 'description' => '列名。', + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + 'Type' => [ + 'title' => '列类型', + 'description' => '列类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'string', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'InputFormat' => [ + 'title' => '表的 inputFormat', + 'description' => '表的InputFormat。', + 'type' => 'string', + 'required' => true, + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', + ], + 'Location' => [ + 'title' => '表路径', + 'description' => '表的路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://data/xxxx', + ], + 'OutputFormat' => [ + 'title' => '表的 outputFormat', + 'description' => '表的OutputFormat。', + 'type' => 'string', + 'required' => true, + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat', + ], + 'Parameters' => [ + 'title' => 'StorageDescriptor 的属性', + 'description' => 'SD的属性。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'key001=value002', + 'description' => 'SD的属性。', + ], + ], + 'SerDeInfo' => [ + 'title' => '表的 serDeInfo', + 'description' => '表的SerDe信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'SerDe 的名字', + 'description' => 'SerDe的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'serDeName', + ], + 'Parameters' => [ + 'title' => 'SerDe 的', + 'description' => 'SerDe的属性。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'key001=value002', + 'description' => 'SerDe的属性。', + ], + ], + 'SerializationLib' => [ + 'title' => 'SerDe 的 serializationLib 信息', + 'description' => '处理serDe的类库。', + 'type' => 'string', + 'required' => true, + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe', + ], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + 'TableName' => [ + 'title' => '表名', + 'description' => '表的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'tbl001', + ], + 'Values' => [ + 'title' => '需要添加的分区', + 'description' => '分区的值。', + 'type' => 'array', + 'items' => [ + 'description' => '分区的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'p001', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回对象', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '如果后端处理出现错误,则表示错误的类型', + 'description' => '标记成功错误的CODE。', + 'type' => 'string', + 'example' => 'INVALID_OPERATION', + ], + 'Data' => [ + 'title' => '成功添加的分区个数', + 'description' => '成功添加的分区数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Message' => [ + 'title' => '如果后端处理出现错误,则表示错误的信息', + 'description' => '如果有错误,则返回错误的信息。', + 'type' => 'string', + 'example' => 'Too many partitions, exceed max partition number', + ], + 'RequestId' => [ + 'title' => '请求的 ID', + 'description' => '请求RequestId。', + 'type' => 'string', + 'example' => '9BEAC206-0795-4DE3-B1FD-964BEF432B23', + ], + 'Success' => [ + 'title' => '标识本次请求是否成功', + 'description' => '修改数据库是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 430 => [ + [ + 'errorCode' => 'ServerError.Inner', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"INVALID_OPERATION\\",\\n \\"Data\\": 2,\\n \\"Message\\": \\"Too many partitions, exceed max partition number\\",\\n \\"RequestId\\": \\"9BEAC206-0795-4DE3-B1FD-964BEF432B23\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>Too many partitions, exceed max partition number</Message>\\n<RequestId>9BEAC206-0795-4DE3-B1FD-964BEF432B23</RequestId>\\n<Data>2</Data>\\n<Code>INVALID_OPERATION</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '向元数据系统添加分区信息', + ], + 'GetTable' => [ + 'summary' => '调用GetTable获取给定表的详细信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'db001', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'title' => '表名称', + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'tbl001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回对象', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '如果后端处理出现错误,则表示错误的类型', + 'description' => '如果失败,则返回失败的代码。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'NO_SUCH_OBJECT', + ], + 'Message' => [ + 'title' => '如果后端处理出现错误,则表示错误的信息', + 'description' => '如果请求失败,则返回失败的详细信息。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'No such table: db001.tbl001', + ], + 'RequestId' => [ + 'title' => '请求的 ID', + 'description' => '本次请求的RequestId。'."\n" + ."\n", + 'type' => 'string', + 'example' => '9BEAC206-0795-4DE3-B1FD-964BEF432B23', + ], + 'Success' => [ + 'title' => '标识本次请求是否成功', + 'description' => '本次请求是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Table' => [ + 'title' => '获取的表信息', + 'description' => '获取的表信息。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '表的创建时间', + 'description' => '表的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20190813', + ], + 'DbName' => [ + 'title' => '数据库名称', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'db001', + ], + 'LastAccessTime' => [ + 'title' => '最后一次访问时间', + 'description' => '表的最后访问时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20190814', + ], + 'Owner' => [ + 'title' => '表的所属用户', + 'description' => '创建表的DLA username。', + 'type' => 'string', + 'example' => 'user001', + ], + 'Parameters' => [ + 'title' => '表属性', + 'description' => '表的属性。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '表的属性。', + 'example' => 'key001=value001', + ], + ], + 'PartitionKeys' => [ + 'title' => '分区信息', + 'description' => '表的分区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表的分区信息。', + 'type' => 'object', + 'properties' => [ + 'Comment' => [ + 'title' => '分区注释', + 'description' => '分区注释。', + 'type' => 'string', + 'example' => 'this is partition comment', + ], + 'Name' => [ + 'title' => '分区名称', + 'description' => '分区字段名称。', + 'type' => 'string', + 'example' => 'part001', + ], + 'Type' => [ + 'title' => '分区类型', + 'description' => '分区列类型。', + 'type' => 'string', + 'example' => 'int', + ], + ], + ], + ], + 'StorageDescriptor' => [ + 'title' => '表的 sd 信息', + 'description' => '表的SD信息。', + 'type' => 'object', + 'properties' => [ + 'Cols' => [ + 'title' => '表的列信息', + 'description' => '表的列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表的列信息。', + 'type' => 'object', + 'properties' => [ + 'Comment' => [ + 'title' => '列注释', + 'description' => '列注释。', + 'type' => 'string', + 'example' => 'this is column comment', + ], + 'Name' => [ + 'title' => '列名称', + 'description' => '列名称。', + 'type' => 'string', + 'example' => 'col1', + ], + 'Type' => [ + 'title' => '列类型', + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'string', + ], + ], + ], + ], + 'InputFormat' => [ + 'title' => '表的 inputFormat', + 'description' => '表的InputFormat。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', + ], + 'Location' => [ + 'title' => '表路径', + 'description' => '表的路径。', + 'type' => 'string', + 'example' => 'oss://data/xxxx', + ], + 'OutputFormat' => [ + 'title' => '表的 outputFormat', + 'description' => '表的OutputFormat。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat', + ], + 'Parameters' => [ + 'title' => 'SD 的属性', + 'description' => 'SD属性。', + 'type' => 'object', + ], + 'SerDeInfo' => [ + 'title' => '表的 SerDe 信息', + 'description' => 'SerDe信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'SerDe 的名称', + 'description' => 'SerDe名字。', + 'type' => 'string', + 'example' => 'SerDeName', + ], + 'Parameters' => [ + 'title' => 'SerDe 的属性', + 'description' => 'SerDe属性。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'SerDe属性。', + 'example' => 'key001=value001', + ], + ], + 'SerializationLib' => [ + 'title' => 'SerDe 的 serializationLib', + 'description' => '处理serDe的类库。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe', + ], + ], + ], + ], + ], + 'TableName' => [ + 'title' => '表的名称', + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'tbl001', + ], + 'TableType' => [ + 'title' => '表的类型', + 'description' => '表类型,支持VIEW、MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW。', + 'type' => 'string', + 'example' => 'VIEW', + ], + 'ViewExpandedText' => [ + 'title' => '如果表是视图,则存储扩展视图SQL', + 'description' => '如果表是视图,则代表视图的扩展SQL。', + 'type' => 'string', + 'example' => 'select count(*) from tbl002', + ], + 'ViewOriginalText' => [ + 'title' => '如果表是视图,则存储原生视图SQL', + 'description' => '如果表是视图,则代表视图的原始SQL。', + 'type' => 'string', + 'example' => 'select count(*) from tbl002', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NO_SUCH_OBJECT\\",\\n \\"Message\\": \\"No such table: db001.tbl001\\",\\n \\"RequestId\\": \\"9BEAC206-0795-4DE3-B1FD-964BEF432B23\\",\\n \\"Success\\": false,\\n \\"Table\\": {\\n \\"CreateTime\\": 20190813,\\n \\"DbName\\": \\"db001\\",\\n \\"LastAccessTime\\": 20190814,\\n \\"Owner\\": \\"user001\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key001=value001\\"\\n },\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"this is partition comment\\",\\n \\"Name\\": \\"part001\\",\\n \\"Type\\": \\"int\\"\\n }\\n ],\\n \\"StorageDescriptor\\": {\\n \\"Cols\\": [\\n {\\n \\"Comment\\": \\"this is column comment\\",\\n \\"Name\\": \\"col1\\",\\n \\"Type\\": \\"string\\"\\n }\\n ],\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"Location\\": \\"oss://data/xxxx\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SerDeInfo\\": {\\n \\"Name\\": \\"SerDeName\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"key001=value001\\"\\n },\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\"\\n }\\n },\\n \\"TableName\\": \\"tbl001\\",\\n \\"TableType\\": \\"VIEW\\",\\n \\"ViewExpandedText\\": \\"select count(*) from tbl002\\",\\n \\"ViewOriginalText\\": \\"select count(*) from tbl002\\"\\n }\\n}","type":"json"}]', + 'title' => '获取给定表的详细信息', + ], + 'GetAllTables' => [ + 'summary' => '调用GetAllTables获取数据库下面的所有有权限的表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '需要获取数据库的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'db001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回对象', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '如果后端处理出现错误,则表示错误的类型', + 'description' => '如果请求有异常,则返回异常编码。', + 'type' => 'string', + 'example' => 'NO_SUCH_OBJECT', + ], + 'Data' => [ + 'title' => '请求数据库低下的所有表', + 'description' => '如果请求成功,则返回db001下面的所有有权限的表。', + 'type' => 'array', + 'items' => [ + 'description' => '如果请求成功,则返回db001下面的所有有权限的表。', + 'type' => 'string', + 'example' => 'tbl001', + ], + ], + 'Message' => [ + 'title' => '如果后端处理出现错误,则表示错误的信息', + 'description' => '如果出现异常,则返回错误的信息。', + 'type' => 'string', + 'example' => 'The database db001 does not exist', + ], + 'RequestId' => [ + 'title' => '请求的 ID', + 'description' => '本次请求的RequestId。', + 'type' => 'string', + 'example' => '9BEAC206-0795-4DE3-B1FD-964BEF432B23', + ], + 'Success' => [ + 'title' => '标识本次请求是否成功', + 'description' => '本次请求是否成功。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"NO_SUCH_OBJECT\\",\\n \\"Data\\": [\\n \\"tbl001\\"\\n ],\\n \\"Message\\": \\"The database db001 does not exist\\",\\n \\"RequestId\\": \\"9BEAC206-0795-4DE3-B1FD-964BEF432B23\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<Message>The database db001 does not exist</Message>\\n<RequestId>9BEAC206-0795-4DE3-B1FD-964BEF432B23</RequestId>\\n<Data>[ tbl001,tbl002 ]</Data>\\n<Code>NO_SUCH_OBJECT</Code>\\n<Success>false</Success>","errorExample":""}]', + 'title' => '获取某个库下面的所有有权限的表', + ], + 'DropTable' => [ + 'summary' => '将给定表删除。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '需要删除表所在的数据库', + 'type' => 'string', + 'required' => true, + 'example' => 'db001', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'title' => '表名称', + 'description' => '需要删除的表', + 'type' => 'string', + 'required' => true, + 'example' => 'tbl001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回对象', + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '如果后端处理出现错误,则表示错误的类型', + 'description' => '标记成功错误的 CODE', + 'type' => 'string', + 'example' => 'NO_SUCH_OBJECT', + ], + 'Data' => [ + 'title' => '标记表是否删除成功', + 'description' => '标记是否删除成功', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Message' => [ + 'title' => '如果后端处理出现错误,则表示错误的信息', + 'description' => '如果删除表失败,返回失败的原因。', + 'type' => 'string', + 'example' => 'No such table: db001.tbl001', + ], + 'RequestId' => [ + 'title' => '请求的 ID', + 'description' => '请求的 RequestId', + 'type' => 'string', + 'example' => '9BEAC206-0795-4DE3-B1FD-964BEF432B23', + ], + 'Success' => [ + 'title' => '标识本次请求是否成功', + 'description' => '标记本次请求是否成功', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 430 => [ + [ + 'errorCode' => 'ServerError.Inner', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"NO_SUCH_OBJECT\\",\\n \\"Data\\": false,\\n \\"Message\\": \\"No such table: db001.tbl001\\",\\n \\"RequestId\\": \\"9BEAC206-0795-4DE3-B1FD-964BEF432B23\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<Message>No such table: db001.tbl001</Message>\\n<RequestId>9BEAC206-0795-4DE3-B1FD-964BEF432B23</RequestId>\\n<Data>false</Data>\\n<Code>NO_SUCH_OBJECT</Code>\\n<Success>false</Success>","errorExample":""}]', + 'title' => '将给定表删除', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'openanalytics.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'openanalytics.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'openanalytics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'openanalytics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'openanalytics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'openanalytics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'openanalytics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'datalakeanalytics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'openanalytics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'datalakeanalytics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'openanalytics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'openanalytics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'datalakeanalytics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'datalakeanalytics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'openanalytics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'openanalytics.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'openanalytics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'openanalytics.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'openanalytics.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'openanalytics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com', + ], + ], +]; |
