查询空间列表-Marker
更新时间:2022-08-18
接口描述
本接口用于查询用户账号下面所有的空间列表,按Marker分页方式查询。
请求(Request)
请求URI
GET /v1/space?marker={marker}&maxSize={maxSize}&spaceName={spaceName}&status={status}
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
marker | Long | 是 | 空间ID,1.初次查询marker需要值为空,键必须存在(可参考示例);2.如果返回值中nextMarker不为空,则下次查询时,将nextMarker赋值给marker,如此往复;3.如果返回值中nextMarker不存在,则表示已查询完所有数据 |
maxSize | Integer | 是 | 查询结果最大条数 |
spaceName | String | 否 | 空间名称筛选,只支持前缀模糊匹配 |
status | String | 否 | 空间状态筛选,可取值:OPERATING, RUNNING, STOPPED |
请求头域
除公共头域外,无其它特殊头域。
请求体
无
响应(Response)
响应头域
除公共头域外,无其它特殊头域。
响应体
参数名称 | 类型 | 描述 |
---|---|---|
data | Array | 空间信息列表 |
+ spaceId | Long | 空间ID |
+ spaceName | String | 空间名称 |
+ status | String | 空间状态 |
+ description | String | 空间描述 |
+ deviceCount | Integer | 设备个数 |
+ edgeId | Integer | 所属节点ID |
+ edgeName | String | 所属节点名称 |
marker | String | 本次查询的起点 |
nextMarker | String | 下一次查询的起点,为空表示已经返回所有结果 |
truncated | Boolean | 指明是否所有查询都返回了;false:本次已经返回所有结果,true:本次还没有返回所有结果 |
示例
请求示例
GET /v1/space?marker&maxSize=5 HTTP/1.1
x-bce-date: 2020-03-25T09:28:13Z
host: evs.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2020-03-25T09:28:13Z/1800/content-type;host;x-date/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 012b9747-f13a-4a2c-a488-02b221844dca
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 202 013:34:07 GMT
Content-Type: application/json;charset=UTF-8
{
"data": [
{
"spaceId": 1000615,
"spaceName": "ftp",
"type": "RTMP",
"status": "RUNNING",
"description": "",
"deviceCount": 2,
"edgeId": 2,
"edgeName": "华北_保定_联通"
},
{
"spaceId": 1000618,
"spaceName": "ai-space-w",
"type": "RTMP",
"status": "RUNNING",
"description": "",
"deviceCount": 4,
"edgeId": 2,
"edgeName": "华北_保定_联通"
},
{
"spaceId": 1000621,
"spaceName": "limingyangTest",
"type": "GB28181",
"status": "RUNNING",
"description": "miaoshu",
"deviceCount": 1,
"edgeId": 2,
"edgeName": "华北_保定_联通"
},
{
"spaceId": 1000624,
"spaceName": "qwertyu",
"type": "RTMP",
"status": "RUNNING",
"description": "",
"deviceCount": 7,
"edgeId": 2,
"edgeName": "华北_保定_联通"
},
{
"spaceId": 1000652,
"spaceName": "wangningTest",
"type": "GB28181",
"status": "RUNNING",
"description": "",
"deviceCount": 1,
"edgeId": 2,
"edgeName": "华北_保定_联通"
}
],
"marker": "1000615",
"nextMarker": "1000652",
"truncated": true
}
错误码
参考公共错误码