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

列举仓

功能介绍

一个账户下可以创建最多25个仓,每个仓可以创建最多100个store,响应中一次性返回所有仓名称。

URI

POST /v1/list-store

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

cursor_name

String

上次返回的游标位置,本次响应包含该仓名。

  • 长度:[16,52]

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

limit

Integer

响应返回的仓个数。

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

cursor_name

String

本次响应后的游标位置,下次请求时携带。

  • 长度:[16,52]

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

说明:

如果为空,表示后面无更多仓名。

stores

Array of strings

返回的仓名列表。

状态码: 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

请求返回的错误码。

error_msg

String

请求返回的错误信息。

请求示例

列举用户账户下的仓,从指定仓名位置开始返回,限制返回仓名数量2个。

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

{
  "limit" : 2
}

响应示例

状态码: 200

表示列举仓成功。

{
  "cursor_name" : "test-store-name-3",
  "table_name_list" : [ "test-store-name-1", "test-store-name-2" ]
}

状态码

状态码

描述

200

表示列举仓成功。

400

BadRequest

错误码

请参见错误码

相关文档