在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****"
} ]
}
}错误码
访问错误中心查看更多错误码。