功能描述
用于列出租户空间列表信息。
说明:
请求
请求示例
GET /api/v1/space/{LibraryId}/list?access_token={AccessToken}&marker={Marker}&limit={Limit}&ordered={Ordered}&prefix={Prefix}&start_name={StartName}
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | String | 是 | |
AccessToken | String | 是 | |
Marker | 用于顺序列出分页的标识,即上一次请求返回的 nextMarker 字段 | String | 否 |
Limit | 用于顺序列出分页时租户空间数量限制,默认为1000,范围为[1,1000] | String | 否 |
Ordered | 是否启用全局有序列出模式,可选参数;取值为 1 时启用(按 spaceId 升序跨分片合并返回),默认为 0 表示不启用 | String | 否 |
Prefix | 按 spaceId 前缀过滤,仅返回 spaceId 以该前缀开头的租户空间;仅在 Ordered=1 时生效,否则会被服务端忽略 | String | 否 |
StartName | 分页起始游标(不包含),仅返回 spaceId > StartName 的租户空间,用作分页起点;仅在 Ordered=1 时生效;当与 Marker 同时传入时,Marker 优先级更高,StartName 将被忽略 | String | 否 |
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
{"list":[{"spaceId": "space04fzo07fdq61b","userId": "","creationTime": "2020-10-16T02:31:50.000Z"},{"spaceId": "space3p5klbgcwndnt","userId": "","creationTime": "2020-10-16T02:31:50.000Z"}],"marker": "eyJmb3JtYXQiOjIsInRhYmх1X21kIjoхLCJzсGFjZV9pZCI6IiJ9","nextMarker":"eyJmb3JtYXQiOjIsInRhYmх1X21kIjoхLCJzсGFjZV9pZCI6IiJ9"}
响应体字段说明:
响应 | 描述 | 类型 |
List | 记录租户空间信息 | List |
marker | 用于列出分页的标识 | String |
nextMarker | 用于顺序列出分页的标识,如果没有更多则不存在该字段 | String |
List 中包含以下参数:
节点名称(关键字) | 描述 | 类型 |
spaceId | 租户空间 ID | String |
userId | 创建者用户 ID | String |
creationTime | 租户空间创建时间,ISO 8601格式的日期与时间字符串,例如 2020-10-14T10:17:57.953Z | String |
说明:
响应体中 nextMarker 为空时才会展示 List 列表。