接口功能介紹

本接口用于創建設備。

接口約束

1. 創建設備前，請確認賬號已開通計費資源。
   2. 創建GB和GA設備前，請確保已創建GB28181憑證和GA1400憑證。
   3. 若設備綁定按需計費并需要綁定錄制/存儲模板，請確認錄制/存儲模板有效。
   4. 若綁定AI資源，請確認AI應用有效。
   5. 設備名稱、設備SN碼、自定義國標ID請勿重復。
   請求參數說明：
   String類型的參數，傳""等同于不傳。
   Integer類型的參數，傳0等同于不傳。
   Boolean類型的參數，傳false等同于不傳。

URI

POST /v2/devices

路徑參數
無

Query參數
無

請求參數

請求頭header參數
無

請求體body參數

參數	是否必填	參數類型	說明	示例	下級對象
Region	是	String	設備接入區域，遼陽1區域ID：21100001。	21100001
InNetworkType	是	String	接入網絡類型。取值：public：互聯網；private：專線網絡。	public
OutNetworkType	否	String	播放網絡類型，默認public。取值：public：互聯網。	public
Device	是	Object	設備基本信息。		Device
VideoDevice	否	Object	視頻協議設備信息（GB28181/RTSP/RTMP/EHOME）。		VideoDevice
ViidDevice	否	Object	視圖協議設備信息（GA1400）。		ViidDevice
Resource	否	Object	資源包信息，設備類型為視頻設備ipc或nvr時，該字段必選。		Resource

表 Device

參數	是否必填	參數類型	說明	示例	下級對象
DirId	否	String	設備所屬目錄ID。	600001
DeviceType	是	String	設備類型。取值：ipc，nvr，platform。	nvr
DeviceVendor	是	String	設備廠商，ehome設備僅支持海康，僅rtsp設備支持金三立，華為，科達。取值：海康，大華，宇視，金三立，華為，科達，其他。	海康
DeviceName	是	String	設備名稱，2-64位，可包含大小寫字母、數字、中文、中劃線、下劃線、小括號、空格（不能以空格作為首尾）。	攝像頭
DeviceIp	否	String	設備ip。	192.168.0.1
DevicePort	否	Integer	設備端口，范圍0-65535。	8000
DeviceMac	否	String	設備mac地址，需符合通用mac地址格式。	00-16-EA-AE-3C-40
DeviceSerialNumber	否	String	設備sn碼，長度不超過64位，僅ipc設備有效。	xxx
DeviceModel	否	String	設備型號，長度不超過64位。	xxx
DeviceLongitude	否	String	設備經度，最高精確到小數點后6位。	11.11
DeviceLatitude	否	String	設備緯度，最高精確到小數點后6位。	11.11
DevicePoleId	否	String	設備桿號，1-21位，可包含大小寫字母、數字、下劃線。	xxx
InOrgRegion	是	Integer	設備中心編碼（8位），按照設備安裝所在地的行政區劃代碼確定，當不是基層單位時空余位為0。行政區劃代碼采用GB/T 2260-2007規定的行政區劃代碼表示。	35010200
InOrgRegionLevel	是	Integer	設備中心編碼級別，取值：1、2、3。	3
DeviceIndustryCode	是	String	設備所屬行業編碼。取值：08:城市管理; 09:衛生環保; 10:商檢海關; 11:教育部門; 40:農林牧漁業; 41:采礦企業; 42:制造企業; 43:冶金企業; 44:電力企業; 45:燃氣企業; 46:建筑企業; 47:物流企業; 48:郵政企業; 49:信息企業; 50:住宿和餐飲業; 51:金融企業; 52:房地產業; 53:商務服務業; 54:水利企業; 55:娛樂企業; 80:居民自建; 99:其他主體。	08
DeviceNetworkCode	是	String	設備所屬網絡標識。取值：0、1、2、3、4：監控報警專網；5：公安信息網；6：政務網；7：Internet網；8：社會資源接入網。	7
AutoCreateChannel	否	Boolean	是否自動創建子設備，設備類型為nvr時，該字段必選。取值：true：自動創建。	true
DeviceChannelSize	否	Integer	設備通道數量，AutoCreateChannel為true時，該字段有效且必選。	3
Description	否	String	設備描述，長度小于等于255個字符。	描述

