文档中心 > 查询镜头设备列表
查询镜头设备列表

最近更新时间:2022-09-07

1、功能介绍

查询镜头设备列表,镜头设备指的是IPC和通道。

2、请求参数

参数

是否必选

参数类型

描述

ActionString系统指定参数。取值:QueryCamera
DeviceIdString按设备ID查询,支持多值查询(最大100个),用英文逗号分割。

Name

String

按设备名称查询(支持模糊查询)

GroupId

String

按空间ID查询。

GbDeviceId、DeviceStatus、StreamStatus 不为空时此字段必传

GbDeviceIdString按国标ID查询(需要指定GroupId)
ManageStatusString

根据设备启用状态查询,启用:active 停用:stop(不区分大小写)

DeviceStatusString按设备上下线状态查询,在线:online 离线:offline 未注册:unregistered (如果不为空,需要指定GroupId)
StreamStatusString按流状态查询,在线:on 离线:off (如果不为空,需要指定GroupId)
PageSizeInteger

分页大小,默认为20

PageNumInteger第几分页,默认为1

3、响应参数

参数

是否必选

参数类型

描述

RequestId

String

该条接口请求ID

CodeString错误码 0:表示成功
MessageString提示信息
DataObject返回数据
--TotalCount

Integer

镜头总数
--PageNumInteger当前页
--PageSizeInteger分页大小
--PageTotalInteger分页总数
--CameraList
array of camera objects镜头列表


camera 定义

参数是否必选参数类型描述
DeviceIdString设备ID
TypeString设备类型。取值:ipc、channel
NameString设备名称。

GroupId

String

设备所属空间ID。

GroupNameString设备所述空间名称。
ParentIdString上级设备ID
ParentNameString上级设备名称
ChannelIdLong通道号
GbDeviceIdString设备国标ID
SupportPtzInteger是否支持云台。取值: 0(不支持) 1(支持)
StreamNameString流名称。
PushUrlString推流地址
ManageStatusString设备管理状态。取值:active(启用)、stop(停用)

DeviceStatus

String

设备状态,取值:online(在线)、offline(离线)、unregistered(未注册)
StreamStatusString流状态。取值:on(在线),off(不在线)

BusinessStatu

String设备业务状态,4位状态位0000,从右到左依次为: 计划录制状态,手动录制状态,计划截图状态,手动截图状态。(状态位更新有3-6分钟左右延迟)0:空闲 1:开启中
CreateTimeString创建日期,格式如:yyyy-MM-ddTHH:mm:ssZ,UTC时间
UpdateTimeString更新日期,格式如:yyyy-MM-ddTHH:mm:ssZ,UTC时间



4、请求示例

请求示例:

GET https://api.unicloud.com/univms?

Action=QueryCamera

&Name=测试设备-0000

&GroupId=uni0341122041424855039

&公共请求参数

返回示例:

国标空间下ipc、channel

{
    "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"
            }
        ]
    }
}
rtmp空间下设备
{
    "RequestId": "dcc7e3a1-47d7-4f44-ba02-c47af473b320",
    "Code": "0",
    "Data": {
        "PageSize": 20,
        "PageNum": 1,
        "TotalCount": 1,
        "PageTotal": 1,
        "CameraList": [
            {
                "DeviceId": "uni0340001122060134481927",
                "Type": "rtmp",
                "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"
            }
        ]
    }
}

5、状态码

状态码

描述

200

OK

400

Bad Request