UpdateDevice - 更新设备--慢直播-火山引擎

文档中心

立即注册

导航

UpdateDevice - 更新设备

最近更新时间：2025.06.06 14:20:32首次发布时间：2021.11.25 17:21:24

更新指定设备的信息。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateDevice	要执行的操作，取值：UpdateDevice。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
DeviceName	String	否	device_name	设备名称
DeviceID	String	是	0a32c128-c89c-4f39-aa60-66e5f137e4c5	设备 ID，可通过调用 ListDevices 接口获取
DeviceNSID	String	否	31400000xxxxx10101	设备国标 ID
Username	String	否	31400000xxxxx10101	设备用户名： 4~40位，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-）
Password	String	否	##$$101	设备密码： 4~40位，支持大小写字母（A-Z，a-z）、数字（0-9）、中横线（-）
Description	String	否	device description	设备描述
AlertNotification	Object	否		设备报警事件通知方式，参考以下报警通知结构说明
AutoPullAfterRegister	Boolean	否	false	是否自动启动拉流： true：是 false：否
UseSubStream	Boolean	否	false	是否使用子码流, 开启后可以拉取子码流

返回参数

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

参数	类型	示例值	描述
ID	String	devicexxxxuuid	更新成功的设备 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"
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	NotFound.DeviceData	The request is failed due to request data not found.
404	NotFound.Device	"NotFound.Device":"设备不存在，请确保设备参数正确性后重试"