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

文档中心

立即注册

导航

慢直播

报警使能

最近更新时间：2022.08.12 13:53:07首次发布时间：2022.08.12 13:53:07

为指定设备开启或关闭报警事件通知功能。

注意：某些设备已默认开通报警事件通知功能。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	SetAlarmGuard
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
DeviceNSID	Query	String	是	设备国标 ID	可通过调用 ListDevices 接口获取
ChannelID	Query	String	否	通道 ID	如不指定，则使能设备下所有通道
SipID	Query	String	否	SIP 服务器 ID
Enable	Query	String	是	开启或关闭报警事件通知功能	可选枚举值为： true（开启；需要在调用 CreateDevice 接口创建设备时，设备报警配置的 `Enabled` 参数也设置为 true） false（关闭）

返回结果

返回参数说明

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

示例

请求示例

POST https://open.volcengineapi.com?Action=SetAlarmGuard
&Version=2021-01-01
&DeviceNSID=34020033991320xxxxxx
&SipID=3402000000xxxxxxxxxx
&Enable=true
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022081016293701022514606301084329",
        "Action": "SetAlarmGuard",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    }
}