ListAlerts - Application Real-Time Monitoring Service - Alibaba Cloud Documentation Center

Queries the alert sending history.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AlertName	string	No	The name of the alert rule.	Test alert
State	long	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 severity level of the alert. Valid values: P6, P5, P4, P3, P2, and P1. The preceding values are listed in ascending order of severity.	P6
DispatchRuleId	long	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 alert sending history that you want to query. Specify the time in the `YYYY-MM-DD HH:mm:ss` format.	2021-12-10 00:00:00
EndTime	string	No	The end time of the alert sending history that you want to query. Specify the time in the `YYYY-MM-DD HH:mm:ss` format.	2021-12-22 23:59:59
ShowEvents	boolean	No	Specifies whether to query the events that correspond to alerts. Valid values: `false` (default value): The events are not queried. `true`: The events are queried.	true
ShowActivities	boolean	No	Specifies whether to query the activities that correspond to alerts. Valid values: `false` (default value): The activities are not queried. `true`: The activities in the last three days are queried.	true
Page	long	Yes	The number of the page to return.	1
Size	long	Yes	The number of alerts to return on each page.	20
RegionId	string	No	The ID of the region.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	2FC13182-B9AF-4E6B-BE51-72669B7C****
PageBean	object	The information about the array object.
Total	long	The total number of queried alerts.	1
Page	long	The page number of the returned page.	1
Size	long	The number of alerts returned per page.	20
ListAlerts	array<object>	The alerts for which the alert sending history is queried.
	object	The information about the array object.
AlertName	string	The name of the alert rule.	Test alert
Severity	string	The severity level of the alert. Valid values: P6, P5, P4, P3, P2, and P1. The preceding values are listed in ascending order of severity.	P6
State	long	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	float	The ID of the notification policy.	12345
DispatchRuleName	string	The name of the notification policy.	DingTalk Notification
CreateTime	string	The time when the alert was created.	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	long	The type of the activity. 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.	O\&M Engineer A
Description	string	The description of the activity.	\[Alert Claimed] The alert is claimed
Content	string	The content of the alert notification.	\[Notification policy: Send notifications to DingTalk groups] Host monitoring. Host IP address: 10.76.XX.XX. Average memory usage of the host in the last 1 minute ≥ 1.0%. Current value: 84.7454%.
AlertEvents	array<object>	The list of events.
	object	The details of each event.
AlertName	string	The name of the event.	Test-triggered alert
Severity	string	The severity level of the event. Valid values: critical error warning info	warning
State	string	The status of the event. 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 name of the integration that corresponds to the alert event.	ARMS
IntegrationType	string	The type of the integration that corresponds to 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.aliyun.com
Description	string	The description of the event.	Host monitoring. Host IP address: 10.76.XX.XX. Average memory usage of the host in the last 1 minute ≥ 1.0%. Current value: 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	long	The alert ID.	2279
Solution	string	The Alert solution.	--

Examples

Sample success responses

JSONformat

{
  "RequestId": "2FC13182-B9AF-4E6B-BE51-72669B7C****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "ListAlerts": [
      {
        "AlertName": "Test alert\n",
        "Severity": "P6",
        "State": 0,
        "DispatchRuleId": 12345,
        "DispatchRuleName": "DingTalk Notification\n",
        "CreateTime": "2022-01-18 00:21:35",
        "Activities": [
          {
            "Time": "2021-12-20 19:08:57",
            "Type": 1,
            "HandlerName": "O\\&M Engineer A\n",
            "Description": "\\[Alert Claimed] The alert is claimed\n",
            "Content": "\\[Notification policy: Send notifications to DingTalk groups] Host monitoring. Host IP address: 10.76.XX.XX. Average memory usage of the host in the last 1 minute ≥ 1.0%. Current value: 84.7454%.\n"
          }
        ],
        "AlertEvents": [
          {
            "AlertName": "Test-triggered alert\n",
            "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": "Host monitoring. Host IP address: 10.76.XX.XX. Average memory usage of the host in the last 1 minute ≥ 1.0%. Current value: 84.7454%.\n",
            "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": "--"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-11	The response structure of the API has changed	View Change Details
2023-12-08	The response structure of the API has changed	View Change Details
2023-12-08	The response structure of the API has changed	View Change Details
2023-08-17	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-05-25	The response structure of the API has changed	View Change Details
2023-05-11	The response structure of the API has changed	View Change Details
2022-01-14	Add Operation	View Change Details