You need to enable JavaScript to run this app.
导航
创建设备
最近更新时间:2025.02.14 16:55:51首次发布时间:2021.11.25 17:21:23
我的收藏
有用
有用
无用
无用

在指定空间内创建单个设备。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=CreateDevice&Version=2021-01-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringCreateDevice接口名称。当前 API 的名称为 CreateDevice
VersionString2021-01-01接口版本。当前 API 的版本为 2021-01-01
SpaceIDString2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx空间 ID,可通过调用 ListSpaces 接口获取

Body

参数类型是否必选示例值描述

Type

String

设备类型,可选枚举值:

  • IPC
  • NVR
  • Platform(国标平台)
DeviceNameString设备名称,支持大小写字母、数字、中划线
DeviceNSIDString设备国标 ID,需要按照国标 ID 标准进行定义,可通过调用 GenSipID 接口生成设备国标 ID
UsernameString测试设备设备用户名,支持大小写字母(A-Z,a-z)、数字(0-9)、中横线(-),4~40位,默认国标ID
PasswordString设备密码,支持大小写字母(A-Z,a-z)、数字(0-9)、中横线(-),4~40位
DescriptionString设备描述,输入100个字符以内的描述

AutoPullAfterRegister

Boolean

是否自动启动拉流:

  • true:是(默认)
  • false:否

RtpTransportTcp

Boolean

流媒体传输是否使用 TCP 协议:

  • true:是(默认)
  • false:否
LocationString设备地址
CoordinatesObject of Coordinates设备经纬度,参考以下 经纬度结构说明
AlertNotificationObject of AlertNotification设备报警配置,参考以下 报警配置结构说明
UseSubStreamBoolean是否使用子码流, 开启后可以拉取子码流

Coordinates

参数类型是否必选示例值描述
LongitudeFloat
LatitudeFloat

AlertNotification

参数类型是否必选示例值描述

Enabled

Boolean

是否开启报警通知服务:

  • true:开启,至少包含一种报警方式
  • false:关闭(默认)
PhoneBoolean是否开启电话报警方式,默认为 false
DeviceBoolean是否开启设备报警方式,默认为 false
SMSBoolean是否开启短信报警方式,默认为 false
GPSBoolean是否开启 GPS 报警方式,默认为 false
VideoBoolean是否开启视频报警方式,默认为 false
DeviceFaultBoolean是否开启设备故障报警方式,默认为 false
OtherBoolean是否开启其他报警方式,默认为 false

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数类型示例值描述
IDString创建成功的设备 ID

错误码

您可访问公共错误码,获取更多错误码信息。