ListAlerts - 查询告警发送历史 - 应用实时监控服务ARMS

告警发送历史接口。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:GetAlarmHistories	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
AlertName	string	否	告警名称。	告警测试
State	long	否	告警状态： 0：待处理 1：处理中 2：已处理	2
Severity	string	否	告警等级。告警严重程度从 P6、P5、P4、P3、P2、P1 逐级上升。	P6
DispatchRuleId	long	否	通知策略 ID。	12345
IntegrationType	string	否	集成类型。 ARMS CLOUD_MONITOR MSE ARMS_CLOUD_DIALTEST PROMETHEUS LOG_SERVICE CUSTOM ARMS_PROMETHEUS ARMS_APP_MON ARMS_FRONT_MON ARMS_CUSTOM XTRACE GRAFANA ZABBIX SKYWALKING EVENT_BRIDGE NAGIOS OPENFALCON ARMS_INSIGHTS	ARMS_APP_MON
StartTime	string	否	查询告警发送历史记录的开始时间，时间格式为`YYYY-MM-DD HH:mm:ss`。	2021-12-10 00:00:00
EndTime	string	否	查询告警发送历史记录的结束时间，时间格式为`YYYY-MM-DD HH:mm:ss`。	2021-12-22 23:59:59
ShowEvents	boolean	否	是否查询告警对应的事件。 `false`（默认）：不查询事件。 `true`：查询事件。	true
ShowActivities	boolean	否	是否查询告警对应的活动记录。 `false`（默认）：不查询活动记录。 `true`：查询活动记录，仅查询近 3 天的活动记录。	true
Page	long	是	查询页数。	1
Size	long	是	每页展示的告警数。	20
RegionId	string	否	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	2FC13182-B9AF-4E6B-BE51-72669B7C****
PageBean	object	返回结构体。
Total	long	查询到的告警总数。	1
Page	long	查询页数。	1
Size	long	每页展示的告警数。	20
ListAlerts	array<object>	告警发送历史信息组。
listAlerts	object	返回对象结构体。
AlertName	string	告警名称。	告警测试
Severity	string	告警等级。告警严重程度从 P6、P5、P4、P3、P2、P1 逐级上升。	P6
State	long	告警状态： 0：待处理 1：处理中 2：已处理	0
DispatchRuleId	float	通知策略 ID。	12345
DispatchRuleName	string	通知策略名称。	钉群通知
CreateTime	string	告警创建时间。	2022-01-18 00:21:35
Activities	array<object>	活动列表。
activities	object	活动对象。
Time	string	活动操作时间。	2021-12-20 19:08:57
Type	long	活动类型。 1：认领 2：取消认领 3：评论 4：关闭 5：通知	1
HandlerName	string	处理人名称。	运维A
Description	string	活动描述。	[告警认领]认领了该告警
Content	string	告警通知内容。	【通知策略: 钉群通知】主机监控节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %
AlertEvents	array<object>	事件列表。
alertEvents	object	事件对象。
AlertName	string	事件名称。	测试触发的告警
Severity	string	事件等级。 critical error warning info	warning
State	string	事件状态。 Active：未恢复 Silenced：静默 Resolved：已恢复	Active
StartTime	string	事件开始时间。	2022-01-18 00:14:00
EndTime	string	事件结束时间。	2022-01-19 17:10:31
ReceiveTime	string	事件创建时间。	2022-01-19 17:05:42
IntegrationName	string	事件对应的集成名称。	ARMS
IntegrationType	string	事件对应的集成类型。 ARMS CLOUD_MONITOR MSE ARMS_CLOUD_DIALTEST PROMETHEUS LOG_SERVICE CUSTOM ARMS_PROMETHEUS ARMS_APP_MON ARMS_FRONT_MON ARMS_CUSTOM XTRACE GRAFANA ZABBIX SKYWALKING EVENT_BRIDGE NAGIOS OPENFALCON ARMS_INSIGHTS	ARMS_APP_MON
GeneratorURL	string	事件地址。	http://arms.console.aliyun.com
Description	string	事件描述。	主机监控节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %
Annotations	string	注释列表。	{ "_aliyun_arms_alert_value":"4.0" "_aliyun_arms_alert_traceId":"ac10c43116421327442277073d5461-105075299"}
Labels	string	标签列表。	{ "severity":"warning" "_aliyun_arms_alert_level":"ERROR" "_aliyun_arms_entropy":"0.30170457417889235"}
AlertId	long	告警 ID	2279
Solution	string	告警解决方案	重启解决
Owner	string	告警负责人	通知策略中配置的联系人通知对象
Handler	string	告警处理人	认领、关闭告警的处理人
AcknowledgeTime	long	告警认领时长	告警从发生到认领之间的时长
RecoverTime	long	告警恢复时长	告警从发生到恢复之间的时长

示例

正常返回示例

JSON格式

{
  "RequestId": "2FC13182-B9AF-4E6B-BE51-72669B7C****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "ListAlerts": [
      {
        "AlertName": "告警测试",
        "Severity": "P6",
        "State": 0,
        "DispatchRuleId": 12345,
        "DispatchRuleName": "钉群通知",
        "CreateTime": "2022-01-18 00:21:35",
        "Activities": [
          {
            "Time": "2021-12-20 19:08:57",
            "Type": 1,
            "HandlerName": "运维A",
            "Description": "[告警认领]认领了该告警",
            "Content": "【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %"
          }
        ],
        "AlertEvents": [
          {
            "AlertName": "测试触发的告警",
            "Severity": "warning",
            "State": "Active",
            "StartTime": "2022-01-18 00:14:00",
            "EndTime": "2022-01-19 17:10:31",
            "ReceiveTime": "2022-01-19 17:05:42",
            "IntegrationName": "ARMS",
            "IntegrationType": "ARMS_APP_MON",
            "GeneratorURL": "http://arms.console.aliyun.com",
            "Description": "主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %",
            "Annotations": "{ \"_aliyun_arms_alert_value\":\"4.0\" \"_aliyun_arms_alert_traceId\":\"ac10c43116421327442277073d5461-105075299\"}",
            "Labels": "{ \"severity\":\"warning\" \"_aliyun_arms_alert_level\":\"ERROR\" \"_aliyun_arms_entropy\":\"0.30170457417889235\"}"
          }
        ],
        "AlertId": 2279,
        "Solution": "重启解决",
        "Owner": "通知策略中配置的联系人通知对象",
        "Handler": "认领、关闭告警的处理人",
        "AcknowledgeTime": 0,
        "RecoverTime": 0,
        "NotifyRobots": "",
        "Describe": ""
      }
    ]
  },
  "Message": ""
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-26	OpenAPI 返回结构发生变更	查看变更详情
2024-07-30	OpenAPI 入参发生变更	查看变更详情
2023-12-11	OpenAPI 返回结构发生变更	查看变更详情
2023-12-08	OpenAPI 返回结构发生变更	查看变更详情
2023-12-08	OpenAPI 返回结构发生变更	查看变更详情
2023-08-17	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-25	OpenAPI 返回结构发生变更	查看变更详情
2023-05-11	OpenAPI 返回结构发生变更	查看变更详情
2022-01-14	新增 OpenAPI	查看变更详情