编辑设备信息--慢直播-火山引擎

文档中心

立即注册

导航

编辑设备信息

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

更新指定设备的信息。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	UpdateDevice
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
DeviceID	Query	String	是	设备 ID	可通过调用 ListDevices 接口获取

Body参数

字段	类型	必填	说明
DeviceName	String	否	设备名称
DeviceNSID	String	否	设备国标 ID
Username	String	否	设备用户名： 4~40位，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-）
Password	String	否	设备密码： 4~40位，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-）
Description	String	否	设备描述
AutoPullAfterRegister	Boolean	否	是否自动启动拉流： true：是 false：否
AlertNotification	Array of Boolean	否	设备报警事件通知方式，参考以下报警通知结构说明
UseSubStream	Boolean	否	是否使用子码流, 开启后可以拉取子码流

报警通知结构说明

字段	类型	必填	说明
Enabled	Boolean	否	是否开启报警通知服务
Phone	Boolean	否	电话报警
Device	Boolean	否	设备报警
SMS	Boolean	否	短信报警
GPS	Boolean	否	GPS 报警
Video	Boolean	否	视频报警
DeviceFault	Boolean	否	设备故障报警
Other	Boolean	否	其它报警

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	更新成功的设备 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=UpdateDevice
&Version=2021-01-01
&DeviceID=0a32c128-c89c-4f39-aa60-66e5f137e4c5
&<公共请求参数>
{
    "DeviceName": "SH-HK-IPC02",
    "Password": "xxxxxx",
    "Description": "Camera002",
    "AutoPullAfterRegister": false,
    "AlertNotification":
    {
         "Enabled": true,
         "Phone": true,
         "SMS": true 
    },
    "UseSubStream": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211208145119010210018026090150C9",
        "Action": "UpdateDevice",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "0a32c128-c89c-4f39-aa60-66e5f1xxxxxx"
    }
}