最近更新时间：2022-10-21
查询业务空间
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 系统规定参数。取值：QueryGroup |
Region | 否 | String | 按空间区域查询 |
| GroupId | 否 | String | 按空间ID查询 |
Name | 否 | String | 按空间名称查询 |
DeviceProtocol | 否 | String | 按空间使用的接入协议查询。取值：rtmp、gb28181，不区分大小写。 |
ManageStatus | 否 | String | 按空间状态查询 active 激活 stop 停用 (不区分大小写) |
| PageSize | 否 | Long | 分页大小，默认为20 |
| PageNum | 否 | Long | 第几分页，默认为1 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
RequestId | 是 | String | 该条接口请求ID |
| Code | 是 | String | 0成功 其他失败 |
| Message | 否 | String | 错误信息 |
| Data | 否 | Object | 返回值，json对象结构 |
--PageSize | 否 | Long | 分页大小，默认为20 |
| --PageNum | 否 | Long | 第几分页，默认为1 |
| --PageTotal | 否 | Long | 分页总数，默认为1 |
| --TotalCount | 否 | Long | 空间数量 |
| --GroupList | 否 | array of group objects | 空间列表 |
group定义(详细属性需调用查询空间详情接口，本接口只查询以下字段，其余字段返回空或默认值)
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
GroupId | 是 | String | 空间ID |
| Name | 是 | String | 空间名称 |
| Region | 是 | String | 空间所属区域 |
DeviceProtocol | 是 | String | 空间使用的接入协议。取值：rtmp、gb28181 |
EnableHls | 是 | Bool | 是否开启HLS，取值：true、false |
| EnableAudio | 否 | Bool | 是否开启音频，取值：true、false |
| Callback | 否 | String | 空间内设备状态、流状态更新时通知用户业务端的回调接口 |
| CallbackDeviceStatus | 是 | Bool | 设备回调状态 |
| CallbackStreamStatus | 是 | Bool | 流回调状态 |
| CallbackRecord | 是 | Bool | 录像回调状态 |
| CallbackSnapshot | 是 | Bool | 截图回调状态 |
| CallbackPrivateKey | 否 | String | 回调接口鉴权密钥。 |
| ManageStatus | 是 | String | 空间管理状态，取值：active、stop |
| IsDeleted | 是 | Long | 是否已删除，取值：0（否），1（是） |
| StoreDays | 是 | Long | 录像、截图等文件存储天数，单位天。取值：0～1825(5年：5*365天)，0表示永久保存 |
| CreateTime | 否 | String | 创建时间，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
| UpdateTime | 否 | String | 最近一次更新时间，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
| DeviceNum | 否 | Long | 空间下设备数 |
请求示例:
GET https://api.unicloud.com/univms?
Action=QueryGroup
&Name=测试
&公共请求参数
返回示例:
{
"RequestId": "7a474b3c-80de-45e0-b2c4-8e55b3d379c7",
"Code": "0",
"Data": {
"PageSize": 20,
"PageNum": 1,
"PageTotal": 1,
"TotalCount": 2,
"GroupList": [
{
"GroupId": "uni0341122060286924475",
"Name": "测试国标空间",
"Region": "cn-tianjin-test",
"DeviceProtocol": "gb28181",
"EnableHls": true,
"Callback": "www.backback.com",
"CallbackDeviceStatus": false,
"CallbackStreamStatus": true,
"CallbackRecord": false,
"CallbackSnapshot": false,
"CallbackPrivateKey": "callbackkey",
"ManageStatus": "active",
"IsDeleted": 0,
"StoreDays": 0,
"DeviceNum": 4,
"CreateTime": "2022-06-22T07:59:51Z",
"UpdateTime": "2022-06-22T08:08:19Z"
},
{
"GroupId": "uni0341122061402596026",
"Name": "测试rtmp空间",
"Region": "cn-tianjin-test",
"DeviceProtocol": "rtmp",
"EnableHls": true,
"Callback": "http://www.callbacktest.com",
"CallbackDeviceStatus": false,
"CallbackStreamStatus": true,
"CallbackRecord": true,
"CallbackSnapshot": true,
"CallbackPrivateKey": "callbackkey",
"ManageStatus": "active",
"IsDeleted": 0,
"StoreDays": 0,
"DeviceNum": 0,
"CreateTime": "2022-06-28T07:04:05Z",
"UpdateTime": "2022-06-28T07:04:05Z"
}
]
}
} |
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
