接口功能介绍

本接口用于查询设备列表。

接口约束

按特定条件如设备名称、目录ID、上级设备ID单独查询某设备时确保存在该设备。
请求参数说明：
String类型的参数，传""等同于不传。
Integer类型的参数，传0等同于不传。
Boolean类型的参数，传false等同于不传。

URI

GET /v2/devices

路径参数
无

Query参数

参数	是否必填	参数类型	说明	示例	下级对象
DirId	否	String	根据设备所属目录ID查询，若DirId和ParentDeviceId均为空，则按照DirId为根目录ID查询。	897098424844288
ParentDeviceId	否	String	根据设备所属上级设备ID查询。	32388487739092995
DeviceVendor	否	String	根据设备厂商查询。	海康
DeviceName	否	String	根据设备名称查询。	高空抛物摄像头
DeviceType	否	String	根据设备类型查询。取值：ipc，nvr，platform。	ipc
DeviceStatus	否	String	根据设备状态查询。取值：on(在线)，off(离线)，new(未注册)。	on
StreamStatus	否	String	根据流状态查询。取值：on(在线)，off(离线)，failed(失败)。	on
IncludeDeviceStats	否	Integer	是否返回设备统计信息，默认0。取值：0(不返回)，1(返回)。	1
IncludeDeviceDir	否	Integer	是否返回目录信息，默认0。取值：0(不返回)，1(返回)。	1
SortBy	否	String	选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：CreatedTime，UpdatedTime。	CreatedTime
SortDirection	否	String	排序方式，默认升序。取值：Asc(升序)，Desc(降序)。	Asc
PageNum	否	Integer	第几个分页，默认为1。	1
PageSize	否	Integer	分页大小，默认为20。取值范围为1～1000。	10

请求参数

请求头header参数
无

请求体body参数
无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应状态码。	200
error	String	错误码，执行成功时，不返回该字段。	VSS_0001
message	String	响应信息。	请求成功
requestId	String	请求ID。	362d4e78556b47129182d0881fade86b
returnObj	Object	响应数据，执行失败时，不返回该字段。		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
Devices	Array of Objects	设备列表。		Device
DirStats	Object	目录信息。		DirStats
PageNum	Integer	第几个分页。	1
PageSize	Integer	分页大小。	10
TotalPage	Integer	分页总数。	1
TotalNum	Integer	设备总数。	10
RequestId	String	请求 ID。	362d4e78556b47129182d0881fade86b

表 Device

参数	参数类型	说明	示例	下级对象
Region	String	设备接入区域。	0851002
InNetworkType	String	接入网络类型，默认public。取值：public：互联网；private：专线网络。	public
OutNetworkType	String	播放网络类型，默认public。接入网络类型。取值：public：互联网；private：专线网络。	public
Device	Object	设备信息。		DeviceInfo
Industry	Object	设备归属行业信息。		Industry
VideoDevice	Object	视频协议设备信息。		VideoDevice
ViidDevice	Object	视图协议设备信息。		ViidDevice
CreatedTime	String	创建时间。	1685515845343
UpdatedTime	String	更新时间。	1685515845343

表 DeviceInfo

