文档首页/ 键值存储服务 KVS/ API参考/ API/ 仓接口/ 列举表
更新时间：2024-08-16 GMT+08:00
查看PDF
分享

列举表

功能介绍

指定仓列举创建的所有表。

URI

POST /v1/list-table

表1 Query参数

参数

是否必选

参数类型

描述

store_name

否

String

仓名，全域唯一，不同租户的仓名不能相同。

  • 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id

  • 取值字符限制：[a-z0-9-]+

  • 长度：[16,52]

说明：

"-"不能出现在名字头部或尾部

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

cursor_name

否

String

上次返回游标位置，本次响应包含该table，空表示遍历完。

  • 长度：[3, 63]

  • 取值字符限制：[a-z0-9_-]+

说明：

如果为空，表示后面无更多。

limit

否

Integer

响应返回的表个数。

  • 长度：最大100

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

cursor_name

String

本次响应后的游标位置，下次请求时携带，如果为空，表示后面无更多。

  • 长度：[3, 63]

  • 取值字符限制：[a-z0-9_-]+

说明：

如果为空，表示后面无更多。

table_names

Array of strings

返回的表名列表。

  • 长度：最大100

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

请求返回的错误码。

error_msg

String

请求返回的错误信息。

请求示例

列举指定仓中的表，限制返回表数量为2

POST https://{endpoint}/v1/list-table

{
  "limit" : 2
}

响应示例

状态码： 200

表示列举表请求成功

{
  "cursor_name" : "test-table-name_3",
  "table_name_list" : [ "test-table-name_1", "test-table-name_2" ]
}

状态码

状态码

描述

200

表示列举表请求成功

400

BadRequest

错误码

请参见错误码。

父主题： 仓接口

相关文档