报警使能V3--慢直播-火山引擎

文档中心

立即注册

导航

报警使能V3

最近更新时间：2025.02.14 16:29:36首次发布时间：2025.02.14 16:29:36

为指定设备开启或关闭报警事件通知功能。
注意：某些设备已默认开通报警事件通知功能。

请求说明

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

请求参数

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

Query Parameters

参数	类型	是否必选	示例值	描述
Action	String	是	`SetDeviceAlarm`	接口名称。当前 API 的名称为 `SetDeviceAlarm`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。

Body

参数	类型	是否必选	示例值	描述
DeviceID	String	是	`a4a17959-e3c5-4cae-98cd-03410b7192d6`	设备国标 ID，可通过调用 ListDevices 接口获取
StreamID	String	否	`48d69d60-1a94-4dbb-91a1-3cb75065a7da`	视频流ID，可通过调用 ListStreams 接口获取
Enable	Boolean	是	`true`	开启或关闭报警事件通知功能，可选枚举值为： - true（开启；需要在调用 CreateDevice 接口创建设备时，设备报警配置的 `Enabled` 参数也设置为 true） - false（关闭）

请求示例

POST https://open.volcengineapi.com?Action=SetDeviceAlarm&Version=2023-10-01

{
  "DeviceID": "a4a17959-e3c5-4cae-98cd-03410b7192d6",
  "StreamID": "48d69d60-1a94-4dbb-91a1-3cb75065a7da",
  "Enable": true
}

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022081016293701022514606301084329",
        "Action": "SetDeviceAlarm",
        "Version": "2023-10-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    }
}

错误码

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