报警回调--云拨测-火山引擎

文档中心

导航

报警回调

最近更新时间：2023.11.01 11:21:36首次发布时间：2023.10.13 14:33:20

本文档介绍如何使用报警回调。
您在创建报警时，可以配置在互联网上可访问的回调 URL，例如 https://www.volcengine.com。当报警被触发时，云拨测通过 POST 请求把 JSON 格式的报警通知发送到您配置的回调 URL。您对收到的报警通知进行处理后，就可以把报警通知接入您的消息机器人或工单系统。
回调 URL 不支持 IP 地址。

报警回调参数说明

云拨测发送的 JSON 格式的报警通知的参数说明如下：

参数	类型	说明
task_id	Integer	报警任务 ID。
account_id	Integer	创建报警的火山引擎用户账号。
owner	String	如果创建报警的账号为主账号：创建报警的火山引擎用户名。如果创建报警的账号为子用户：`root`。
name	String	报警的名称。
remark	String	报警的备注。
receivers	Array of Strings	报警接收人。
receive_groups	Array of Strings	该参数已废弃。
suggestion	String	该参数已废弃。
subtask_list	Array of Objects	报警关联的拨测任务列表。参见 subtask_list。
grade	String	报警级别。 `P0`：严重 `P2`：普通

subtask_list

参数	类型	说明
subtask_id	Integer	拨测任务 ID。
filters	Array of Objects	监控维度。参见 filters。
alarm_begin_time	String	报警开始时间。
alarm_detail	Array of Objects	报警详细信息。参见 alarm_detail。

filters

参数	类型	说明
key	String	监控维度的 key。 `$[client.isp.name]`：运营商 `$[client.province.name]`：地区
values	Array of Strings	监控维度的值。
type	String	监控维度的类型。固定为 `in`。

参数

类型

说明

key

String

监控维度的 key。

$[client.isp.name]：运营商
$[client.province.name]：地区

values

Array of Strings

监控维度的值。

type

String

监控维度的类型。固定为 in。

alarm_detail

参数	类型	说明
metric_key	String	触发告警的监控指标。参见报警监控指标。
threshold	Float	触发告警的监控指标阈值。
cur_value	Float	触发告警的监控指标的实际值。

报警回调示例

{
    "task_id": 3467,
    "account_id": 7031833983918818092,
    "owner": "userA",
    "name": "同比昨日增加",
    "remark": "",
    "receivers": [
        "userA"
    ],
    "receive_groups": null,
    "suggestion": "",
    "subtask_list": [
        {
            "subtask_id": 22394,
            "filters": [
                {
                    "Key": "$[client.isp.name]",
                    "Values": [
                        "移动"
                    ],
                    "Type": "in"
                },
                {
                    "Key": "$[client.province.name]",
                    "Values": [
                        "浙江"
                    ],
                    "Type": "in"
                }
            ],
            "alarm_begin_time": "2022-07-01T11:52:17+08:00",
            "alarm_detail": [
                {
                    "metric_key": "#[success.proportion]",
                    "threshold": 1,
                    "cur_value": 99.93887
                }
            ]
        }
    ],
    "grade": "P2"
}