首页 >数据湖构建 >API参考指南 >API目录 >元数据 >分区 >ListPartitionsByFilter - 按条件获取元数据表分区列表

ListPartitionsByFilter - 按条件获取元数据表分区列表

获取数据湖元数据表分区列表,按Filter条件查询

调试

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

调试

授权信息

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

请求参数

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

HTTP请求体

CatalogIdstring

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

1344371
DatabaseNamestring

元数据库名称

database_test
Filterstring

查询条件表达式,如ds>20201201

ds>20201201
NextPageTokenstring

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

''
PageSizeinteger

每页大小

10
TableNamestring

元数据表名

test_table_20200715162543389
IsShareSdboolean

是否共享partition的SD中column信息

true

isShareSd:是否开启共享SD中的columns信息,listpartitions返回的partitions列表中,不同的partition中sd中的column相同的可能性比较高,因此开启共享,可以降低网络传输的数据量,有助于提升性能

返回参数

名称类型描述示例值
object

返回结果体

Codestring

状态码描述

OK
Messagestring

提示相关错误信息

.
NextPageTokenstring

翻页token

2cb472ec1bf84f8d92f9c4baa0d21c19aa
Partitionsarray

查询后的分区详情

Partition

查询后的分区详情

RequestIdstring

请求ID

B7F4B621-E41E-4C84-B97F-42B5380A32BB
Successboolean

是否成功

true
PartitionSpecsarray

PartitionSpecs

PartitionSpec

Code错误码说明
NoSuchObject:对应的元数据库/表等不存在
InternalError:其他类型错误,请参考Message提示

示例

请求示例

POST /api/metastore/catalogs/databases/tables/partitions/listbyfilter HTTP/1.1 
 {
  "TableName": "test_table_20201225",
  "PageSize": 10,
  "NextPageToken": "''",
  "DatabaseName": "database_test",
  "CatalogId": "1344371",
  "Filter": "ds>20201201"
}

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "",
  "NextPageToken": "",
  "Partitions": [
    {
      "CatName": "1344371",
      "CreateTime": 1608814496,
      "DatabaseName": "database_test",
      "LastAccessTime": 0,
      "LastAnalyzedTime": 0,
      "Parameters": {
        "transient_lastDdlTime": "1608814496"
      },
      "PartitionId": "b388c318579d417ab5b3d64c823aab5b",
      "PartitionName": "ds=20201224/hour=14",
      "Privileges": {
        "GroupPrivileges": {},
        "RolePrivileges": {},
        "UserPrivileges": {}
      },
      "Sd": {
        "BucketCols": [],
        "Cols": [
          {
            "Comment": "user_name",
            "Id": "name",
            "Name": "name",
            "Type": "string"
          }
        ],
        "Compressed": false,
        "InputFormat": "input",
        "NumBuckets": 5,
        "OutputFormat": "output",
        "Parameters": {},
        "SerDeInfo": {
          "Parameters": {}
        },
        "SkewedInfo": {
          "SkewedColNames": [],
          "SkewedColValueLocationMaps": {},
          "SkewedColValues": []
        },
        "SortCols": [],
        "StoredAsSubDirectories": false
      },
      "TableId": "f34ff9818d8f4e02a0f965fa940d8e37",
      "TableName": "test_table_20201225",
      "Values": [
        "20201224",
        "14"
      ]
    }
  ],
  "RequestId": "9A3BC9C1-60A1-4E12-AF2D-D4E9F86013F6",
  "Success": true
}

错误码

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

阿里云首页 数据湖构建 相关技术圈