最近更新时间：2022-07-05
查询已删除设备的空间列表。支持空间类型、已删除设备ID查询。默认查询所有已删除设备的空间列表。
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 系统规定参数。取值：QueryGroupOfDelDevice |
| DeviceId | 否 | String | 按已删除设备ID查询 |
DeviceProtocol | 否 | String | 按空间使用的接入协议查询。取值：rtmp、gb28181，不区分大小写。 |
| 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 | 空间数量 |
| --GroupInfoList | 是 | array of groupInfo objects | 空间列表 |
groupInfo 定义
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
GroupId | 是 | String | 空间ID |
| Name | 是 | String | 空间名称 |
| Region | 是 | String | 空间所属区域 |
DeviceProtocol | 是 | String | 空间使用的接入协议。取值：rtmp、gb28181 |
EnableHls | 是 | Bool | 是否开启HLS，取值：true、false |
| PushDomain | 否 | String | 空间使用的推流域名。 |
| PushDomainCName | 否 | String | 推流CName |
| 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表示永久保存 |
| GbServerId | 否 | String | 空间提供的国标信令服务器ID |
| GbServerDomain | 否 | String | 空间提供的国标信令服务器域 |
| GbServerHost | 否 | String | 空间提供的国标信令服务器地址 |
GbServerTcpPort | 否 | Long | 空间提供的国标信令服务器TCP端口 |
GbServerUdpPort | 否 | Long | 空间提供的国标信令服务器UDP端口 |
PushPrivateKey | 否 | String | 推流鉴权key |
| CreateTime | 否 | String | 创建时间，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
| UpdateTime | 否 | String | 最近一次更新时间，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
请求示例:
GET https://api.unicloud.com/univms?
Action=QueryGroupOfDelDevice
&DeviceId=uni0340001122061976933144
&公共请求参数
返回示例:
国标空间：
{
"RequestId": "684cb252-ad6f-4683-917c-1f1a0a46f620",
"Code": "0",
"Data": {
"PageSize": 20,
"PageNum": 1,
"PageTotal": 1,
"TotalCount": 1,
"GroupInfoList": [
{
"GroupId": "uni0341122060286924475",
"Name": "测试国标空间",
"Region": "cn-tianjin-test",
"DeviceProtocol": "gb28181",
"EnableHls": true,
"Callback": "www.backback.com",
"CallbackDeviceStatus": "false",
"CallbackStreamStatus": "true",
"CallbackRecord": "false",
"CallbackSnapshot": "false",
"CallbackPrivateKey": "",
"ManageStatus": "active",
"IsDeleted": 0,
"StoreDays": 0,
"GbServerId": "12000000002007142885",
"GbServerDomain": "1200000000",
"GbServerHost": "10.0.0.1",
"GbServerTcpPort": 5080,
"GbServerUdpPort": 5080,
"CreateTime": "2022-06-22T07:59:51Z",
"UpdateTime": "2022-06-22T08:08:19Z"
}
]
}
}
RTMP空间：
{
"RequestId": "7bded4ea-b2cb-457c-8b56-ae3b9bbf92ae",
"Code": "0",
"Data": {
"PageSize": 20,
"PageNum": 1,
"PageTotal": 1,
"TotalCount": 1,
"GroupInfoList": [
{
"GroupId": "uni0341122060388608507",
"Name": "测试rtmp空间",
"Region": "cn-tianjin-test",
"DeviceProtocol": "rtmp",
"EnableHls": true,
"PushDomain": "rtmp.pushdomain.param",
"PushDomainCName": "rtmp.pushdomain.param.gslb.zgycdn.com",
"Callback": "",
"CallbackDeviceStatus": "false",
"CallbackStreamStatus": "false",
"CallbackRecord": "false",
"CallbackSnapshot": "false",
"CallbackPrivateKey": "callbackkey",
"ManageStatus": "active",
"IsDeleted": 0,
"StoreDays": 0,
"PushPrivateKey": "testkey",
"CreateTime": "2022-06-22T08:21:45Z",
"UpdateTime": "2022-06-22T08:21:45Z"
}
]
}
} |
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
