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

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

调试

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

授权信息

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

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

请求语法

POST /api/metastore/catalogs/databases/tables/partitions/listbyfilter HTTP/1.1

请求参数

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

HTTP 请求体。

CatalogIdstring

数据目录 ID。

1344371
DatabaseNamestring

数据库名称。

database_test
Filterstring

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

  • 比较运算符: =, <>, !=, <, <=, >, >=。例如:ds > 20240101。

  • 逻辑运算符:AND, OR, NOT。例如:ds like '20240%'。

  • BETWEEN 运算符:用于指定一个范围。例如:ds BETWEEN 20240101 AND 20241201。

  • IN 运算符:用于指定特定的值集合。例如:ds IN (20240101, 20240102)。

ds>20201201
NextPageTokenstring

翻页令牌,用于获取下一页数据。如果响应结果中没有提供,则传空字符串("")或空字符('')。

''
PageSizeinteger

每页大小,最大为 1000。

10
TableNamestring

数据表名。

test_table_20200715162543389
IsShareSdboolean

是否共享 partition 的 SD 中 column 信息。取值如下:

  • true:共享。

  • false:不共享。

true

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

返回参数

名称类型描述示例值
object

返回消息体。

Codestring

状态码。

OK
Messagestring

返回信息。

.
NextPageTokenstring

翻页令牌,用于获取下一页数据。

2cb472ec1bf84f8d92f9c4baa0d21c19aa
Partitionsarray

查询后的分区详情列表。

Partition

查询后的分区详情。

RequestIdstring

请求 ID。

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

是否调用成功。取值如下:

  • true:表示调用成功。

  • false:表示调用失败。

true
PartitionSpecsarray

分区规格列表。

PartitionSpec

分区规格。

Code 错误码说明:

  • NoSuchObject:对应的数据库、表等不存在。

  • InternalError:其他类型错误,请参考 Message 提示。

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": ".",
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "Partitions": [
    {
      "CreateTime": 1608730999,
      "DatabaseName": "database_test",
      "LastAccessTime": 1608730999,
      "LastAnalyzedTime": 1608730999,
      "Parameters": {
        "key": "key"
      },
      "Privileges": {
        "GroupPrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        },
        "RolePrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        },
        "UserPrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        }
      },
      "Sd": {
        "BucketCols": [
          "2010"
        ],
        "Cols": [
          {
            "Comment": "comment_day",
            "Name": "day",
            "Parameters": {
              "key": "key"
            },
            "Type": "int"
          }
        ],
        "Compressed": false,
        "InputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat",
        "Location": "file:///tmp/table",
        "NumBuckets": 10,
        "OutputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat",
        "Parameters": {
          "key": "key"
        },
        "SerDeInfo": {
          "Name": "name",
          "Parameters": {
            "key": "key"
          },
          "SerializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde"
        },
        "SkewedInfo": {
          "SkewedColNames": [
            "col1"
          ],
          "SkewedColValueLocationMaps": {
            "key": "{“col1”:\"val1\"}"
          },
          "SkewedColValues": [
            [
              "\"123\""
            ]
          ]
        },
        "SortCols": [
          {
            "Col": "col1",
            "Order": 1
          }
        ],
        "StoredAsSubDirectories": false
      },
      "TableName": "test_table_20201223",
      "Values": [
        "part1"
      ]
    }
  ],
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true,
  "PartitionSpecs": [
    {
      "SharedSDPartitions": [
        {
          "CreateTime": 1608730999,
          "DatabaseName": "database_test",
          "LastAccessTime": 1608730999,
          "LastAnalyzedTime": 1608730999,
          "Parameters": {
            "key": "key"
          },
          "Privileges": {},
          "Sd": {
            "BucketCols": [
              "2010"
            ],
            "Cols": [
              {
                "Comment": "comment_day",
                "Name": "day",
                "Parameters": {
                  "key": "key"
                },
                "Type": "int"
              }
            ],
            "Compressed": false,
            "InputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat",
            "Location": "file:///tmp/table",
            "NumBuckets": 10,
            "OutputFormat": "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat",
            "Parameters": {
              "key": "key"
            },
            "SerDeInfo": {
              "Name": "name",
              "SerializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde"
            },
            "SkewedInfo": {
              "SkewedColNames": [
                "col1"
              ],
              "SkewedColValueLocationMaps": {
                "key": "{“col1”:\"val1\"}"
              },
              "SkewedColValues": [
                [
                  "\"123\""
                ]
              ]
            },
            "SortCols": [
              {
                "Col": "col1",
                "Order": 1
              }
            ],
            "StoredAsSubDirectories": false
          },
          "TableName": "test_table_20201223",
          "Values": [
            "part1"
          ]
        }
      ],
      "SharedStorageDescriptor": {
        "Cols": [
          {
            "Comment": "comment_day",
            "Name": "day",
            "Type": "int"
          }
        ],
        "Location": "相对路径"
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史