ListPartitions - 查询数据地图数据表的分区列表

更新时间:
复制 MD 格式

查询数据地图给定数据表的分区列表,当前支持maxcomputehms(EMR集群)类型。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。

  2. 目前只支持 MaxCompute、HMS(EMR 集群)类型的表。

  3. 调用本 API 前,请先调用 ListCrawlers 获取元数据采集器的 MetaEntityId,再调用 ListDatabases 获取数据库 ID;对于启用 Schema 的 MaxCompute 项目,继续调用 ListSchemas 获取模式 ID;随后调用 ListTables 获取 TableId,并将返回的表 ID 传入本 API。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListPartitions

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

TableId

string

所属数据表 ID,可参考 ListTables 接口返回结果, 以及元数据实体相关概念说明

maxcompute-table:::project_name:[schema_name]:table_name

Name

string

分区名称,模糊匹配,该参数仅对 maxcompute 类型有效

ds=20250101

SortBy

string

排序字段,默认为 CreateTime,枚举值,当前支持

  • CreateTime:创建时间,仅 MaxCompute 类型支持。

  • ModifyTime:修改时间,仅 MaxCompute 类型支持。

  • Name:名称,HMS 类型使用的排序方式。

  • RecordCount:记录数,仅 MaxCompute 类型支持。

  • DataSize:存储量,仅 MaxCompute 类型支持。

枚举值:

  • ModifyTime :

    修改时间,仅 MaxCompute 类型支持

  • CreateTime :

    创建时间,仅 MaxCompute 类型支持

  • DataSize :

    存储量,仅 MaxCompute 类型支持

  • RecordCount :

    记录数,仅 MaxCompute 类型支持

  • Name :

    名称,HMS 类型使用的排序方式

CreateTime

Order

string

排序方向,默认为 Asc,枚举值,当前支持

  • Asc:升序。

  • Desc:降序。

枚举值:

  • Asc :

    升序

  • Desc :

    降序

Asc

PageNumber

integer

分页页码,默认为 1 。

1

PageSize

integer

分页大小,默认为 10,最大为 100 。

10

返回参数

名称

类型

描述

示例值

object

返回结果 。

RequestId

string

请求 ID 。

D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx

Success

boolean

请求是否成功 。

true

PagingInfo

object

分页结果 。

TotalCount

integer

总记录数 。

1

PageNumber

integer

分页页码 。

1

PageSize

integer

分页大小 。

10

PartitionList

array

数据表的分区列表 。

Partition

数据表的分区 。

示例

正常返回示例

JSON格式

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "PartitionList": [
      {
        "TableId": "maxcompute-table:accountId::project::table",
        "Name": "ds=20250101",
        "CreateTime": 1700192563000,
        "ModifyTime": 1700192563000,
        "RecordCount": 1000000,
        "DataSize": 4096
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情