参数	参数类型	说明	示例	下级对象
DeviceEnabled	Integer	设备是否启用。取值：0：停用； 1：启用。	1
DirId	String	设备所属目录ID。	600001
ParentDeviceId	String	上级设备ID。	32388487739092996
DeviceId	String	设备ID。	32388487739092995
DeviceType	String	设备类型。取值：ipc，nvr，platform。	nvr
DeviceVendor	String	设备厂商。取值：海康，大华，宇视，金三立，华为，科达，其他。	海康
DeviceName	String	设备名称。	摄像头
DeviceLocalName	String	设备本地侧名称。	摄像头
DeviceIp	String	设备ip。	192.168.0.1
DevicePort	Integer	设备端口。	8000
DeviceMac	String	设备mac地址。	00-16-EA-AE-3C-40
DeviceSerialNumber	String	设备sn码，仅ipc设备及nvr通道有效。	xxx
DeviceModel	String	设备型号。	xxx
DeviceLongitude	String	设备经度。	11.11
DeviceLatitude	String	设备纬度。	11.11
DevicePoleId	String	设备杆号。	xxx
InOrgRegion	Integer	设备中心编码（8位），按照设备安装所在地的行政区划代码确定，当不是基层单位时空余位为0。行政区划代码采用GB/T 2260-2007规定的行政区划代码表示。	35010200
InOrgRegionLevel	Integer	设备中心编码级别。	3
DeviceIndustryCode	String	设备所属行业编码。	08
DeviceNetworkCode	String	设备所属网络标识。取值：0、1、2、3、4：监控报警专网；5：公安信息网；6：政务网；7：Internet网；8：社会资源接入网。	7
AutoCreateChannel	Boolean	是否自动创建子设备。	true
DeviceChannelSize	Integer	设备通道数量。	3
DeviceChannelNum	Integer	通道号。	1
Description	String	设备描述。	描述
DeviceDir	Object	设备目录信息。		DeviceDir
DeviceStats	Object	设备统计信息。		DeviceStats

表 DeviceDir

参数	参数类型	说明	示例	下级对象
ParentDirId	String	上级目录ID。	600001
DirId	String	目录ID。	600002
DirName	String	目录名称。	目录
DirCode	String	目录编码。	0
DirPath	String	目录绝对路径。	xxx
Description	String	目录描述。	目录描述
CreatedTime	String	目录创建时间。	1685515845343
UpdatedTime	String	目录修改时间。	1685515845343

表 DeviceStats

参数	参数类型	说明	示例	下级对象
ChannelSize	Integer	通道数量。	1
MaxChannelSize	Integer	最大通道数量。	1
OnlineChannels	Integer	在线通道数量。	1
OfflineChannels	Integer	离线通道数量。	0
OnlineStreams	Integer	在线流数量。	1
OfflineStreams	Integer	离线流数量。	0
FailedStreams	Integer	失败流数量。	0

表 Industry

参数	参数类型	说明	示例	下级对象
InOrgRegion	Integer	设备中心编码（8位），按照设备安装所在地的行政区划代码确定，当不是基层单位时空余位为0。行政区划代码采用GB/T 2260-2007规定的行政区划代码表示。	35010200
InOrgRegionLevel	Integer	设备中心编码级别。	3
DeviceIndustryCode	String	设备所属行业编码。	3
DeviceIndustryName	String	设备所属行业名称。	工业
DeviceNetworkCode	String	设备所属网络标识。取值：0、1、2、3、4：监控报警专网；5：公安信息网；6：政务网；7：Internet网；8：社会资源接入网。	7

表 VideoDevice

参数	参数类型	说明	示例	下级对象
InVideoProtocol	String	接入视频协议分类。取值：gb28181，rtmp，rtsp，ehome。	gb28181
Gb28181Device	Object	国标设备。		Gb28181Device
EhomeDevice	Object	Ehome设备。		EhomeDevice
RtmpDevice	Object	Rtmp设备。		RtmpDevice
RtspDevice	Object	Rtsp设备。		RtspDevice

表 Gb28181Device

参数	参数类型	说明	示例	下级对象
InVersion	String	接入国标版本。	2016
InUserName	String	设备用户名，在创建GB28181凭证时生成。	test
OutId	String	设备国标ID。	11000000541327000032
SipId	String	国标SIP服务器ID。	52010000012008589806
SipIp	String	国标SIP服务器IP。	192.168.0.1
SipTcpPort	Integer	国标SIP服务器TCP端口。	15064
SipUdpPort	Integer	国标SIP服务器UDP端口。	15064
SipTransType	String	国标SIP服务器传输协议。	tcp
StreamTransProtocol	String	媒体流传输协议，默认tcp。取值：tcp，udp。	tcp
AutoStartStream	Boolean	是否启用自动拉流。	true
StreamSize	Integer	主子码流数量。	1
StreamNum	Integer	设备发送第几个码流。	1
EnabledGB35114	Boolean	是否启用GB35114协议。	true
GB35114Mode	Integer	GB35114协议认证方式。取值：1：单向认证；2：双向认证。	1
ErrorCode	String	错误码。	xxx
ErrorMsg	String	错误信息。	xxx
DeviceStatus	Object	设备状态信息。		DeviceStatus
Streams	Array of Objects	流状态信息。		Streams