表 VideoDevice

參數	是否必填	參數類型	說明	示例	下級對象
Gb28181Device	否	Object	國標設備。		Gb28181Device
EhomeDevice	否	Object	Ehome設備。		EhomeDevice
RtmpDevice	否	Object	Rtmp設備。		RtmpDevice
RtspDevice	否	Object	Rtsp設備。		RtspDevice

表 Gb28181Device

參數	是否必填	參數類型	說明	示例	下級對象
InVersion	是	String	接入國標版本。取值：2016。	2016
InUserName	否	String	設備用戶名，在創建GB28181憑證時生成。創建GB28181設備時該字段必填，創建GB35114設備時不需要該字段。	user
StreamTransProtocol	否	String	媒體流傳輸協議，默認tcp。取值：tcp，udp。	tcp
OutId	否	String	設備國標ID，長度20位，不可與已有國標ID重復，當需要自定義國標ID時，該字段有效。	51030300101327015065
AutoStartStream	否	Boolean	是否啟用自動拉流。取值：true：自動拉流，設備注冊成功后自動啟動拉流；false：按需拉流，需要通過觸發的方式啟動拉流。	true
EnabledGB35114	否	Boolean	是否啟用GB35114協議。	true
GB35114Mode	否	Integer	GB35114協議認證方式，EnabledGB35114為true時，該字段必選。取值：1：單向認證；2：雙向認證。	1

表 EhomeDevice

參數	是否必填	參數類型	說明	示例	下級對象
InVersion	是	String	接入Ehome版本。取值：2.0。	2.0
AutoStartStream	否	Boolean	是否啟用自動拉流。取值：true：自動拉流，設備注冊成功后自動啟動拉流；false：按需拉流，需要通過觸發的方式啟動拉流。	true
StreamSize	否	Integer	主子碼流數量，默認為1，ipc設備最多支持三碼流，nvr設備最多支持雙碼流。取值：1：單碼流（僅有一種碼流）；2：雙碼流（主、子碼流）；3：三碼流（主、子、第三碼流）。	1
StreamNum	否	Integer	設備發送第幾個碼流，默認1。取值：1：主碼流；2：子碼流；3：第三碼流。主子碼流數量不能小于設備發送碼流，如StreamSize為2，則StreamNum可選1或2。	1

表 RtmpDevice

參數	是否必填	參數類型	說明	示例	下級對象
InType	是	String	視頻流接入方式。取值：push：推流。	push
PushType	是	Integer	是否自動激活推流地址。取值：1：自動激活推流地址，設備創建完成后，平臺自動生成推流地址；2：按需推流，需要通過觸發的方式生成推流地址。	1

表 RtspDevice

參數	是否必填	參數類型	說明	示例	下級對象
InType	是	String	視頻流接入方式。取值：pull：拉流。	pull
UserName	否	String	用戶名，設備廠商為海康，大華，宇視，金三立，華為，科達時，該字段必選。	test
Password	否	String	密碼，設備廠商為海康，大華，宇視，金三立，華為，科達時，該字段必選。	xxx
PullUrl	否	String	自定義拉流地址，設備廠商為其他時，該字段必選。
EnableDomain	否	Boolean	是否啟用域名，設備廠商為海康，大華，宇視，金三立，華為，科達時，該字段必選。取值：true：啟用；false：不啟用。默認值為false。	false
DeviceDomain	否	String	設備域名，設備廠商為海康，大華，宇視，金三立，華為，科達且啟用域名時，該字段必選。	xxx
DeviceIp	否	String	設備IP，設備廠商為海康，大華，宇視，金三立，華為，科達且不啟用域名時，該字段必選。	192.168.0.1
DevicePort	否	Integer	設備Port，范圍0-65535，設備廠商為海康，大華，宇視，金三立，華為，科達時，該字段必選。	554
StreamTransProtocol	否	String	媒體流傳輸協議，默認tcp。取值：tcp，udp。	tcp
AutoStartStream	否	Boolean	是否啟用自動拉流。取值：true：自動拉流，設備注冊成功后自動啟動拉流；false：按需拉流，需要通過觸發的方式啟動拉流。	true
StreamSize	否	Integer	主子碼流數量，默認1，設備廠商為其他時，該字段請置空。取值：1：單碼流（僅有一種碼流）；2：雙碼流（主、子碼流）；3：三碼流（主、子、第三碼流）。	1
StreamNum	否	Integer	設備發送第幾個碼流，默認1，設備廠商為其他時，該字段請置空。取值：1：主碼流；2：子碼流；3：第三碼流。主子碼流數量不能小于設備發送碼流，如StreamSize為2，則StreamNum可選1或2。	1

