创建设备--慢直播-火山引擎

文档中心

立即注册

导航

创建设备

最近更新时间：2023.05.29 11:34:48首次发布时间：2021.11.25 17:21:23

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

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreateDevice
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取

Body参数

字段	类型	必填	说明
Type	String	是	设备类型，可选枚举值： IPC NVR Platform（国标平台）
DeviceName	String	是	设备名称，支持大小写字母、数字、中划线
DeviceNSID	String	是	设备国标 ID，需要按照国标 ID 标准进行定义，可通过调用 GenSipID 接口生成设备国标 ID
Username	String	是	设备用户名，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-），4~40位
Password	String	是	设备密码，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-），4~40位
Description	String	否	设备描述，输入100个字符以内的描述
AutoPullAfterRegister	Boolean	否	是否自动启动拉流： true：是（默认） false：否
RtpTransportTcp	Boolean	否	流媒体传输是否使用 TCP 协议： true：是（默认） false：否
Location	String	否	设备地址
Coordinates	Objects	否	设备经纬度，参考以下经纬度结构说明
AlertNotification	Objects	否	设备报警配置，参考以下报警配置结构说明
UseSubStream	Boolean	否	是否使用子码流, 开启后可以拉取子码流

经纬度结构说明

字段	类型	必填	说明
Longitude	Float64	否	经度
Latitude	Float64	否	纬度

报警配置结构说明

字段	类型	必填	说明
Enabled	Boolean	否	是否开启报警通知服务： true：开启，至少包含一种报警方式 false：关闭（默认）
Phone	Boolean	否	是否开启电话报警方式，默认为 false
Device	Boolean	否	是否开启设备报警方式，默认为 false
SMS	Boolean	否	是否开启短信报警方式，默认为 false
GPS	Boolean	否	是否开启 GPS 报警方式，默认为 false
Video	Boolean	否	是否开启视频报警方式，默认为 false
DeviceFault	Boolean	否	是否开启设备故障报警方式，默认为 false
Other	Boolean	否	是否开启其他报警方式，默认为 false

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
ID	String	创建成功的设备 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateDevice
&Version=2021-01-01
&SpaceID=2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx
&<公共请求参数>
{
    "Type": "IPC",
    "DeviceName": "SH-HK-IPC01",
    "DeviceNSID": "34020056991320897475", 
    "Username": "34020056991320897475", 
    "Password": "123456",
    "Description": "Camera001",
    "AutoPullAfterRegister": true,
    "RtpTransportTcp": true,
    "UseSubStream": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081406580102120420190E013AE2",
        "Action": "CreateDevice",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "6851c282-c7f6-4a04-90f9-d9c8baxxxxxx"
    }
}