在指定空间内创建单个设备。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDevice | 接口名称。当前 API 的名称为 CreateDevice 。 |
Version | String | 是 | 2021-01-01 | 接口版本。当前 API 的版本为 2021-01-01 。 |
SpaceID | String | 是 | 2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx | 空间 ID,可通过调用 ListSpaces 接口获取 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Type | String | 是 | 设备类型,可选枚举值:
| |
DeviceName | String | 是 | 设备名称,支持大小写字母、数字、中划线 | |
DeviceNSID | String | 否 | 设备国标 ID,需要按照国标 ID 标准进行定义,可通过调用 GenSipID 接口生成设备国标 ID | |
Username | String | 否 | 测试设备 | 设备用户名,支持大小写字母(A-Z,a-z)、数字(0-9)、中横线(-),4~40位,默认国标ID |
Password | String | 否 | 设备密码,支持大小写字母(A-Z,a-z)、数字(0-9)、中横线(-),4~40位 | |
Description | String | 否 | 设备描述,输入100个字符以内的描述 | |
AutoPullAfterRegister | Boolean | 否 | 是否自动启动拉流:
| |
RtpTransportTcp | Boolean | 否 | 流媒体传输是否使用 TCP 协议:
| |
Location | String | 否 | 设备地址 | |
Coordinates | Object of Coordinates | 否 | 设备经纬度,参考以下 经纬度结构说明 | |
AlertNotification | Object of AlertNotification | 否 | 设备报警配置,参考以下 报警配置结构说明 | |
UseSubStream | Boolean | 否 | 是否使用子码流, 开启后可以拉取子码流 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Longitude | Float | 否 | ||
Latitude | Float | 否 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Enabled | Boolean | 否 | 是否开启报警通知服务:
| |
Phone | Boolean | 否 | 是否开启电话报警方式,默认为 false | |
Device | Boolean | 否 | 是否开启设备报警方式,默认为 false | |
SMS | Boolean | 否 | 是否开启短信报警方式,默认为 false | |
GPS | Boolean | 否 | 是否开启 GPS 报警方式,默认为 false | |
Video | Boolean | 否 | 是否开启视频报警方式,默认为 false | |
DeviceFault | Boolean | 否 | 是否开启设备故障报警方式,默认为 false | |
Other | Boolean | 否 | 是否开启其他报警方式,默认为 false |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ID | String | 创建成功的设备 ID |
您可访问公共错误码,获取更多错误码信息。