表 ViidDevice

參數	是否必填	參數類型	說明	示例	下級對象
Ga1400Device	否	Object	Ga1400設備		Ga1400Device

表 Ga1400Device

參數	是否必填	參數類型	說明	示例	下級對象
InUserId	是	String	Ga1400憑證id，在創建視圖憑證時生成，可在用戶控制臺【憑證管理-GA1400憑證】頁面獲取。	20720122
DeviceType	是	String	視圖庫設備類型。取值：ape：采集設備。	ape

表 Resource

參數	是否必填	參數類型	說明	示例	下級對象
Video	否	Array of Objects	視頻資源。創建視頻設備（GB28181/RTSP/RTMP/EHOME）時須配置視頻資源。		VideoResource
Viid	否	Array of Objects	視圖資源。創建視圖設備（GA1400）時須配置視圖資源。		ViidResource
AI	否	Array of Objects	AI資源。僅視頻設備（GB28181/RTSP/RTMP/EHOME）可配置AI資源。		AIResource

表 VideoResource

參數	是否必填	參數類型	說明	示例	下級對象
BillingMode	是	String	付費模式。取值：packages：資源包；onDemand：按需計費。	packages
ResourceId	否	String	資源Id，付費模式為packages時，該字段必選。	resource-01
RecordNum	否	String	錄制配置，付費模式為onDemand時，該字段必選。取值：0：無錄制；1：錄制。	1
TemplateId	否	String	模板Id，付費模式為onDemand且錄制配置為1時，該字段必選。	707389832455651328
ChannelNum	否	String	通道號，設備類型是nvr時，該字段必選。	1

表 ViidResource

參數	是否必填	參數類型	說明	示例	下級對象
BillingMode	是	String	付費模式。取值：onDemand：按需計費。	onDemand
TemplateId	是	String	視圖存儲模板Id，付費模式為onDemand時，該字段必選,可在用戶控制臺【模板管理-存儲模板-視圖存儲模板】頁面獲取。	717074786139029504

表 AIResource

參數	是否必填	參數類型	說明	示例	下級對象
BillingMode	是	String	付費模式。取值：packages：資源包；onDemand：按需計費。	packages
ResourceId	否	String	資源Id，付費模式為packages時，該字段必選。	resource-AI-01
AppId	是	String	AI應用Id，可在用戶控制臺【AI管理-AI應用-應用詳情】頁面獲取。	609
AnalyseType	是	String	應用分析類型。付費模式為packages時，AI應用的分析能力不應超過資源包所具有的分析能力。取值：AI-100：分鐘級；AI-200：秒級；AI-300：高算力。	AI-100

響應參數

參數	參數類型	說明	示例	下級對象
statusCode	Integer	響應狀態碼。	200
error	String	錯誤碼，執行成功時，不返回該字段。	VSS_0001
message	String	響應信息。	請求成功
requestId	String	請求ID。	362d4e78556b47129182d0881fade86b
returnObj	Object	響應數據，執行失敗時，不返回該字段。		returnObj1

表 returnObj1

參數	參數類型	說明	示例	下級對象
Device	Object	設備信息。		Device1
VideoDevice	Object	視頻協議設備信息。		VideoDevice1
ViidDevice	Object	視圖協議設備信息。		ViidDevice1
CreatedTime	String	設備創建時間。	1685515845343
UpdatedTime	String	設備更新時間。	1685516000079
RequestId	String	請求ID。	362d4e78556b47129182d0881fade86b

表 Device1

參數	參數類型	說明	示例	下級對象
DeviceId	String	設備ID。	32388487739092996
DeviceChannels	Array of Objects	設備通道列表。		DeviceChannel1

表 DeviceChannel1

