查询告警事件历史。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AlertName |
string |
否 |
告警名称。 |
测试触发的告警 |
| StartTime |
string |
否 |
查询告警发送历史记录的开始时间,时间格式:YYYY-MM-DD HH:mm:ss |
2021-12-19 00:00:00 |
| EndTime |
string |
否 |
查询告警发送历史记录的结束时间,时间格式:YYYY-MM-DD HH:mm:ss |
2021-12-22 23:59:59 |
| Page |
integer |
是 |
查询页数。 |
1 |
| Size |
integer |
是 |
每页展示数目。 |
20 |
| MatchingConditions |
string |
否 |
事件匹配规则列表。 |
[ { "value": "ARMS_NOTIFICATION", "key": "clustername", "operator": "eq" } ] },{ "matchingConditions": [ { "value": "test", "key": "alertname", "operator": "eq" } ] |
| Status |
string |
否 |
事件状态。
|
Active |
| ShowNotificationPolicies |
boolean |
否 |
是否展示关联的通知策略。 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
2FC13182-B9AF-4E6B-BE51-72669B7C**** |
| PageBean |
object |
返回结构体 |
|
| Total |
integer |
查询总数。 |
24 |
| Page |
integer |
查询到的页数。 |
1 |
| Size |
integer |
每页展示数目。 |
20 |
| Events |
array<object> |
告警事件历史信息组。 |
|
|
array<object> |
告警事件列表。 |
||
| AlertName |
string |
告警名称。 |
测试触发的告警 |
| Severity |
string |
告警等级:
|
critical |
| Status |
string |
事件状态。
|
Active |
| StartTime |
string |
开始时间。 |
2021-12-20 17:42:16 |
| EndTime |
string |
结束时间。 |
2021-12-20 17:42:16 |
| ReceiveTime |
string |
事件接收时间。 |
2021-12-20 17:42:16 |
| IntegrationName |
string |
集成名称。 |
自定义集成 |
| IntegrationType |
string |
集成类型。 |
CUSTOM |
| GeneratorURL |
string |
事件地址。 |
https://xxx.xx/ |
| Description |
string |
事件描述。 |
测试 |
| Annotations |
string |
注释列表。 |
[{\"Name\":\"annotation-a\",\"Value\":\"annotation a value\"}] |
| Labels |
string |
标签列表。 |
[{\"name\":\"severity\",\"value\":\"error\"}] |
| Alarms |
array<object> |
关联告警。 |
|
|
object |
告警信息。 |
||
| AlarmId |
integer |
告警 ID。 |
77444 |
| AlarmName |
string |
告警名称。 |
测试触发的告警 |
| State |
integer |
告警状态:
|
0 |
| CreateTime |
string |
告警创建时间。 |
2021-12-20 07:10:18 |
| HandlerName |
string |
处理人。 |
张三 |
| NotificationPolicies |
array<object> |
关联的通知策略。 |
|
|
object |
通知策略。 |
||
| Id |
integer |
通知策略 ID。 |
646093 |
| Name |
string |
通知策略名称。 |
P1告警通知策略 |
| TriggerCount |
integer |
触发次数。 |
10 |
示例
正常返回示例
JSON格式
{
"RequestId": "2FC13182-B9AF-4E6B-BE51-72669B7C****",
"PageBean": {
"Total": 24,
"Page": 1,
"Size": 20,
"Events": [
{
"AlertName": "测试触发的告警",
"Severity": "critical",
"Status": "Active",
"StartTime": "2021-12-20 17:42:16",
"EndTime": "2021-12-20 17:42:16",
"ReceiveTime": "2021-12-20 17:42:16",
"IntegrationName": "自定义集成",
"IntegrationType": "CUSTOM",
"GeneratorURL": "https://xxx.xx/",
"Description": "测试",
"Annotations": "[{\\\"Name\\\":\\\"annotation-a\\\",\\\"Value\\\":\\\"annotation a value\\\"}]",
"Labels": "[{\\\"name\\\":\\\"severity\\\",\\\"value\\\":\\\"error\\\"}]",
"Alarms": [
{
"AlarmId": 77444,
"AlarmName": "测试触发的告警",
"State": 0,
"CreateTime": "2021-12-20 07:10:18"
}
],
"HandlerName": "张三",
"NotificationPolicies": [
{
"Id": 646093,
"Name": "P1告警通知策略"
}
],
"TriggerCount": 10
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。