获取数据湖元数据表分区名称列表,通常用于多级分区

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /api/metastore/catalogs/databases/tables/partitions/names 

请求参数

名称 类型 位置 是否必选 示例值 描述
Object Body

HTTP请求体

CatalogId String Body 1344371

数据库分类命名空间,默认填写主账号Uid

DatabaseName String Body database_test

元数据库名称

NextPageToken String Body 2cb472ec1bf84f8d92f9c4baa0d21c19aa

翻页token,从返回结果返回,无则传空字符串或''

PageSize Integer Body 10

分页大小

PartialPartValues ListString Body

分区值列表,可以只传入部分分区的值,会查询出所有下级分区的分区名

TableName String Body test_table_20200715162543389

元数据表名称

RegionId String Host cn-hangzhou

系统所在的地域ID

返回数据

名称 类型 示例值 描述
Code String OK

状态码描述

Message String .

提示相关错误信息

NextPageToken String 2cb472ec1bf84f8d92f9c4baa0d21c19aa

翻页token

PartitionNames Array of String ds=20201124/hour=10

分区名称

RequestId String B7F4B621-E41E-4C84-B97F-42B5380A32BB

请求ID

Success Boolean true

是否成功

Code错误码说明

NoSuchObject:对应的元数据库/表等不存在

InternalError:其他类型错误,请参考Message提示

示例

请求示例

POST /api/metastore/catalogs/databases/tables/partitions/names HTTP/1.1 
 {
  "TableName": "test_table_20201225",
  "PageSize": 10,
  "NextPageToken": "''",
  "DatabaseName": "database_test",
  "CatalogId": "1344371",
  "PartialPartValues": [
    "20201124"
  ]
}

正常返回示例

JSON 格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "",
  "NextPageToken": "",
  "PartitionNames": [
    "ds=20201124/hour=10",
    "ds=20201124/hour=12",
    "ds=20201124/hour=14"
  ],
  "RequestId": "F3D5B471-EE5D-45AF-A25A-976FFF2D9AAA",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。