參數	參數類型	說明	示例	下級對象
DeviceId	String	設備ID。	32388487739092996
OutId	String	設備國標ID。	34082400011188226858
DeviceChannelNum	Integer	通道號。	1
DeviceName	String	通道名稱。	通道1

表 VideoDevice1

參數	參數類型	說明	示例	下級對象
Gb28181Device	Object	國標設備。		Gb28181Device1
EhomeDevice	Object	Ehome設備。		EhomeDevice1
RtmpDevice	Object	Rtmp設備。		RtmpDevice1
RtspDevice	Object	Rtsp設備。		RtspDevice1

表 Gb28181Device1

參數	參數類型	說明	示例	下級對象
InVersion	String	接入國標版本。	2016
OutId	String	設備國標ID。	34082400011188226858
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
AutoStartStream	Boolean	是否啟用自動拉流。	true
StreamSize	Integer	主子碼流數量。	1
StreamNum	Integer	設備發送第幾個碼流。	1

表 EhomeDevice1

參數	參數類型	說明	示例	下級對象
InVersion	String	接入Ehome版本。	2.0
OutId	String	設備國標ID。	34082400011188226858
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
AutoStartStream	Boolean	是否啟用自動拉流。	true
StreamSize	Integer	主子碼流數量。	1
StreamNum	Integer	設備發送第幾個碼流。	1

表 RtmpDevice1

參數	參數類型	說明	示例	下級對象
OutId	String	設備國標ID。	34082400011188226858
PushType	Integer	是否自動激活推流地址。	1
PushUrl	String	推流地址。	xxx

表 RtspDevice1

參數	參數類型	說明	示例	下級對象
OutId	String	設備國標ID。	34082400011188226858
EnableDomain	Boolean	是否啟用域名。	true
DeviceDomain	String	設備域名。	xxx
DeviceIp	String	設備IP。	192.168.0.1
DevicePort	Integer	設備Port。	554
AutoStartStream	Boolean	是否啟用自動拉流。	true
StreamSize	Integer	主子碼流數量。	1
StreamNum	Integer	設備發送第幾個碼流。	1

表 ViidDevice1

參數	參數類型	說明	示例	下級對象
Ga1400Device	Object	Ga1400設備。		Ga1400Device1

表 Ga1400Device1

參數	參數類型	說明	示例	下級對象
OutId	String	設備視圖編碼。	34082400011188226858
ViidIp	String	視圖庫ip。	192.168.0.1
ViidPort	Integer	視圖庫端口。	8000

枚舉參數

無

請求示例

請求url

POST '/v2/devices'

請求頭header

無

請求體body

{"Region": "0851001","InNetworkType": "public","OutNetworkType": "public","Device": {"DeviceType": "ipc","DeviceVendor": "海康","DeviceName": "openapi-v2","DeviceLongitude": "0.000000","DeviceLatitude": "0.000000","DeviceIp": "","DeviceMac": "","DevicePoleId": "","DeviceSerialNumber": "","DeviceModel": "","Description": "","DeviceChannelSize": 1,"InOrgRegion": 11000000,"InOrgRegionLevel": 1,"DeviceIndustryCode": "54","DeviceNetworkCode": "7"},"Resource": {"Video": [{"BillingMode": "packages","ResourceId": "resource01"}]},"VideoDevice": {"Gb28181Device": {"InVersion": "2016","InUserName": "123","StreamTransProtocol": "tcp","AutoStartStream": true}}}

響應示例

{"statusCode": 200,"message": "請求成功","requestId": "5c94e21e87654e408921a6437e880db1","returnObj": {"Device": {"DeviceId": "743780360209498112","DeviceChannels": []},"VideoDevice": {"Gb28181Device": {"InVersion": "2016","OutId": "11000000541327000032","SipId": "52010000012008589806","SipIp": "127.0.0.1","SipTcpPort": "15064","SipUdpPort": "15064","SipTransType": "tcp","StreamSize": 1,"AutoStartStream": true,"StreamNum": 1},"EhomeDevice": null,"RtmpDevice": null,"RtspDevice": null},"ViidDevice": null,"CreatedTime": "1685515845343","UpdatedTime": "1685515845343","RequestId": "5c94e21e87654e408921a6437e880db1"}}

狀態碼

請參考

錯誤碼

請參考