查询设备列表
最近更新时间：2025-02-21 02:50:53
1. 接口描述
接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。
查询设备列表。
2. 请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeDevices | 操作接口名，系统规定参数。 |
| InProtocol | String | 否 | ehome | 使用的接入协议。 取值: ehome 虚拟业务组vgroup时，可为空 |
| GroupId | String | 是 | 32388487739092994 | 根据设备所属组ID查询。 |
| ParentDeviceId | String | 否 | 32388487739092995 | 根据设备所属上级设备ID查询。 |
| DirId | String | 否 | 897098424844288 | 根据设备所属目录ID查询。 |
| DeviceVendor | String | 否 | 海康 | 根据设备厂商查询。 |
| DeviceName | String | 否 | 高空抛物摄像头 | 根据设备名称查询。 |
| DeviceType | String | 否 | ipc | 根据设备类型查询。 取值: ipc,nvr,platform |
| DeviceStatus | String | 否 | on | 根据设备状态查询。 取值：on(在线), off(离线), new(未注册)。 |
| StreamNum | Long | 否 | 1 | 取值: 1: 主码流 2: 子码流 3: 第三码流 |
| StreamStatus | String | 否 | on | 根据流状态查询。 取值：on(在线), off(离线), failed(失败)。 |
| SortBy | String | 否 | CreatedTime | 选择按一个字段排序，可选值为： - DeviceID - CreatedTime - UpdatedTime 默认为CreatedTime，按照创建时间排序。 |
| SortDirection | String | 否 | asc | 排序方式，默认升序。 取值：asc(升序), desc(降序)。 |
| PageNum | Long | 否 | 1 | 第几个分页，默认为1。 |
| PageSize | Long | 否 | 20 | 分页大小，默认为20。 取值范围为1～1000 |
| IncludeDeviceStats | Long | 否 | 0 | 是否返回设备统计信息，默认0。 取值：0(不返回), 1(返回) |
| IncludeDeviceDir | Long | 否 | 0 | 是否返回目录信息，默认0。 取值：0(不返回), 1(返回) |
3. 返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| PageNum | Long | 第几个分页。 |
| PageSize | Long | 分页大小。 |
| TotalPage | Long | 分页总数。 |
| TotalNum | Long | 设备总数。 |
| Devices | Device[] | 设备列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
Device
| 参数 | 类型 | 描述 |
|---|---|---|
| DeviceId | String | 设备ID。 |
| GroupId | String | 设备所属组ID。 |
| ParentDeviceId | String | 上级设备ID，比如摄像头所属的NVR设备ID。 |
| DirId | String | 设备所属目录ID。 |
| GbId | String | 设备国标ID。 |
| DeviceType | String | 设备类型。 取值: ipc, nvr, platform |
| EhomeVersion | String | ehome版本。 取值: 2.0, 4.0, 5.0 |
| DeviceVendor | String | 设备厂商。 |
| DeviceName | String | 设备名称。 |
| Description | String | 设备描述。 |
| DeviceIp | String | 设备IP。 |
| DevicePort | Long | 设备Port。 |
| DeviceStatus | String | 设备状态。 取值：on(在线), off(离线), new(未注册)。 |
| PullType | Long | 是否启用自动拉流，默认继承组PullType，但如果设置了该字段，则会覆盖组下面的PullType值。 取值：1, 2 取值为1，自动拉流，国标设备注册成功后自动启动拉流； 取值为2，按需拉流，需要通过触发的方式启动拉流。 |
| TransPriority | String | 设备视频流优先传输协议，默认tcp。 取值：tcp, udp。 取值为tcp，如果设备支持tcp协议传输，设备进行视频邀约时优先使用tcp协议接入到vss服务中。 取值为udp，设备进行视频邀约时优先使用udp协议接入到vss服务中。 |
| ChannelSize | Long | 设备通道数量，nvr设备时才需要填写。 |
| CreateSubDevice | Long | 是否自动创建子设备，默认1。 取值：1(自动创建), 2(手动创建) |
| ChannelNum | Long | 手动创建子设备时，需指定通道号 |
| ChannelName | String | 手动创建子设备时，需指定通道名称 |
| MultiStreamSize | Long | 主子码流数量，默认为1。 取值: 1: 单码流（仅有一种码流） 2: 双码流（主、子码流） 3: 三码流（主、子、第三码流） |
| AutoStreamNum | Long | 自动拉取第几个码流。 PullType取值为1，该字段为必选项。 取值: 1: 主码流 2: 子码流 3: 第三码流 |
| DeviceChannels | DeviceChannel[] | nvr设备通道列表。 ipc设备忽略该字段，nvr设备才返回。 |
| DeviceStreams | DeviceStream[] | 设备对应的流信息 |
| DeviceLongitude | String | 经度 |
| DeviceLatitude | String | 维度 |
| GbRegion | String | 国标地区编码 |
| GbRegionLevel | Long | 国标地区级别 |
| RecordStatus | Long | 录制任务状态 |
| RecordTaskId | Long | 录制任务ID |
| StreamTransType | String | 流传输类型。 ps_rtp_udp: PS over RTP UDP ps_rtp_tcp: PS over RTP TCP h264_rtp_udp: H264 over RTP UDP h264_rtp_tcp: H264 over RTP TCP |
| CreatedTime | String | 设备创建时间。 |
| UpdatedTime | String | 设备更新时间。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
DeviceChannel
| 参数 | 类型 | 描述 |
|---|---|---|
| ChannelNum | Long | 通道号。 |
| ChannelName | String | 通道名称。 |
| GbId | String | 设备国标ID。 |
| DeviceId | String | 设备ID。 |
| DeviceStatus | String | 设备状态。 取值：on(在线), off(离线), new(未注册)。 |
| DeviceStreams | DeviceStream[] | 设备对应的流信息 |
| CreatedTime | String | 子设备（通道）创建时间。 |
| UpdatedTime | String | 子设备（通道）更新时间。 |
DeviceStream
| 参数 | 类型 | 描述 |
|---|---|---|
| StreamNum | Long | 通道号。 |
| StreamStatus | String | 流状态。 取值：on(在线), off(离线), failed(失败)。 |
4. 示例
4.1 请求示例
https://vssapi.ctyun.cn/
?Action=DescribeDevice
&InProtocol=gb28181
&DeviceId=29942114322219022
&IncludeDeviceDir=1
&IncludeDeviceStats=1
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=OMq1XDhZGNLkkkGl6VjMzADgk4w%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=174345971
&SignatureVersion=1.0
&Timestamp=1599108494
4.2 返回示例
{
"DeviceId": "29942114322219022",
"GroupId": "748928498239799296",
"ParentDeviceId": "-1",
"DirId": "748928844311822336",
"DeviceType": "nvr",
"DeviceVendor": "",
"DeviceName": "nvr2",
"Description": "",
"DeviceIp": "",
"DevicePort": 0,
"InProtocol": "gb28181",
"UserName": "device",
"UserPassword": "123456",
"GbId": "34082400011188226858",
"PullType": 1,
"TransPriority": "tcp",
"DeviceEnabled": 1,
"DeviceStatus": "on",
"StreamStatus": "",
"SipTransType": "",
"StreamTransType": "ps_rtp_udp",
"CreateSubDevice": 1,
"GbVersion": "2011",
"DeviceChannels": [
{
"ChannelNum": 1,
"ChannelName": "通道1",
"GbId": "34082400011328367668",
"DeviceId": "29942045602742287",
"DeviceStatus": "on",
"StreamStatus": "failed",
"CreatedTime": "2020-08-31 09:43:55",
"UpdatedTime": "2020-09-02 19:21:04"
},
{
"ChannelNum": 2,
"ChannelName": "通道2",
"GbId": "34082400011328546061",
"DeviceId": "29941979030749200",
"DeviceStatus": "on",
"StreamStatus": "on",
"CreatedTime": "2020-08-31 09:43:56",
"UpdatedTime": "2020-09-02 19:21:04"
}
],
"DeviceStats": {
"ChannelSize": 2,
"OnlineChannels": 2,
"OfflineChannels": 0,
"OnlineStreams": 1,
"OfflineStreams": 0,
"FailedStreams": 1
},
"DeviceDir": {
"DirId": "748928844311822336",
"DirName": "device",
"Description": "",
"GroupId": "748928498239799296",
"ParentDirId": "0",
"CreatedTime": "2020-08-28 15:35:51",
"UpdatedTime": "2020-08-28 15:35:51"
},
"CreatedTime": "2020-08-31 09:43:55",
"UpdatedTime": "2020-09-02 19:21:04",
"RequestId": "436c7c0e49fa49db86e32f244091276b"
}
5. 错误码
| ErrorCode | ErrorMessage |
|---|---|
本页目录：