最近更新时间：2022-11-04
查询镜头设备列表，镜头设备指的是IPC和通道。
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 系统指定参数。取值：QueryCamera |
| DeviceId | 否 | String | 按设备ID查询，支持多值查询（最大100个），用英文逗号分割。 |
| ParentId | 否 | String | 按父设备ID查询（适用于查询NVR和下级平台的所有通道列表） |
Type | 否 | String | 按设备类型查询。取值：ipc、nvr、platform (如果不为空，需要指定GroupId) |
ParentGbDeviceId | 否 | String | 关联设备国标ID (如果不为空，需要指定GroupId) |
ParentName | 否 | String | 关联设备名称 |
Name | 否 | String | 按设备名称查询(支持模糊查询) |
GroupId | 否 | String | 按空间ID查询。 GbDeviceId、DeviceStatus、StreamStatus, ParentGbDeviceId, Type 不为空时此字段必传 |
| GbDeviceId | 否 | String | 按国标ID查询（需要指定GroupId） |
| ManageStatus | 否 | String | 根据设备启用状态查询，启用:active 停用:stop(不区分大小写) |
| DeviceStatus | 否 | String | 按设备上下线状态查询，在线:online 离线:offline 未注册:unregistered (如果不为空，需要指定GroupId) |
| StreamStatus | 否 | String | 按流状态查询，在线:on 离线:off (如果不为空，需要指定GroupId) |
| PageSize | 否 | Integer | 分页大小，默认为20 |
| PageNum | 否 | Integer | 第几分页，默认为1 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
RequestId | 是 | String | 该条接口请求ID |
| Code | 是 | String | 错误码 0:表示成功 |
| Message | 否 | String | 提示信息 |
| Data | 否 | Object | 返回数据 |
| --TotalCount | 是 | Integer | 镜头总数 |
| --PageNum | 是 | Integer | 当前页 |
| --PageSize | 是 | Integer | 分页大小 |
| --PageTotal | 是 | Integer | 分页总数 |
--CameraList | 是 | array of camera objects | 镜头列表 |
camera 定义
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| DeviceId | 是 | String | 设备ID |
| Type | 是 | String | 设备类型。取值：ipc、channel |
| Name | 是 | String | 设备名称。 |
GroupId | 是 | String | 设备所属空间ID。 |
| GroupName | 是 | String | 设备所述空间名称。 |
| ParentId | 否 | String | 上级设备ID |
| ParentName | 否 | String | 上级设备名称 |
| ChannelId | 否 | Long | 通道号 |
| GbDeviceId | 否 | String | 设备国标ID |
SupportPtz | 否 | Integer | 是否支持云台。取值： 0（不支持） 1（支持） |
| StreamName | 否 | String | 流名称。 |
| PushUrl | 否 | String | 推流地址 |
| ManageStatus | 是 | String | 设备管理状态。取值：active（启用）、stop（停用） |
DeviceStatus | 是 | String | 设备状态。取值：online（在线）、offline（离线）、unregistered（未注册） |
| StreamStatus | 是 | String | 流状态。取值：on（在线），off（不在线） |
| BusinessStatus | 是 | String | 设备业务状态，4位状态位0000,从右到左依次为: 计划录制状态,手动录制状态,计划截图状态,手动截图状态。（状态位更新有3-6分钟左右延迟）0:空闲 1:开启中 |
| CreateTime | 是 | String | 创建日期，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
| UpdateTime | 是 | String | 更新日期，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
| LastOnlineTime | 否 | String | 设备最后一次在线时间 格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
请求示例:
GET https://api.unicloud.com/univms?
Action=QueryCamera
&Name=测试设备-0000
&GroupId=uni0341122041424855039
&公共请求参数
返回示例:
国标空间下ipc、channel(nvr)
{
"RequestId": "24422479-50ba-45d5-9172-8bb129a5a90d",
"Code": "0",
"Data": {
"PageSize": 20,
"PageNum": 1,
"TotalCount": 2,
"PageTotal": 1,
"CameraList": [
{
"DeviceId": "uni0340011122060593909060",
"Type": "ipc",
"Name": "测试设备-00001",
"GroupId": "uni03411202109f70ec206",
"GroupName": "测试空间",
"ParentId": "uni0340011122060593909060",
"ParentName": "测试设备-00001",
"GbDeviceId": "12000000001320399551",
"ManageStatus": "active",
"DeviceStatus": "unregistered",
"StreamStatus": "off",
"CreateTime": "2022-06-01T05:51:48Z",
"UpdateTime": "2022-06-01T05:51:48Z"
},
{
"DeviceId": "uni0340031122062076407929",
"Type": "channel",
"Name": "测试设备-00004",
"GroupId": "uni03411202109f70ec206",
"GroupName": "测试空间",
"ParentId": "uni0340021122060206265556",
"ParentName": "测试设备-00003",
"ChannelId": "1",
"GbDeviceId": "12000000001320323994",
"ManageStatus": "active",
"DeviceStatus": "offline",
"StreamStatus": "off",
"CreateTime": "2022-06-01T06:34:05Z",
"UpdateTime": "2022-06-01T06:34:05Z"
}
]
}
}
channel(platform)
{
"RequestId": "071c4416-7f7d-45e9-aca4-ca8801753582",
"Code": "0",
"Data": {
"PageSize": 20,
"PageNum": 1,
"TotalCount": 1,
"PageTotal": 1,
"CameraList": [
{
"DeviceId": "uni0340031122071116899151",
"Type": "channel",
"Name": "通道一",
"GroupId": "uni03411202109f70ec206",
"GroupName": "上海测试空间",
"ParentId": "uni0340041122070426267133",
"ParentName": "测试级联设备0004",
"ChannelId": "0",
"GbDeviceId": "13050111091327000001",
"ManageStatus": "stop",
"DeviceStatus": "offline",
"StreamStatus": "on",
"CreateTime": "2022-07-21T11:34:58Z",
"UpdateTime": "2022-07-26T01:06:17Z",
"SupportPtz": 1,
"BusinessStatus": "0000"
}
]
}
}
rtmp空间下设备
{
"RequestId": "dcc7e3a1-47d7-4f44-ba02-c47af473b320",
"Code": "0",
"Data": {
"PageSize": 20,
"PageNum": 1,
"TotalCount": 1,
"PageTotal": 1,
"CameraList": [
{
"DeviceId": "uni0340001122060134481927",
"Type": "ipc",
"Name": "测试设备-00002",
"GroupId": "uni0341122041424855039",
"GroupName": "121212",
"ParentId": "",
"GbDeviceId": "",
"StreamName": "uni0340001122060134481927",
"PushUrl": "rtmp://www.baidu.com/uni0341122041424855039/uni0340001122060134481927?token=695016168013ca6ba74f7f94a1d25573&time=1654067537",
"ManageStatus": "stop",
"DeviceStatus": "unregistered",
"StreamStatus": "off",
"CreateTime": "2022-06-01T05:55:45Z",
"UpdateTime": "2022-06-01T06:32:28Z"
}
]
}
} |
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
