在VCS項目中添加設備。
設備包含兩類：
- 國標協議（GB/T 28181 － 2016）設備：此類設備在VCS添加后，需根據返回信息在設備端頁面上配置國標注冊信息，才能正常在云上使用
- 阿里云VCS定制設備：此類設備支持掃描設備上的二維碼快速上云
常見用法：
1. 添加IPC設備
DeviceType 填寫“IPC”，ParentDeviceId 不填
2. 添加NVR設備
DeviceType填寫“NVR”，ParentDeviceId 不填， SubDeviceCount 填寫子設備數量。
如需指定子設備的ID，可填寫 SubDeviceIdList ，大小需和 SubDeviceCount 一致；不指定則不填。
3. 擴容NVR，通過“添加NVR下的子設備”來操作：
DeviceType填寫“IPC”， ParentDeviceId 參數填寫所屬 NVR 的 DeviceId，并填寫 SubDeviceCount 表示 NVR 擴容的通道數量。
如需指定子設備的ID，可填寫 SubDeviceIdList ，大小需和 SubDeviceCount 一致；不指定則不填。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateDevice |
系統規定參數。取值：CreateDevice |
| CorpId | String | 是 | 323153238989734**** |
所要注冊設備所屬的項目ID，該項目ID為您通過VCS創建時生成。 長度限制64位。 |
| DeviceType | String | 是 | ABOX |
所要注冊的設備的類型。枚舉值包括： 1）IPC 2）NVR 3）ABOX：阿里云定制“ACube系列”設備 |
| DataSourceType | String | 是 | PIC_VIDEO |
所要注冊設備的上傳的數據類型。 取值包括： 1）VIDEO：表示IPC、NVR通用數據類型 2）PIC_VIDEO：表示阿里云定制設備的數據類型 |
| DeviceName | String | 是 | 某公司門口 |
設備名稱 |
| DeviceAddress | String | 是 | 某地市 |
設備地理位置 |
| DeviceSn | String | 否 | ca0e71642974**** |
設備序列號，掃碼上云時必填，此時是掃碼獲取的設備序列號，即SN號。長度限制64位。 |
| ParentDeviceId | String | 否 | 3200000099118700**** |
如果此屬性不為空，代表此IPC是屬于 ParentDeviceId的下掛通道。 如果為空，代表此IPC是獨立接入的。 注意只有IPC才能掛在NVR或者ABOX下。 |
| SubDeviceCount | Long | 否 | 3 |
所屬子設備數量。 NVR/ABOX時必填，代表新增子設備數量 IPC時，如果ParentDeviceId不為空，則代表擴容NVR，必填 IPC時，如果ParentDeviceId為空，則代表新增IPC，可不填，默認只新增一個IPC |
| SubDeviceIdList | String | 否 | 3200000099118700****, 3200000099118800****, 3200000099118100**** |
所屬子設備ID清單，當您需要自己指定設備的ID時，可以在此處填寫，多個ID之間用逗號分隔。 此處ID需要符合GB/T 28181規范。 |
| Vendor | String | 否 | 阿里云 |
設備廠商，如阿里云等。 長度限制64位。 |
| DeviceModel | String | 否 | ACube200-8 |
所要注冊設備的型號，便于分類。 長度限制64位。 |
| InProtocol | String | 否 | GBT28181 |
設備接入協議，支持： 1）GBT28181：表示國標協議，即GB/T 28181-2016。 2）SAPI：表示阿里云安全互聯協議 不填時，默認為GBT28181。 |
| DeviceId | String | 否 | 3200000099118700**** |
自有設備ID編碼的填寫，如果為空則會系統自動分配。 對NVR和ABOX有作用，填寫時將用戶指定的國標碼作為其國標碼，通道的國標碼由系統產生。 對IPC沒有作用。 |
| CityCode | String | 否 | 100010 |
所要注冊的設備所在的行政區域代碼。 必須是6位純數字，參見民政部行政區劃代碼定義。 如果不填，內部根據DeviceAddress獲取，獲取失敗時接口失敗。 |
| Longitude | String | 否 | 116.397128 |
經度；掃碼設備（手機）若能自動獲取經緯度，會上報該值。 取值范圍-180～180，小數最多6位。 如果不填，內部根據DeviceAddress獲取，獲取失敗時接口失敗。 |
| Latitude | String | 否 | 39.916527 |
緯度；掃碼設備（手機）若能自動獲取經緯度，會上報該值。 取值范圍-90～90，小數最多6位。 如果不填，內部根據DeviceAddress獲取，獲取失敗時接口失敗。 |
| DeviceSite | String | 否 | 某公司門口 |
設備安裝地點。僅適用于IPC。 長度限制64位。 |
| DeviceDirection | String | 否 | 由內朝外 |
設備安裝方向。僅適用于IPC。 IPC 默認由內朝外。 長度限制64位。 |
| DeviceResolution | String | 否 | 1920*1080 |
設備分辨率，格式“數字*數字”。僅適用于IPC。 IPC默認1920*1080 |
| DeviceRate | String | 否 | 4096 |
碼率范圍128-16384kbps，默認4096。僅適用于IPC。 |
| FrameRate | String | 否 | 25 |
設備支持的幀率。僅適用于IPC。 取值范圍 1～100。默認25。 |
| GovLength | String | 否 | 50 |
I幀間隔。僅適用于IPC。 取值范圍5-250。 推薦為幀率兩倍。 |
| EncodeFormat | String | 否 | 6 |
視頻或圖片格式。僅適用于IPC。 枚舉值： 3: MJPEG 6: H.264 13: H.265 默認6。 |
| AudioEnable | String | 否 | 1 |
是否開啟音頻。僅適用于IPC。 取值范圍：0 關閉； 1 打開。默認1。 |
| OSDTimeEnable | String | 否 | 1 |
是否在畫面上顯示時間。僅適用于IPC。 取值范圍：0 關閉； 1 打開。默認1。 |
| OSDTimeType | String | 否 | 2 |
時間顯示類型。僅適用于IPC。 取值范圍： 0：YYYY-MM-DD 星期W HH:MM:SS； 1：DD-MM-YYYY星期W HH:MM:SS； 2：YYYY年MM月DD日 星期W HH:MM:SS； 3：MM月DD日YYYY年 星期W HH:MM:SS； 4：YYYY-MM-DD |
| OSDTimeX | String | 否 | 99 |
時間戳X像素坐標（可選），以播放窗口左上角像素為原點，水平向右為正。僅適用于IPC。 默認99。 |
| OSDTimeY | String | 否 | 1 |
時間戳Y像素坐標（可選），以播放窗口左上角像素為原點，豎直向下為正。僅適用于IPC。 默認1。 |
| ActivateCode | String | 否 | d390ce22-232f-431c-80ef-f0be633e**** |
激活碼。當協議為SAPI時必填。 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 46329898-489C-4E63-9BA1-C1DA5C5D0986 |
請求ID |
| Code | String | 0 |
返回編碼 |
| Message | String | Success |
返回消息 |
| Data | Object |
返回結果 |
|
| ServerId | String | 335616351220130**** |
接入服務器ID，目前僅在國標協議中有效，您需要將其填寫到設備頁面中 |
| ServerIp | String | 192.168.XX.XX |
接入服務器IP，目前僅在國標協議中有效，您需要將其填寫到設備頁面中 |
| ServerRealm | String | 2021***** |
接入服務器的域名，目前僅在國標協議中有效，您需要將其填寫到設備頁面中 |
| ServerPort | String | 8081 |
接入服務器端口，目前僅在國標協議中有效，您需要將其填寫到設備頁面中 |
| DeviceId | String | 33561635195013**** |
接入設備的設備ID。 當接入協議是GB28181時，此ID為國標ID，您需要將其填寫到設備頁面中。 |
| Password | String | ****** |
設備接入密碼，目前僅在國標協議中有效，您需要將其填寫到設備頁面中 |
| SubDeviceInfo | Array of SubDeviceInfo |
子設備相關信息 |
|
| SubDeviceId | String | 335616351950130**** |
子設備ID |
示例
請求示例
http(s)://[Endpoint]/?Action=CreateDevice
&CorpId=323153238989734****
&DeviceType=ABOX
&DataSourceType=PIC_VIDEO
&DeviceName=某公司門口
&DeviceAddress=某地市
&DeviceSn=ca0e71642974****
&ParentDeviceId=3200000099118700****
&SubDeviceCount=3
&SubDeviceIdList=3200000099118700****, 3200000099118800****, 3200000099118100****
&Vendor=阿里云
&DeviceModel=ACube200-8
&InProtocol=GBT28181
&DeviceId=3200000099118700****
&CityCode=100010
&Longitude=116.397128
&Latitude=39.916527
&DeviceSite=某公司門口
&DeviceDirection=由內朝外
&DeviceResolution=1920*1080
&DeviceRate=4096
&FrameRate=25
&GovLength=50
&EncodeFormat=6
&AudioEnable=1
&OSDTimeEnable=1
&OSDTimeType=2
&OSDTimeX=99
&OSDTimeY=1
&ActivateCode=d390ce22-232f-431c-80ef-f0be633e****
&公共請求參數正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateDeviceResponse>
<RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
<Code>0</Code>
<Message>Success</Message>
<Data>
<ServerId>335616351220130****</ServerId>
<ServerIp>192.168.XX.XX</ServerIp>
<ServerRealm>2021*****</ServerRealm>
<ServerPort>8081</ServerPort>
<DeviceId>33561635195013****</DeviceId>
<Password>******</Password>
<SubDeviceInfo>
<SubDeviceId>335616351950130****</SubDeviceId>
</SubDeviceInfo>
</Data>
</CreateDeviceResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"Code" : "0",
"Message" : "Success",
"Data" : {
"ServerId" : "335616351220130****",
"ServerIp" : "192.168.XX.XX",
"ServerRealm" : "2021*****",
"ServerPort" : "8081",
"DeviceId" : "33561635195013****",
"Password" : "******",
"SubDeviceInfo" : [ {
"SubDeviceId" : "335616351950130****"
} ]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。