DescribeAlertLogList - Cloud Monitor - Alibaba Cloud Documentation Center

The DescribeAlertLogList operation queries the alert history.

Operation description

This operation queries the alert history of the last year.

This topic provides an example of how to query the alert history of Elastic Compute Service (ECS) by the product dimension.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeAlertLogList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	integer	No	The beginning of the time range to query. This value is a UNIX timestamp. Unit: milliseconds. You can query the alert history of the last year. If the specified time range is more than one year ago, the value of the `AlertLogList` parameter is empty. Note The interval between `StartTime` and `EndTime` cannot exceed 15 days. You must specify both parameters or leave both empty. If you leave them empty, the alert history of the last 15 minutes is queried.	1609988009694
EndTime	integer	No	The end of the time range to query. This value is a UNIX timestamp. Unit: milliseconds. You can query the alert history of the last year. If the specified time range is more than one year ago, the value of the `AlertLogList` parameter is empty. Note The interval between `StartTime` and `EndTime` cannot exceed 15 days. You must specify both parameters or leave both empty. If you leave them empty, the alert history of the last 15 minutes is queried.	1610074409694
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
SearchKey	string	No	The keyword to use for searches of the alert history.	alert
GroupId	string	No	The ID of the application group.	7301****
Namespace	string	No	The namespace of the cloud service. Note For more information, see Metrics.	acs_ecs_dashboard
Product	string	No	The abbreviation of the cloud service name. For more information about how to obtain the abbreviation of a cloud service name, see DescribeProductsOfActiveMetricRule.	ECS
Level	string	No	The alert level and notification methods. Valid values: P2: phone call, text message, email, and DingTalk chatbot. P3: text message, email, and DingTalk chatbot.	P4
SendStatus	string	No	The alert status. Valid values: 0: An alert is triggered or cleared. 1: The alert rule is ineffective. 2: The alert is in a mute period. 3: The host is restarting. 4: No alert notifications are sent. If the value of this parameter is 0 and the value of `Level` is P4, an alert is triggered. If the value of this parameter is 0 and the value of `Level` is OK, the alert is cleared.	0
ContactGroup	string	No	The alert contact group.	ECS_Group
RuleName	string	No	The name of the alert rule.	test123
MetricName	string	No	The name of the metric. Note For more information, see Metrics.	IntranetInRate
LastMin	string	No	The time period to query logs. Unit: minutes.	360
GroupBy	string	No	The dimension for grouping alert history data. This is similar to the GROUP BY clause in SQL. Valid values: `product`: Group by cloud service. `level`: Group by alert level. `groupId`: Group by application group. `contactGroup`: Group by alert contact group. `product,metricName`: Group by cloud service and metric.	product
RuleId	string	No	The ID of the alert rule. For more information about how to query the ID of an alert rule, see DescribeMetricRuleList.	bc369e8_30f87e517ed2fc****
SourceType	string	No	The type of the alert rule. Set the value to METRIC. METRIC indicates a threshold-based alert rule.	METRIC
EventType	string	No	The type of the alert. Valid values: TRIGGERED: The alert is triggered. RESOLVED: The alert is cleared.	TRIGGERED

For more information, see Common Parameters.

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	1C4A3709-BF52-42EE-87B5-7435F0929585
Success	boolean	Indicates whether the operation was successful. Valid values: true false	true
Code	string	The status code. Note A status code of 200 indicates that the operation was successful.	200
Message	string	The error message.	The specified resource is not found.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	10
AlertLogList	array<object>	The alert history.
	array<object>	None.
