1. 接口描述

接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500 次/秒。

查询设备信息。

2. 请求参数

参数	类型	是否必选	示例值	描述
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 查询时可使用此参数。
RealGroupId	String	否	672386441693560832	设备真实业务组 ID（兼容 vgroup 协议）。

3. 返回参数

参数	类型	描述
DeviceId	String	设备 ID。
GroupId	String	设备所属组 ID。
ParentDeviceId	String	上级设备 ID，比如摄像头所属的 NVR 设备 ID。
DirId	String	设备所属目录 ID。
DeviceType	String	设备类型。取值: ipc, nvr, platform
GbVersion	String	国标版本。取值: 2011, 2016
DeviceVendor	String	设备厂商。
DeviceName	String	设备名称。
Description	String	设备描述。
DeviceIp	String	设备 IP。
DevicePort	Long	设备 Port。
InProtocol	String	设备使用的接入协议。取值: gb28181~~, rtmp, onvif, rtsp~~
UserName	String	设备用户名，在创建 GB28181 凭证时生成。
UserPassword	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 UDP ps_rtp_tcp: PS over RTP TCP h264_rtp_udp: H264 over RTP UDP h264_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	Int	录制状态。
RecordTaskId	String	录制任务 ID。
GbRegion	String	设备区域编码。
GbRegionLevel	String	设备区域级别。
PushType	Int	是否启用自动激活推流地址。
InType	String	视频流接入方式。
PushUrl	String	推流地址。
PullUrl	String	拉流地址。
Tags	String	标签。
MultiStreamSize	Int	主子码流数量。
AutoStreamNum	Int	自动拉取第几个码流。
DeviceSn	String	设备 ID 序列号。
DeviceFirmware	String	设备固件号。
DeviceHardware	String	设备硬件号。
DevicePosition	String	设备位置。
DevicePubIp	String	设备公网出口 Ip。
DevicePubPort	Int	设备公网出口 Port。
EhomeVersion	String	ehome 版本。
ChannelSize	Int	通道数量。
ChannelNum	Int	通道号。
ChannelName	String	通道名称。
DeviceStreams	string[]	设备视频流信息。
DeviceLongitude	String	设备经度。
DeviceLatitude	String	设备纬度。
DeviceDomain	String	设备域名。
EnableDomain	Int	是否启用域名。
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	目录修改时间。

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=DescribeDevice
&InProtocol=gb28181
&DeviceId=568037376560250882
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=OMq1XDhZGNLkkkGl6VjMzADgk4w%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=174345971
&SignatureVersion=1.0
&Timestamp=1599108494

4.2 返回示例

{
  "DeviceId": "568037376560250882",
  "GroupId": "568037376560250880",
  "ParentDeviceId": "-1",
  "DirId": "-1",
  "DeviceType": "ipc",
  "DeviceVendor": "海康",
  "DeviceName": "createds",
  "Description": "xxx路口摄像头",
  "DeviceIp": "",
  "DevicePort": 0,
  "InProtocol": "gb28181",
  "UserName": "creategnhsta",
  "UserPassword": "Cert123@",
  "GbId": "51030300101327015065",
  "PullType": 1,
  "TransPriority": "tcp",
  "DeviceEnabled": 0,
  "DeviceStatus": "new",
  "StreamStatus": "",
  "SipTransType": "",
  "StreamTransType": "",
  "CreateSubDevice": -1,
  "GbVersion": "2016",
  "DeviceChannels": [],
  "DeviceStats": null,
  "DeviceDir": null,
  "CreatedTime": "2022-10-06 19:44:29",
  "UpdatedTime": "2022-10-06 19:44:30",
  "RequestId": "009ead555ddb405494189f0d4f7ec1c4",
  "RecordStatus": 0,
  "RecordTaskId": "",
  "GbRegion": "51030300",
  "GbRegionLevel": "3",
  "PushType": 0,
  "InType": "",
  "PushUrl": "",
  "PullUrl": "",
  "Tags": "",
  "MultiStreamSize": 0,
  "AutoStreamNum": 0,
  "DeviceModel": "",
  "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": ""
}

5. 错误码

ErrorCode	ErrorMessage

查询设备

最近更新时间：2025-02-21 02:50:53

1. 接口描述

2. 请求参数

3. 返回参数

DeviceChannel

DeviceStream

DeviceStats

DeviceDir

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码