功能介绍
默认接口请求频率限制：500次/秒。
查询设备信息。
接口约束
- 查询设备前确保该设备存在。
- IncludeDeviceStats与IncludeDeviceDir仅在使用DeviceId查询时有效。
URL
GET /v1?
请求参数
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| Action |
String |
是 |
DescribeDevice |
操作接口名，系统规定参数。 |
| InProtocol |
String |
是 |
gb28181 |
使用的接入协议。取值: gb28181 |
| DeviceId |
String |
是 |
32388487739092996 |
设备ID。 |
| SerialNumber |
String |
否 |
123xxx |
设备SN码（DeviceId和SerialNumber二选一）。 |
| IncludeDeviceStats |
Long |
否 |
0 |
是否返回设备统计信息，默认0。取值：0(不返回), 1(返回)根据设备id查询时可使用此参数。 |
| IncludeDeviceDir |
Long |
否 |
0 |
是否返回目录信息，默认0。取值：0(不返回), 1(返回)根据设备id查询时可使用此参数。 |
返回参数
| 参数 |
类型 |
描述 |
| DeviceId |
String |
设备ID。 |
| GroupId |
String |
设备所属组ID。 |
| ParentDeviceId |
String |
上级设备ID，比如摄像头所属的NVR设备ID。 |
| DirId |
String |
设备所属目录ID。 |
| DeviceType |
String |
设备类型。取值: ipc, nvr |
| GbVersion |
String |
国标版本。取值: 2011, 2016 |
| DeviceVendor |
String |
设备厂商。 |
| DeviceName |
String |
设备名称。 |
| Description |
String |
设备描述。 |
| DeviceIp |
String |
设备IP。 |
| DevicePort |
Long |
设备Port。 |
| InProtocol |
String |
设备使用的接入协议。取值: gb28181 |
| UserName |
String |
设备用户名，在创建GB28181凭证时生成。 |
| GbId |
String |
设备国标ID。 |
| PullType |
Long |
是否启用自动拉流。仅gb28181组支持该字段。取值：1, 2取值为1，自动拉流，国标设备注册成功后自动启动拉流；取值为2，按需拉流，需要通过触发的方式启动拉流。 |
| TransPriority |
String |
设备视频流优先传输协议，默认tcp。取值：tcp, udp。取值为tcp，如果设备支持tcp协议传输，设备进行视频邀约时优先使用tcp协议接入到vss服务中。取值为udp，设备进行视频邀约时优先使用udp协议接入到vss服务中。 |
| DeviceEnabled |
Long |
设备是否启用。取值：0(停用), 1(启用) |
| DeviceStatus |
String |
设备状态。取值：on(在线), off(离线), new(未注册)。 |
| StreamStatus |
String |
流状态。取值：on(在线), off(离线), failed(失败)。 |
| SipTransType |
String |
信令传输类型。取值：tcp, udp |
| StreamTransType |
String |
流传输类型。ps_rtp_udp: PS over RTP UDPps_rtp_tcp: PS over RTP TCPh264_rtp_udp: H264 over RTP UDPh264_rtp_tcp: H264 over RTP TCP |
| CreateSubDevice |
Long |
是否自动创建子设备。取值：1(自动创建), 2(手动创建) |
| DeviceChannels |
DeviceChannel[] |
nvr设备通道列表。ipc设备忽略该字段。 |
| DeviceStats |
DeviceStats |
设备统计信息。 |
| DeviceDir |
DeviceDir |
设备目录。 |
| SerialNumber |
String |
设备SN码。 |
| DeviceModel |
String |
设备型号。 |
| CreatedTime |
String |
设备创建时间。 |
| UpdatedTime |
String |
设备更新时间。 |
| RequestId |
String |
唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
| RecordStatus |
Long |
录制状态。 |
| RecordTaskId |
String |
录制任务ID。 |
| GbRegion |
String |
设备区域编码。 |
| GbRegionLevel |
String |
设备区域级别。 |
| PushType |
Int |
是否启用自动激活推流地址。 |
| InType |
String |
视频流接入方式。 |
| PushUrl |
String |
推流地址。 |
| PullUrl |
String |
拉流地址。 |
| Tags |
String |
标签。 |
| MultiStreamSize |
Long |
主子码流数量。 |
| AutoStreamNum |
Long |
自动拉取第几个码流。 |
| DeviceSn |
String |
设备ID序列号。 |
| DeviceFirmware |
String |
设备固件号。 |
| DeviceHardware |
String |
设备硬件号。 |
| DevicePosition |
String |
设备位置。 |
| DevicePubIp |
String |
设备公网出口Ip。 |
| DevicePubPort |
Long |
设备公网出口Port。 |
| EhomeVersion |
String |
ehome版本。 |
| ChannelSize |
Long |
通道数量。 |
| ChannelNum |
Long |
通道号。 |
| ChannelName |
String |
通道名称。 |
| DeviceStreams |
DeviceStream[] |
设备视频流信息。 |
| DeviceLongitude |
String |
设备经度。 |
| DeviceLatitude |
String |
设备纬度。 |
| DeviceDomain |
String |
设备域名。 |
| EnableDomain |
Long |
是否启用域名。 |
| RecordMessage |
String |
录制信息。 |
| IndustryCode |
String |
设备行业编码。 |
| NetworkCode |
String |
设备的网络标识。 |
| Type |
String |
类型。 |
DeviceChannel
| 参数 |
类型 |
描述 |
| ChannelNum |
Long |
通道号。 |
| ChannelName |
String |
通道名称。 |
| GbId |
String |
设备国标ID。 |
| DeviceId |
String |
设备ID。 |
| DeviceStatus |
String |
设备状态。取值：on(在线), off(离线), new(未注册)。 |
| StreamStatus |
String |
流状态。取值：on(在线), off(离线), failed(失败)。 |
| CreatedTime |
String |
子设备（通道）创建时间。 |
| UpdatedTime |
String |
子设备（通道）更新时间。 |
| RecordStatus |
Long |
录制状态。 |
| RecordTaskId |
String |
录制任务ID。 |
| InType |
String |
视频流接入方式。 |
| MultiStreamSize |
Long |
主子码流数量。 |
| AutoStreamNum |
Long |
自动拉取第几个码流。 |
| ParentDeviceId |
String |
父设备id |
| CreateSubDevice |
Long |
是否自动创建子设备。 |
| DeviceVendor |
String |
设备厂商。 |
| DeviceStreams |
DeviceStream[] |
设备视频流信息。 |
| RecordMessage |
String |
录制信息。 |
DeviceStream
| 参数 |
类型 |
描述 |
| StreamNum |
Long |
视频流编号。 |
| StreamStatus |
String |
视频流状态。 |
DeviceStats
| 参数 |
类型 |
描述 |
| ChannelSize |
Long |
通道数量。 |
| OnlineChannels |
Long |
在线通道数量。 |
| OfflineChannels |
Long |
离线通道数量。 |
| OnlineStreams |
Long |
在线流数量。 |
| OfflineStreams |
Long |
离线流数量。 |
| FailedStreams |
Long |
失败流数量。 |
| MaxChannelSize |
Long |
最大通道数量。 |
DeviceDir
| 参数 |
类型 |
描述 |
| DirId |
String |
目录ID。 |
| DirName |
String |
目录名称。 |
| Description |
String |
目录描述。 |
| GroupId |
String |
目录所属组ID。 |
| ParentDirId |
String |
上级目录ID。 |
| CreatedTime |
String |
目录创建时间。 |
| UpdatedTime |
String |
目录修改时间。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=DescribeDevice&DeviceId=581824359021756416&InProtocol=gb28181
Connection: keep-alive
ctyun-eop-request-id: 9c8f4d18-17e6-473e-8a04-4bf8aca75e79
Eop-date: 20221025T093446Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=Uljmans4fiOc79TuPXuHc//rAuffeodykV1e5xWBLW4=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13
返回示例
{
"DeviceId": "581824359021756416",
"GroupId": "556002285492715528",
"ParentDeviceId": "-1",
"DirId": "-1",
"DeviceType": "ipc",
"DeviceVendor": "海康",
"DeviceName": "create1i1",
"Description": "设备描述",
"DeviceIp": "192.168.0.1",
"DevicePort": 8080,
"InProtocol": "gb28181",
"UserName": "ttttt123",
"UserPassword": "Cert123",
"GbId": "51030300101327017396",
"PullType": 1,
"TransPriority": "tcp",
"DeviceEnabled": 1,
"DeviceStatus": "new",
"StreamStatus": "",
"SipTransType": "",
"StreamTransType": "",
"CreateSubDevice": -1,
"GbVersion": "2016",
"DeviceChannels": [
],
"DeviceStats": null,
"DeviceDir": null,
"CreatedTime": "2022-10-25 09:34:45",
"UpdatedTime": "2022-10-25 09:34:45",
"RequestId": "d6c5f5f6dd284777a46bdffcd9da599e",
"RecordStatus": 0,
"RecordTaskId": "",
"GbRegion": "51030300",
"GbRegionLevel": "3",
"PushType": 0,
"InType": "",
"PushUrl": "",
"PullUrl": "",
"Tags": "",
"MultiStreamSize": 0,
"AutoStreamNum": 0,
"DeviceModel": "IPC设备",
"DeviceSn": "",
"DeviceFirmware": "",
"DeviceHardware": "",
"DevicePosition": "",
"DevicePubIp": "",
"DevicePubPort": 0,
"EhomeVersion": "",
"ChannelSize": 0,
"ChannelNum": 0,
"ChannelName": "",
"DeviceStreams": [
],
"DeviceLongitude": "0",
"DeviceLatitude": "0",
"DeviceDomain": "",
"EnableDomain": 0,
"IndustryCode": "10",
"NetworkCode": "7",
"RecordMessage": "",
"errorCode": "",
"errorMessage": "",
"bitrate": 0,
"MacAddr": "",
"PoleId": "",
"GbRegionNames": [
"贡井区",
"自贡市",
"四川省"
],
"SerialNumber": "设备SN码01"
}
错误码
错误码
