ListDataLakePartitionByFilter - 根据筛选条件获取数据湖表分区列表

调用此API可根据筛选条件获取数据湖表分区列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListDataLakePartitionByFilterget
*全部资源
*

请求参数

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

数据湖所属的地域。

cn-hangzhou
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***
CatalogNamestring

数据目录名。

hive
DbNamestring

数据库名称。

default
TableNamestring

表名称。

test_table
Filterstring

查询条件表达式。支持如下运算符:

  • 比较运算符:=、<>、!=、<、<=、>、>=。例如:ds>20240101。
  • 逻辑运算符:AND、OR、NOT。例如:ds LIKE '20240%'
  • BETWEEN 运算符:用于指定一个范围。例如:ds BETWEEN 20240101 AND 20241201。
  • IN 运算符:用于指定特定的值集合。例如:ds IN (20240101, 20240102)。
ds>20241201
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
f056501ada12c1cc
MaxResultsinteger

分页大小。最大值为 100。

20
WorkspaceIdlong

工作空间 ID。

12****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求的 ID。用于定位日志,排查问题。

427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true
ErrorCodestring

错误码,请求异常时返回。

UnknownError
ErrorMessagestring

调用失败时,返回的错误信息。

UnknownError
PartitionListarray

分区列表。

PartitionDLPartition

湖仓表分区信息。

NextTokenstring

令牌(Token)信息。

NesLoKLEdIZrKhDT7I2gS****
MaxResultsinteger

分页大小。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "PartitionList": [
    {
      "TableName": "table_name",
      "Sd": {
        "OriginalColumns": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ],
        "SortCols": [
          {
            "Order": 1,
            "Col": "col1"
          }
        ],
        "Parameters": {
          "test": "test",
          "test2": 1
        },
        "SkewedInfo": {
          "SkewedColValues": [
            [
              123
            ]
          ],
          "SkewedColValueLocationMaps": {
            "test": "test",
            "test2": 1
          },
          "SkewedColNames": [
            "col1"
          ]
        },
        "InputFormat": "org.apache.hadoop.mapred.SequenceFileInputFormat",
        "OutputFormat": "org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat",
        "Columns": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ],
        "IsCompressed": false,
        "SerdeInfo": {
          "SerializationLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
          "DeserializerClass": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
          "Parameters": {
            "serialization.format": 1
          },
          "Description": "serialize",
          "SerdeType": 0,
          "SerializerClass": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
          "Name": "name"
        },
        "BucketCols": [
          2010
        ],
        "NumBuckets": -1,
        "Location": "oss://xxx"
      },
      "Parameters": {
        "key": {
          "key": "value"
        }
      },
      "CreateTime": 1735109884,
      "Values": [
        "part_val1"
      ],
      "CatalogName": "hive",
      "DbName": "default",
      "LastAccessTime": 1608707407
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "MaxResults": 20
}

错误码

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