MetricName	string	The name of the metric.	cpu_total
EventName	string	The name of the event.	IOHang
Product	string	The identifier of the cloud service. Valid values: If the cloud service is an Alibaba Cloud service, the value is the abbreviation of the cloud service name. Example: ECS. If the cloud service is not an Alibaba Cloud service, the value is in the `acs_Service keyword` format. Example: acs_networkmonitor.	ECS
BlackListUUID	string	The UUID of the blacklist policy that is hit.	8410dbbd-7d30-41c5-94cb-****
Message	string	The information about the alert. The value is a JSON string.	{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}
Namespace	string	The namespace of the cloud service.	acs_ecs_dashboard
LevelChange	string	The change of the alert level. Valid values: `P4->OK`: The alert is cleared from P4. `P4->P4`: The alert at the P4 level persists.	P4->OK
InstanceId	string	The resource ID.	i-m5e1qg6uo38rztr4****
RuleName	string	The name of the alert rule.	CPU使用率
RuleId	string	The ID of the alert rule.	d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime
BlackListName	string	The name of the blacklist policy that is hit.	Black_Test
GroupName	string	The name of the application group.	ECS_Instances
GroupId	string	The ID of the application group.	7301****
AlertTime	string	The timestamp when the alert was triggered. Unit: milliseconds.	1610043776621
InstanceName	string	The name of the resource.	portalHost
BlackListDetail	string	The details of the blacklist policy that is hit.	{"id":12**,"metricProject":"acs_ecs_dashboard","userId":173651113438,"uuid":"8410dbbd-7d30-41c5-94cb-","name":"alert-","productCategory":"ecs","instances":[{"instanceId":"i-m5e1qg6uo38rztr4**"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}
Level	string	Specifies the alert level and the corresponding notification methods. Valid values are: P4: Email and DingTalk Robot. OK: No alert.	P4
SendStatus	string	The alert status. Valid values: 0: An alert is triggered or cleared. 1: The alert rule is ineffective. 2: The alert is in a mute period. 3: The host is restarting. 4: No alert notifications are sent. If the value of this parameter is 0 and the value of `Level` is P4, an alert is triggered. If the value of this parameter is 0 and the value of `Level` is OK, the alert is cleared.	0
ExtendedInfo	array<object>	The extended information of the alert.
	object	None.
Name	string	The name of the extended field.	userId
Value	string	The value of the extended field.	100931896542****
Dimensions	array<object>	The dimensions of the alert-triggering resource.
	object	None.
Key	string	The key of the dimension.	instanceId
Value	string	The value of the dimension.	i-m5e1qg6uo38rztr4****
WebhookList	array<object>	The list of callback URLs.
	object	None.
code	string	The status code of the alert callback.	200
url	string	The callback URL.	https://www.aliyun.com/webhook.html
message	string	The message returned for the alert callback.	success
DingdingWebhookList	array	The list of webhook URLs of the alert contacts.
	string	The list of webhook URLs of the alert contacts.	https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****
ContactOnCallList	array	The list of phone numbers of the alert contacts.
	string	The list of phone numbers of the alert contacts. Note This parameter is available only on the China site (aliyun.com).	1368888****
ContactMailList	array	The list of email addresses of the alert contacts.
	string	The list of email addresses of the alert contacts.	username@example.com
ContactGroups	array	The list of alert contact groups.
	string	The alert contact group.	ECS_Group
ContactALIIWWList	array	The list of TradeManager IDs of the alert contacts.
	string	The list of TradeManager IDs of the alert contacts. Note This parameter is available only on the China site (aliyun.com).	Alice
ContactSMSList	array	The list of text message recipients.
	string	The list of text message recipients. Note This parameter is available only on the China site (aliyun.com).	1368888****
ContactDingList	array	The list of DingTalk chatbots of the alert contacts.
	string	The list of DingTalk chatbots of the alert contacts.	CloudMonitor
SendDetail	object	The details of the alert notification.
ResultCode	string	The status of the alert notification. success: The notification is sent. Error code: If an error occurs in the configuration, no notification is sent and an error code is returned.	success
ChannelResultList	array<object>	The list of alert notifications that are sent through each channel.
	array<object>	The results of the alert notifications that are sent through each channel.
Channel	string	The channel to which the alert notification is sent. Valid values: MAIL: email SMS: text message WEBHOOK: webhook SLS: Simple Log Service ONCALL: phone call FC: Function Compute MNS: Message Service (MNS)	MAIL
ResultList	array<object>	The list of results of the alert notifications that are sent through the channel.
	object	The result of the alert notification that is sent through the channel.
Code	string	The status code. If `Channel` is set to `WEBHOOK`, the status code is 200 or 500. If `Channel` is set to `MAIL`, `SMS`, `SLS`, `ONCALL`, `FC`, or `MNS`, this parameter is not returned or is empty.	200
RequestId	string	The ID of the request that is sent to another cloud service.	0BDAF8A8-04DC-5F0C-90E4-724D42C4****
Success	boolean	The result of the call. true: The call is successful. false: The call fails.	true
Detail	string	The details of the returned result.	{ }
notifyTargetList	array	The list of notification channels.
	string	The list of notification channels.	MAIL
Escalation	object	The alert rule that is triggered.
Expression	string	The description of the alert rule. Note This is the condition for triggering the alert rule. An alert is triggered if the monitoring data meets the condition.	$Average<90
Times	integer	The number of retries.	1
Level	string	The alert level and notification methods. Valid values: P2: phone call, text message, email, and DingTalk chatbot. P3: text message, email, and DingTalk chatbot.	P4
SendResultList	array<object>	The list of alert notification results.
	object	The list of alert notification results.
Key	string	The channel to which the alert notification is sent. Valid values: MAIL: email ALIIM: TradeManager SMS: text message CALL: phone call DING: DingTalk chatbot Merged: merged alert	MAIL
Value	array	The notification object.
	string	The notification object.	username@example.com
LogId	string	The log ID.	7510**::e8a472a0-46ae-4ac0-84b1-e46be368**

Examples

Success response

JSON format

{
  "RequestId": "1C4A3709-BF52-42EE-87B5-7435F0929585",
  "Success": true,
  "Code": "200",
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 10,
  "AlertLogList": [
    {
      "MetricName": "cpu_total",
      "EventName": "IOHang",
      "Product": "ECS",
      "BlackListUUID": "8410dbbd-7d30-41c5-94cb-****",
      "Message": "{\"alertName\":\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\"}",
      "Namespace": "acs_ecs_dashboard",
      "LevelChange": "P4->OK",
      "InstanceId": "i-m5e1qg6uo38rztr4****",
      "RuleName": "CPU使用率",
      "RuleId": "d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime",
      "BlackListName": "Black_Test",
      "GroupName": "ECS_Instances",
      "GroupId": "7301****",
      "AlertTime": "1610043776621",
      "InstanceName": "portalHost",
      "BlackListDetail": "{\"id\":12****,\"metricProject\":\"acs_ecs_dashboard\",\"userId\":173651113438****,\"uuid\":\"8410dbbd-7d30-41c5-94cb-****\",\"name\":\"alert-****\",\"productCategory\":\"ecs\",\"instances\":[{\"instanceId\":\"i-m5e1qg6uo38rztr4****\"}],\"metrics\":null,\"scopeType\":\"USER\",\"scopeValue\":\"\",\"startTime\":\"0001-01-01T00:00:00Z\",\"endTime\":\"9999-12-31T23:59:59.999999999+08:00\",\"effectiveTime\":null,\"isEnable\":true,\"status\":1,\"gmtCreate\":\"2021-11-02T16:35:59+08:00\",\"gmtModified\":\"2021-11-02T16:35:59+08:00\",\"loadTime\":\"2021-11-02T16:36:15.213072177+08:00\"}",
      "Level": "P4",
      "SendStatus": "0",
      "ExtendedInfo": [
        {
          "Name": "userId",
          "Value": "100931896542****"
        }
      ],
      "Dimensions": [
        {
          "Key": "instanceId",
          "Value": "i-m5e1qg6uo38rztr4****"
        }
      ],
      "WebhookList": [
        {
          "code": "200",
          "url": "https://www.aliyun.com/webhook.html",
          "message": "success"
        }
      ],
      "DingdingWebhookList": [
        "https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****"
      ],
      "ContactOnCallList": [
        "1368888****"
      ],
      "ContactMailList": [
        "username@example.com"
      ],
      "ContactGroups": [
        "ECS_Group"
      ],
      "ContactALIIWWList": [
        "Alice"
      ],
      "ContactSMSList": [
        "1368888****"
      ],
      "ContactDingList": [
        "CloudMonitor"
      ],
      "SendDetail": {
        "ResultCode": "success",
        "ChannelResultList": [
          {
            "Channel": "MAIL",
            "ResultList": [
              {
                "Code": "200",
                "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C4****",
                "Success": true,
                "Detail": "{ }",
                "notifyTargetList": [
                  "MAIL"
                ]
              }
            ]
          }
        ]
      },
      "Escalation": {
        "Expression": "$Average<90",
        "Times": 1,
        "Level": "P4"
      },
      "SendResultList": [
        {
          "Key": "MAIL",
          "Value": [
            "username@example.com"
          ]
        }
      ],
      "LogId": "7510****::e8a472a0-46ae-4ac0-84b1-e46be368****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Parameter invalid.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.