请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	CreateDevice	要执行的操作，取值：CreateDevice。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。

Body

参数	类型	是否必填	示例值	描述
UserName	String	是	3140000010101010xxx	设备用户
AutoPullAfterRegiter	Boolean	否	false	注册后是否自动拉起
SpaceID	String	是	2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx	空间 ID，可通过调用 ListSpaces 接口获取
Type	String	是	NVR	设备类型，可选枚举值： IPC NVR Platform（国标平台）
DeviceName	String	是	device_name	设备名称，支持大小写字母、数字、中划线
DeviceNSID	String	否	3140000010101010xxx	设备国标 ID，需要按照国标 ID 标准进行定义，可通过调用 GenSipID 接口生成设备国标 ID
Username	String	否	测试设备	设备用户名，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-），4~40位，默认国标ID
Password	String	否	##$$3301	设备密码，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-），4~40位
Description	String	否	device description	设备描述，输入100个字符以内的描述
AutoPullAfterRegister	Boolean	否	false	是否自动启动拉流： true：是（默认） false：否
RtpTransportTcp	Boolean	否	false	流媒体传输是否使用 TCP 协议： true：是（默认） false：否
Location	String	否	xx	设备地址
Coordinates	Object	否		设备经纬度，参考以下经纬度结构说明
AlertNotification	Object	否		设备报警配置，参考以下报警配置结构说明
UseSubStream	Boolean	否	false	是否使用子码流, 开启后可以拉取子码流
EnableMobilePosition	Boolean	否	true	是否开启设备GPS数据上传。默认不开启

返回参数

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

参数	类型	示例值	描述
ChannelNum	Integer	10	通道数
AutoPullAfterRegiter	Boolean	false	注册自动拉起
OnChannelNum	Integer	6	在线通道数
Username	String	username	用户名
UseSubStream	Boolean	false	是否使用子码流
UpdatedAt	String	2023-10-10 16:00:10	更新时间
Type	String	NVR	类型
Status	String	online	状态
SpaceID	String	spaceuuidxxxxx	空间ID
RtpTransportTcp	Boolean	false	是否tcp传输
Password	String	pass$$%$%1	密码
Manufactory	String	manu
Location	String	xxxx	地理位置
DownloadSpeed	Integer	2	下载速度
DeviceName	String	deviceo name	设备名称
DeviceNSID	String	314000000100xx	设备国标ID
DeviceID	String	devicexxxxxxxuuid	设备ID
Description	String	desc	描述
CreatedAt	String	2023-10-10 15:00:10	创建时间
ContactCount	Integer	10	Device的contact数量
Coordinates	Object		设备经纬度
ID	String	deviceuuidxxxxx	创建成功的设备 ID

请求示例

POST /?Action=CreateDevice&Version=2021-01-01&SpaceID=2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241217T094457Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241217/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserName": "LJ5DXT",
  "Type": "0aue",
  "DeviceName": "cKwyLwJx1I0"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202412171745100410992470340A696D",
    "Action": "CreateDevice",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {
    "AutoPullAfterRegiter": false,
    "ChannelNum": 805,
    "ContactCount": 238,
    "CreatedAt": "0pMmTdwY",
    "Description": "p3w",
    "DeviceID": "wDuG7Zw",
    "DeviceNSID": "tm262",
    "DeviceName": "9a",
    "DownloadSpeed": 488,
    "Location": "J6tGL",
    "Manufactory": "oF39HwumYl",
    "OnChannelNum": 801,
    "Password": "mu2fkmiY3o",
    "SpaceID": "cs4CEwv",
    "RtpTransportTcp": true,
    "Status": "1m",
    "Type": "nu",
    "UpdatedAt": "VZbyWB",
    "UseSubStream": false,
    "Username": "oFLzvNEx",
    "ID": "LVe"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	400	InvalidParameter.CreateDeviceArgs	The parameter of spaceID is missing
400	InternalErrorSpaceDB	InternalError.SpaceDB	空间数据不存在
400	InternalErrorSpaceDomainUnActive	InternalError.SpaceDomainUnActive
400	InternalErrorSpaceStatusUnActive	InternalError.SpaceStatusUnActive
400	InvalidParameter.DeviceName	The request is failed due to the device name can not be checked correctly.
500	BusyCreateDevice	Busy.CreateDevice

最近更新时间：2026.04.21 11:39:03

这个页面对您有帮助吗？

有用

无用

智能视联

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

调试

请求参数

Query

Body

返回参数

请求示例

返回示例

错误码