logologo
售前咨询
点播云
服务端API
空间管理
文档中心
服务端API空间管理获取空间列表

获取空间列表


1. 请求参数

字段

类型

是否必填

示例

描述

Action

String

ListSpace

公共参数,获取空间列表,取值:ListSpace

Offset

Integer

20

分页查询偏移量

Limit

Integer

100

分页查询限制数目,默认20,最大可设置为40

SpaceName

String

test

空间名称,用于模糊搜索查询

2. 返回参数

名称

类型

示例值

描述

TotalCount

Long

2

总条数。

Offset

Integer

0

下次分页起始坐标

Limit

Integer

10

返回的空间个数

SpaceList

Array of Space


空间列表

3. API示例

3.1 请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=ListSpace' \
-H 'Content-Type: application/json' \
-d '{"Offset": 0, "Limit": 10}'
-H <公共请求参数>

3.2 返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId": "fwAAAWLX9FUAAAAAAAAAAA",
"ErrorCode": "",
"ErrorMessage": ""
},
"ResponseData": {
"Offset": 1,
"Limit": 10,
"TotalCount": 1,
"SpaceList": [{
"SpaceName": "test-space",
"Status": "Online"
}
]
}
}

4. 错误码

ErrorCode

ErrorMessage

说明

状态码

InvalidArgument

Limit is over 40

limit超过限制

400

InvalidArgument

Limit is below 0

limit小于0

400

InvalidArgument

Offset is below 0

offset小于0

400

上一篇:获取空间信息下一篇:设置消息回调配置
该篇文档内容是否对您有帮助?
有帮助没帮助