接口功能介紹

本接口用于查詢設備列表。

接口約束

按特定條件如設備名稱、目錄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"}}

狀態碼

請參考

錯誤碼

請參考

亚欧色一区w666天堂,色情一区二区三区免费看,少妇特黄A片一区二区三区,亚洲人成网站999久久久综合,国产av熟女一区二区三区

智算服務

應用商城

定價

合作伙伴

開發者

支持與服務

了解天翼云

智能視圖服務

智能視圖服務

接口功能介紹

接口約束

URI

請求參數

響應參數

枚舉參數

請求示例

響應示例

狀態碼

錯誤碼

亚欧色一区w666天堂,色情一区二区三区免费看,少妇特黄A片一区二区三区,亚洲人成网站999久久久综合,国产av熟女一区二区三区

活動

智算服務

應用商城

定價

合作伙伴

開發者

支持與服務

了解天翼云

智能視圖服務

智能視圖服務

接口功能介紹

接口約束

URI

請求參數

響應參數

枚舉參數

請求示例

響應示例

狀態碼

錯誤碼