更新时间:2022-04-16 GMT+08:00
分享

获取分区信息列表

功能介绍

该API用于用于获取分区信息的列表。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitions

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    database_name

    String

    数据库名称。

    table_name

    String

    表名称。

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    limit

    Integer

    每页显示的返回信息的个数,默认值为100。

    offset

    Integer

    偏移量。

    filter

    String

    筛选条件,目前只支持“=”条件筛选,例如:name=name1,表示筛选出分区中name=name1的数据,name为分区列名称,name1为分区列的值。key和value不区分大小写。

    例如:GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitions?part=part2

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

partitions

Object

分区信息。请参考表4

表4 partitions参数说明

参数名称

是否必选

参数类型

说明

total_count

Long

总个数。

partition_infos

Array of Objects

分区信息列表。请参考表5

表5 partition_infos参数说明

参数名称

是否必选

参数类型

说明

partition_name

String

分区名。

create_time

Long

创建时间。

last_access_time

Long

最后改动时间。

locations

Array of Strings

路径,非DLI表显示,DLI表不显示。

last_ddl_time

Long

最后一个ddl语句执行时间,(单位:秒(s))。

num_rows

Long

该分区数据总行数。

num_files

Long

分区文件数。

total_size

Long

该分区总的数据大小(单位:字节)。

示例

  • 请求样例:
    NONE
  • 成功响应样例:
    {
        "is_success": true,
        "message": "list partitions succeed",
        "partitions": {
            "total_count": 5,
            "partition_infos": [
                {
                    "partition_name": "name=test",
                    "create_time": 1579520179000,
                    "last_access_time": 1579520179000,
                    "locations": [
                        "obs://test/partition"
                    ]
                },
                {
                    "partition_name": "name=test1",
                    "create_time": 1579521406000,
                    "last_access_time": 1579521406000,
                    "locations": [
                        "obs://test/partition"
                    ]
                },
                {
                    "partition_name": "name=test2",
                    "create_time": 1579521884000,
                    "last_access_time": 1579521884000,
                    "locations": [
                        "obs://test/partition"
                    ]
                },
                {
                    "partition_name": "name=test3",
                    "create_time": 1579522085000,
                    "last_access_time": 1579522085000,
                    "locations": [
                        "obs://test/partition"
                    ]
                },
                {
                    "partition_name": "name=name1/age=age1",
                    "create_time": 1581409182000,
                    "last_access_time": 1581409182000,
                    "locations": [
                        "obs://test/0117"
                    ],
                    "last_ddl_time": 1581409182,
                    "total_size": 2130,
                    "num_rows": -1,
                    "num_files": 2
                }
            ]
        }
    }

状态码

状态码如表6所示。

表6 状态码

状态码

描述

200

操作成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close