文档

GetMetaTablePartition - 获取表的分区列表

更新时间:

该接口用于获取表的分区列表。

接口说明

仅支持获取 MaxCompute 和 EMR 两种引擎表的分区列表。 对于 EMR 引擎,仅支持采用数据湖构建(Data Lake Formation)管理元数据的新版本数据湖集群和集群版本小于 3.41.0 或 5.7.0 的 Hadoop 集群。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

请求的数据页数,用于翻页。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TableGuidstring

表的唯一标识。

odps.engine_name.table_name
ClusterIdstring

EMR 集群的 ID,仅当数据类型为 EMR 时,需要配置该参数。

您可以登录 EMR 的控制台,获取集群 ID。

abc
DatabaseNamestring

数据库的名称。仅当数据类型为 EMR 时,需要配置该参数。

您可以调用 ListMetaDB 接口获取。

abc
TableNamestring

EMR 的表名称。仅当数据类型为 EMR 时,需要配置该参数。

您可以通过调用 GetMetaDBTableList 接口,获取表名称。

abc
DataSourceTypestring

数据类型,支持 ODPS 或者 EMR。

emr
SortCriterionobject

表分区的排序逻辑。

SortFieldstring

表分区的排序字段。您可通过 name、modify_time 排序。 默认按照表分区的创建时间排序。

name
Orderstring

表分区的排序顺序,支持使用 asc、desc 方式排序。默认使用 desc。

desc

返回参数

名称类型描述示例值
object

返回的数据结构。

HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

请求 ID。

0bc1ec92159376
Successboolean

请求是否成功。

true
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Dataobject

业务数据。

PageNumberinteger

请求的数据页数,用于翻页。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TotalCountlong

分区的总数。

100
DataEntityListarray<object>

实例列表。

object

数据的结构。

PartitionPathstring

分区的目录。

abc
DataSizelong

分区的大小,单位为 Byte。

19
PartitionNamestring

分区的名称。

pt=20170614
Commentstring

备注信息。

备注
ModifiedTimelong

修改分区的时间,单位为毫秒。

1590032868000
CreateTimelong

创建分区的时间,单位为毫秒。

1590032868000
RecordCountlong

分区的数据量。

233
PartitionTypestring

分区的类型。

abc
PartitionGuidstring

分区的唯一标识。

odps.engine_name.table_name.pt=20170614
PartitionLocationstring

Hive 分区的地址。

abc
TableGuidstring

表的唯一标识。

odps.engine_name.table_name

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "DataEntityList": [
      {
        "PartitionPath": "abc",
        "DataSize": 19,
        "PartitionName": "pt=20170614",
        "Comment": "备注",
        "ModifiedTime": 1590032868000,
        "CreateTime": 1590032868000,
        "RecordCount": 233,
        "PartitionType": "abc",
        "PartitionGuid": "odps.engine_name.table_name.pt=20170614",
        "PartitionLocation": "abc",
        "TableGuid": "odps.engine_name.table_name"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.请求参数错误。
400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.App参数错误。
400InvalidParameter.Meta.IllegalDateThe date format is invalid.日期格式错误。
400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.分页信息错误。
400InvalidParameter.Meta.NotExistThe object does not exist.-
400InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.用户输入的 project 不正确
403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.当前的用户不是任何租户的所有者。
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.对该资源的请求已超过您的每日可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.接口网络不通。
500InternalError.Meta.UnknownAn unknown error occurred while processing your request.未知错误。

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

变更历史

变更时间变更内容概要操作
2024-02-22OpenAPI 错误码发生变更查看变更详情
2022-08-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情

GetMetaTablePartition 接口的使用示例 Demo 请参见DataWorks OpenAPI 示例