文档中心

事件告警回调请求内容

最近更新时间：2024.04.15 15:07:28

首次发布时间：2024.04.12 15:14:45

当告警策略被触发且满足发送告警通知的聚合条件后，云监控通过告警回调接口发送POST请求至指定的URL。事件告警回调请求内容包括回调请求头Header和回调请求体Body。

Header键	Header值	说明
x-volc-trace-id	随机uuid	用于请求追踪。
x-volc-event-id	{ event_id }	事件ID。

回调请求体（Body）

数据类型

请求体的数据类型为application/json。

请求体参数

参数	类型	示例值	说明
Type	string	Event	告警类型。 Event：事件 Metric：阈值
AccountId	string	21*******53	账户ID。
Region	string	cn-guangzhou	地域。
Source	string	ecs	事件源，即产品类型。
Id	string	1658*****04000	事件唯一ID。
EventType	string	ecs:Disk:DiskError.Redeploy.Executing	事件名称。
DescriptionCN	string	硬盘异常，实例重新部署:执行中	事件中文名称。
HappenedAt	int64	1664332705	事件发生时间。
Details	string	-	事件原文。
Rules	List of Rule	-	事件规则详情。具体格式，请参见Rule结构。

Rule结构

参数	类型	示例值	说明
RuleId	string	1574**********8880	策略ID。
RuleName	string	测试事件告警1	策略名称。
Level	string	notice	告警级别。 critical：严重 warning：警告 notice：提示

参数

类型

示例值

说明

RuleId

string

1574**********8880

策略ID。

RuleName

string

测试事件告警1

策略名称。

Level

string

notice

告警级别。

critical：严重
warning：警告
notice：提示

请求体示例

说明

您可以忽略实际接收到的请求体中，没有提供参数说明的参数。这些参数将不会影响您获取告警通知的详细信息。
Details中包含固定字段和扩展字段。
- 固定字段：specversion、id、source、type、volcpublishtime、volcregion、volcaccountid、volceventbusname、volcresourcename、subject、time，固定字段即使为空也会显示。
- 扩展字段：除了固定字段以外，其他字段都是扩展字段。扩展字段是云产品自定义的事件类型。

{
    "Type":"Event",
    "AccountId":"21*****53",
    "Source":"ecs",
    "Id":"1658*****04000",
    "EventType":"ecs:Disk:DiskError.Redeploy.Executing",
    "DescriptionCN":"硬盘异常，实例重新部署:执行中",
    "HappenedAt":1664332705,
    "Region":"cn-guangzhou",
    "Details":{
        "specversion":"1.0",
        "id":"1658*****04000",
        "source":"ecs",
        "type":"ecs:Disk:DiskError.Redeploy.Executing",
        "volcpublishtime":"2023-05-16T14:23:26+08:00",
        "volcregion":"cn-guangzhou",
        "volcaccountid":"21*****53",
        "volceventbusname":"default",
        "volcresourcename":"test_resource_name_A",
        "subject":"ecs:cn-north-1:21*****53:instance/test-instanceId-A/tag/test-instanceId-B",
        "time":"2023-05-16T14:23:26+08:00",
        "data":{
            "kafka":"kafka-boe"
        },
        "biz":"event_center_to_kafka",
        "sasl_user":"event_producer"
    },
    "Rules":[
        {
            "RuleId":"1574**********8880",
            "RuleName":"测试事件告警1",
            "Level":"notice"
        },
        {
            "RuleId":"1574**********8881",
            "RuleName":"测试事件告警2",
            "Level":"warning"
        }
    ]
}

回调请求头（Header）

回调请求体（Body）

数据类型

请求体参数

请求体示例