获取table分区列表

最近更新时间: 2026-09-17 00:05:49

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.cn。

获取指定表的分区列表。

默认接口请求频率限制：20次/秒。

接口更新时间：2025-09-11 17:21:44。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribePartitions
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息本接口不需要传递此参数。
TableIdentity 是 否 TableIdentity 表信息
示例值：查看
Filters 否 否 Array of RequestFilter 过滤字段，Name支持字段：Name，values为字段名
示例值：查看
Limit 是 否 Int64 每页数量，默认值为10，最大值为200
示例值： 10
Offset 是 否 Int64 偏移量，页编号，默认为0，表示第一页
示例值： 0
OrderFields 否 否 Array of OrderField 排序字段，Fields支持字段：字段名Name，Direction支持"DESC"和"ASC"
示例值：查看

3. 输出参数

参数名称 类型 描述
Data Array of PartitionItem 分区数组
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
TotalCount Int64 总数
示例值： 1
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

5. 示例

示例1 获取分区列表

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribePartitions
<公共请求参数>

{
  "Limit": 10,
  "Offset": 0,
  "OrderFields": [],
  "TableIdentity": {
    "CatalogName": "c9kr93vco_hive",
    "SchemaName": "default",
    "TableName": "table1"
  },
  "Filters": []
}

输出示例

{
  "Response": {
    "RequestId": "5e4b93ed-2736-457a-aff6-0a93d47cece0",
    "Data": [],
    "TotalCount": 0
  }
}