获取分区信息列表
功能介绍
该API用于用于获取分区信息的列表。
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
请求消息
无请求参数。
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
否 |
Boolean |
执行请求是否成功。“true”表示请求执行成功。 |
message |
否 |
String |
系统提示信息,执行成功时,信息可能为空。 |
partitions |
否 |
Object |
分区信息。请参考表4。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
total_count |
是 |
Long |
总个数。 |
partition_infos |
是 |
Array of Objects |
分区信息列表。请参考表5。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
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 |
该分区总的数据大小(单位:字节)。 |
请求示例
无
响应示例
{ "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 } ] } }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。