最近更新时间：2023-02-01
添加新的设备
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 系统规定参数。取值：CreateDevice |
Name | 是 | String | 设备名称(最大长度128位，不支持特殊字符" |) |
Type | 是 | String | 设备类型。取值： ipc、nvr、channel（nvr通道设备）、platform（级联下级平台） rtmp协议空间下仅支持新增ipc设备 |
| Vendor | 否 | String | 厂商名称。默认 其他。 |
GroupId | 是 | String | 设备所属空间ID。 |
| ParentId | 否 | String | 上级设备ID（channel设备类型必填） |
| MaxChannelNum | 否 | Long | 最大通道数量。 规格：4,8,16,32,64 |
| MaxLocalRecordUploadTaskNum | 否 | Long | 本地上传任务并发最大值，ipc(1-3,默认1)，nvr（1-2*MaxChannelNum+1,默认MaxChannelNum）platform（1-100,默认20） |
| ChannelId | 否 | Long | 通道号。取值：[1, nvr的最大通道数] |
| GbDeviceId | 否 | String | 设备国标ID。用户可以指定国标设备ID，但必须保证所属空间内的唯一性。用户也可以不指定，由系统默认规则生成。 对于设备类型是platform（级联下级平台），必须要设置，不能默认生成 |
| UserName | 否 | String | 鉴权用户名 当传入此参数时，Password必传。 |
| Password | 否 | String | 鉴权密码 当传入此参数时，UserName必传。 |
| GbVersion | 否 | String | gb28181协议版本号，仅gb28181空间ipc、nvr设备有效。取值：2011、2016。默认值2011。 |
| SupportPtz | 否 | Integer | 是否支持云台 SupportPtz 0:不支持 1:支持 默认:1（适用国标设备） |
| EnableGps | 否 | Bool | 是否开启设备GPS数据上传 默认不开启 仅支持国标 IPC/NVR设备 |
| GpsStoreDays | 否 | Long | GPS数据存储期限，取值范围：0 ~ 36 (月)，0表示永久保存。 默认值为0，选择开启设备GPS数据上传时生效。 仅支持国标 IPC/NVR设备 |
| Longitude | 否 | String | 设备经度 |
| Latitude | 否 | String | 设备纬度 |
| DeviceAddress | 否 | String | 设备地址 最大长度200 |
| DeviceIp | 否 | String | 设备IP。对于设备类型是platform（级联下级平台），必须要设置，下级平台注册上线时候，视联云平台会做IP和端口校验。 |
| DevicePort | 否 | Long | 设备端口号。对于设备类型是platform（级联下级平台），必须要设置，下级平台注册上线时候，视联云平台会做IP和端口校验。 |
| DeviceSn | 否 | String | 设备序列号 最大长度128，不支持中文 |
| Description | 否 | String | 描述信息 最大长度200 |
参数 | 是否必传 | 参数类型 | 描述 |
|---|---|---|---|
RequestId | 是 | String | 该条接口请求ID |
| Code | 是 | String | 0成功 其他失败 |
| Message | 否 | String | 错误信息 |
| Data | 否 | Object | 返回值，json对象结构 |
--DeviceId | 否 | String | 设备ID，系统生成的设备唯一标识。 |
| --StreamName | 否 | String | 流名称。如果用户没有设置StreamName，则默认与DeviceId值相同。 |
| --PushUrl | 否 | String | 推流Url。 推流地址生成规则： rtmp://DomainName/AppName/StreamName?AuthKey=timestamp-uid-md5hash DomianName: 推流域名，如果没有设置推流域名，则为空间的推流Ip:Port AppName: 空间的AppName StreamName：设备的StreamName AuthKey: 鉴权密钥 timestamp：为该设备最新密钥的生成时间，为UTC时间。 uid：用户ID md5hash：通过md5计算出的字符串，由0-9和小写字母a-z混合组成，固定长度32位。计算方法： sstring = "URI-timestamp-uid-PrivateKey" HashValue = md5sum(sstring) URI：是用户的请求对象相对地址，不包含参数，如/AppName/StreamName。 PrivateKey：创建设备系统生成的随机字符串，如：random123456。 |
| --GbDeviceId | 否 | String | 设备国标ID |
| --CreateTime | 否 | String | 设备创建时间，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
请求示例:
ipc设备:
GET https://api.unicloud.com/univms?
Action=CreateDevice
&Name=ipc测试设备
&Type=ipc
&Vendor=紫光云
&GroupId=uni0341122060286924475
&UserName=username
&Password=password
&GbVersion=2011
&DeviceAddress=测试设备地址
&Longitude=52.25
&Latitude=25.52
&DeviceIp=10.0.0.1
&DevicePort=4321
&DeviceSn=12345
&Description=ipc测试设备
&公共请求参数
nvr设备:
GET https://api.unicloud.com/univms?
Action=CreateDevice
&Name=nvr测试设备
&Type=nvr
&Vendor=紫光云
&GroupId=uni0341122060286924475
&MaxChannelNum=16
&UserName=username
&Password=password
&GbVersion=2011
&DeviceAddress=测试设备地址
&Longitude=52.25
&Latitude=25.52
&DeviceIp=10.0.0.1
&DevicePort=4321
&DeviceSn=12345
&Description=nvr测试设备
&公共请求参数
channel(nvr通道)设备：
GET https://api.unicloud.com/univms?
Action=CreateDevice
&Name=channel测试设备
&Type=channel
&Vendor=紫光云
&GroupId=uni0341122060286924475
&ParentId=uni0340021122061775779565
&ChannelId=1
&GbVersion=2011
&DeviceAddress=测试设备地址
&Longitude=52.25
&Latitude=25.52
&DeviceIp=10.0.0.1
&DevicePort=4321
&DeviceSn=12345
&Description=channel测试设备
&公共请求参数
platform设备：
GET https://api.unicloud.com/univms?
Action=CreateDevice
&Name=测试下级设备-0007
&Type=platform
&Vendor=紫光云
&GroupId=uni03411202109f70ec206
&GbDeviceId=12000000002001000012
&UserName=username
&Password=password
&GbVersion=2011
&DeviceIp=10.0.0.1
&DevicePort=4321
&Description=测试下级设备-0007
&公共请求参数
返回示例:
国标：
{
"RequestId": "c63d02b5-a98c-44f2-9685-6f6415876869",
"Code": "0",
"Data": {
"DeviceId": "uni0340011122061377609622",
"GbDeviceId": "12000000001320914363",
"CreateTime": "2022-06-29T01:33:17Z"
}
}
RTMP：
{
"RequestId": "b600f531-72a3-4454-b8f0-4e81e73b227e",
"Code": "0",
"Data": {
"DeviceId": "uni0340001122051609175583",
"StreamName": "uni0340001122051609175583",
"PushUrl": "rtmp://www.baidu.com/uni0341122041424855039/uni0340001122051609175583?token=0576126f0f83f2d53745d57f95354a23&time=1653459945",
"CreateTime": "2022-05-25T06:25:42Z"
}
} |
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
