ListAlerts - Query alert notification history - Application Real-Time Monitoring Service

Queries the alert sending history.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AlertName	string	No	The name of the alert rule.	告警测试
State	integer	No	The status of the alert. Valid values: 0: The alert is pending. 1: The alert is being handled. 2: The alert is handled.	2
Severity	string	No	The alert severity. Valid values: P6, P5, P4, P3, P2, and P1, in ascending order of severity.	P6
DispatchRuleId	integer	No	The ID of the notification policy.	12345
IntegrationType	string	No	The integration type. 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	No	The start time of the query range. Format: `YYYY-MM-DD HH:mm:ss`.	2021-12-10 00:00:00
EndTime	string	No	The end time of the query range. Format: `YYYY-MM-DD HH:mm:ss`.	2021-12-22 23:59:59
ShowEvents	boolean	No	Whether to include alert events in the response. Valid values: `false` (default): Events are not included. `true`: Events are included.	true
ShowActivities	boolean	No	Whether to include alert activities in the response. Valid values: `false` (default): Activities are not included. `true`: Activities from the last three days are included.	true
Page	integer	Yes	The number of the page to return.	1
Size	integer	Yes	The number of alerts to return on each page.	20
RegionId	string	No	The ID of the region.	cn-hangzhou
Owner	string	No	The notification recipient configured in the notification policy.	张三

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	2FC13182-B9AF-4E6B-BE51-72669B7C****
PageBean	object	The response body.
Total	integer	The total number of alerts.	1
Page	integer	The page number.	1
Size	integer	The number of alerts per page.	20
ListAlerts	array<object>	The alert notification history.
	array<object>	The details of each alert.
AlertName	string	The name of the alert rule.	告警测试
Severity	string	The alert severity. Valid values: P6, P5, P4, P3, P2, and P1, in ascending order of severity.	P6
State	integer	The status of the alert. Valid values: 0: The alert is pending. 1: The alert is being handled. 2: The alert is handled.	0
DispatchRuleId	number	The ID of the notification policy.	12345
DispatchRuleName	string	The name of the notification policy.	钉群通知
CreateTime	string	The alert creation time.	2022-01-18 00:21:35
Activities	array<object>	The list of activities.
	object	The details of each activity.
Time	string	The operation time of the activity.	2021-12-20 19:08:57
Type	integer	The activity type. Valid values: 1: The alert is claimed. 2: The alert is disclaimed. 3: A comment is added for the alert. 4: The alert is disabled. 5: An alert notification is sent.	1
HandlerName	string	The name of the handler.	运维A
Description	string	The description of the activity.	[告警认领]认领了该告警
Content	string	The content of the alert notification.	【通知策略: 钉群通知】主机监控节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %
AlertEvents	array<object>	The list of events.
	object	The details of each event.
AlertName	string	The name of the event.	测试触发的告警
Severity	string	The event severity. Valid values: critical error warning info	warning
State	string	The event status. Valid values: Active: The event is not cleared. Silenced: The event is silenced. Resolved: The event is cleared.	Active
StartTime	string	The time when the event started.	2022-01-18 00:14:00
EndTime	string	The time when the event ended.	2022-01-19 17:10:31
ReceiveTime	string	The time when the event was created.	2022-01-19 17:05:42
IntegrationName	string	The integration name for the alert event.	ARMS
IntegrationType	string	The integration type for the alert event. Valid values: 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	The URL of the event.	http://arms.console.alibabacloud.com
Description	string	The description of the event.	主机监控节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %
Annotations	string	The annotations.	{ "_aliyun_arms_alert_value":"4.0" "_aliyun_arms_alert_traceId":"ac10c43116421327442277073d5461-105075299"}
Labels	string	The tags.	{ "severity":"warning" "_aliyun_arms_alert_level":"ERROR" "_aliyun_arms_entropy":"0.30170457417889235"}
AlertId	integer	The alert ID.	2279
Solution	string	The alert solution.	重启解决
Owner	string	The notification recipient configured in the notification policy.	通知策略中配置的联系人通知对象
Handler	string	The alert handler.	认领、关闭告警的处理人
AcknowledgeTime	integer	The time to acknowledge the alert.	告警从发生到认领之间的时长
RecoverTime	integer	The alert recovery time.	告警从发生到恢复之间的时长
NotifyRobots	string	The contact card of an instant messaging app.	钉钉的名片。
Describe	string	The event execution status.	[告警通知]通过[webhook]通知了xxx(成功）
Message	string	The error message.	alert.manager.error.code.signature.invalid

Examples

Success response

JSON format

{
  "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.alibabacloud.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": "[告警通知]通过[webhook]通知了xxx(成功）"
      }
    ]
  },
  "Message": "alert.manager.error.code.signature.invalid"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.