表 DeviceStatus

参数	参数类型	说明	示例	下级对象
IsOnline	String	是否在线。取值：on(在线)，off(离线)。	on
RegisterTime	String	注册时间。	1685515845343
UnregisterTime	String	注销时间。	1685515845343
KeepliveTime	String	保活时间。	1685515845343

表 Stream

参数	参数类型	说明	示例	下级对象
StreamNum	Integer	第几码流。	1
StreamStatus	String	流状态。	on
StreamTransType	String	流传输类型。取值：ps_rtp_udp：PS over RTP UDP；ps_rtp_tcp：PS over RTP TCP；h264_udp：264 over RTP UDP；h264_tcp：H264 over RTP TCP。	ps_rtp_udp
RecordStatus	String	录制状态。取值：on，off。	on
RecordTaskId	String	录制id。	xxx
Bitrate	String	码率。	xxx
Audio	String	音频信息。	xxx
Video	Object	视频流属性信息。		Video
PlayUrl	Object	流的播放URL。		PlayUrl

表 Video

参数	参数类型	说明	示例	下级对象
Codec	String	编码格式。取值：h264，h265。	h264

表 PlayUrl

参数	参数类型	说明	示例	下级对象
FlvUrl	String	flv播放url。	xxx
HlsUrl	String	hls播放url。	xxx
RtcUrl	String	rtc播放url。	xxx
WebrtcUrl	String	webrtc播放url。	xxx
RtmpUrl	String	rtmp播放url。	xxx
RtspUrl	String	rtsp播放url。	xxx

表 EhomeDevice

参数	参数类型	说明	示例	下级对象
InVersion	String	接入Ehome版本。	2.0
InUserName	String	Ehome凭证。	test
OutId	String	设备国标ID。	11000000541327000032
SipId	String	国标SIP服务器ID。	52010000012008589806
SipIp	String	国标SIP服务器IP。	192.168.0.1
SipTcpPort	Integer	国标SIP服务器TCP端口。	15064
SipUdpPort	Integer	国标SIP服务器UDP端口。	15064
SipTransType	String	国标SIP服务器传输协议。	tcp
StreamTransProtocol	String	媒体流传输协议，默认tcp。取值：tcp，udp。	tcp
AutoStartStream	Boolean	是否启用自动拉流。	true
StreamSize	Integer	主子码流数量。	1
StreamNum	Integer	设备发送第几个码流。	1
ErrorCode	String	错误码。	xxx
ErrorMsg	String	错误信息。	xxx
DeviceStatus	Object	设备状态信息。		DeviceStatus
Streams	Array of Objects	流状态信息。		Streams

表 RtmpDevice

参数	参数类型	说明	示例	下级对象
InType	String	视频流接入方式。取值：push(推流)，pull(拉流)。	push
PushType	Integer	是否自动激活推流地址。	1
PushUrl	String	推流地址。	xxx
OutId	String	设备国标ID。	11000000541327000032
AutoStartStream	Boolean	是否启用自动拉流。	true
StreamSize	Integer	主子码流数量。	1
StreamNum	Integer	设备发送第几个码流。	1
ErrorCode	String	错误码。	xxx
ErrorMsg	String	错误信息。	xxx
DeviceStatus	Object	设备状态信息。		DeviceStatus
Streams	Array of Objects	流状态信息。		Streams

表 RtspDevice

参数	参数类型	说明	示例	下级对象
InType	String	视频流接入方式。取值：push(推流)，pull(拉流)。	pull
PullType	String	是否自动拉流。	xxx
PullUrl	String	自定义拉流地址。	xxx
OutId	String	设备国标ID。	11000000541327000032
UserName	String	用户名。	test
EnableDomain	Boolean	是否启用域名。	true
DeviceDomain	String	设备域名。	xxx
DeviceIp	String	设备IP。	192.168.0.1
DevicePort	Integer	设备Port。	554
StreamTransProtocol	String	媒体流传输协议，默认tcp。取值：tcp，udp。	tcp
AutoStartStream	Boolean	是否启用自动拉流。	true
StreamSize	Integer	主子码流数量。	1
StreamNum	Integer	设备发送第几个码流。	1
ErrorCode	String	错误码。	xxx
ErrorMsg	String	错误信息。	xxx
DeviceStatus	Object	设备状态信息。		DeviceStatus
Streams	Array of Objects	流状态信息。		Streams

表 ViidDevice

参数	参数类型	说明	示例	下级对象
InViidProtocol	String	接入视图协议分类。取值：ga1400。	ga1400
Ga1400Device	Object	Ga1400设备。		Ga1400Device

表 Ga1400Device

参数	参数类型	说明	示例	下级对象
InUserId	String	GA1400凭证id。	20720122
InUserName	String	GA1400凭证名称。	test
DeviceType	String	视图库设备类型。取值：ape（采集设备）。	ape
ViidId	String	视图库编码。	xxx
ViidIp	String	视图库ip。	192.168.0.1
ViidPort	Integer	视图库端口。	8000
OutId	String	设备视图编码。	11000000541327000032
Ip	String	设备ip。	192.168.0.1
Port	Integer	设备端口。	8000
DeviceStatus	Object	设备状态。		DeviceStatus

枚举参数

无

请求示例

请求url

GET '/v2/devices?PageNum=1&PageSize=1'

请求头header

无

请求体body

无

响应示例

{"statusCode": 200,"message": "请求成功","requestId": "683d89badd0449b7bb27ea588eae2300","returnObj": {"Devices": [{"Device": {"DirId": "1","DeviceId": "743780360209498112","ParentDeviceId": "-1","DeviceType": "ipc","DeviceVendor": "海康","DeviceName": "openapi-v2-change","DeviceLocalName": "","DeviceIp": "","DevicePort": "0","DeviceSerialNumber": "","DeviceModel": "","InOrgRegion": "11000000","InOrgRegionLevel": 1,"DeviceLongitude": "0","DeviceLatitude": "0","DeviceMac": "","DevicePoleId": "","DeviceIndustryCode": "54","DeviceNetworkCode": "7","AutoCreateChannel": false,"DeviceChannelSize": 1,"DeviceChannelNum": -1,"DeviceEnabled": 1,"Description": "","DeviceDir": null,"DeviceStats": null,"DeviceChannels": []},"VideoDevice": {"Gb28181Device": {"SipId": "52010000012008589806","SipIp": "127.0.0.1","SipTcpPort": "15064","SipUdpPort": "15064","OutId": "11000000541327000032","DeviceStatus": {"IsOnline": "new","RegisterTime": "1685515845345","KeepliveTime": "0","UnregisterTime": "0"},"Streams": [],"ErrorCode": "","ErrorMsg": "","InUserName": "123","StreamTransProtocol": "tcp","SipTransType": "tcp","InVersion": "2016","StreamSize": 1,"AutoStartStream": true,"StreamNum": 1,"EnabledGB35114": false,"GB35114Mode": 0},"EhomeDevice": null,"RtmpDevice": null,"RtspDevice": null,"InVideoProtocol": "gb28181"},"ViidDevice": null,"IotDevice": null,"Industry": {"InOrgRegion": "11000000","InOrgRegionLevel": 1,"IndustryCode": "54","IndustryName": "","NetworkCode": "7"},"Region": "0851001","InNetworkType": "public","OutNetworkType": "public","CreatedTime": "1685515845343","UpdatedTime": "1685516000079"}],"DirStats": null,"PageNum": "1","PageSize": "1","TotalPage": "144","TotalNum": "144","RequestId": "683d89badd0449b7bb27ea588eae2300"}}

状态码

请参考 状态码

错误码

请参考 错误码