ListAlarmHistories - Quota Center - Alibaba Cloud Documentation Center

Queries the history of quota alerts.

Operation description

This API is deprecated because the quota alert feature has been upgraded. It queries only the alert history for the previous version of Quota Center. To query the alert history for the current version, use the Cloud Monitor APIs DescribeAlertLogCount and DescribeAlertLogList. For more information, see Use APIs to manage alerts for the current version of Quota Center.

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

quotas:ListAlarmHistories

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token that specifies the position from which the query starts. If you leave this parameter empty, the query starts from the beginning.	1
MaxResults	integer	No	The maximum number of entries to return for a single query. Valid values: 1 to 200. Default value: 30.	30
Keyword	string	No	The keyword for the query.	Quantity
StartTime	integer	No	The beginning of the time range to query.	20201020
EndTime	integer	No	The end of the time range to query.	20201024
ProductCode	string	No	The abbreviation of the Alibaba Cloud service name. Note For more information about the Alibaba Cloud services that support Quota Center, see Alibaba Cloud services that support Quota Center.	ecs
AlarmId	string	No	The ID of the alert.	18b3be23-b7b0-4d45-91bc-d0c331aa****

Response elements

Element	Type	Description	Example
	object	None.
AlarmHistories	array<object>	The details of the quota alert history.
	object	The details of the quota alert history.
AlarmName	string	The name of the quota alert.	q_security-groups alarm
CreateTime	string	The time when the quota alert was created.	2021-01-24T09:20:09Z
NotifyChannels	array	The notification channels for the quota alert.
	string	The notification channel. Valid values: sms: text message email: email	["sms", "email"]
NotifyTarget	string	The recipient of the alert notification.	accountContact
ProductCode	string	The abbreviation of the Alibaba Cloud service name.	ecs
QuotaActionCode	string	The quota ID.	q_security-groups
QuotaUsage	number	The used quota.	31
Threshold	number	The numeric value of the alert threshold.	29
ThresholdPercent	number	The percentage of the alert threshold.	80
MaxResults	integer	The maximum number of entries returned.	4
NextToken	string	The token to retrieve the next page of results. If this parameter is not returned, it indicates that all results have been returned.	1
RequestId	string	The request ID.	CB38DDF9-B1E0-48C1-9966-19C443C2841E
TotalCount	integer	The total number of entries returned.	4

Examples

Success response

JSON format

{
  "AlarmHistories": [
    {
      "AlarmName": "q_security-groups alarm",
      "CreateTime": "2021-01-24T09:20:09Z",
      "NotifyChannels": [
        "[\"sms\", \"email\"]"
      ],
      "NotifyTarget": "accountContact",
      "ProductCode": "ecs",
      "QuotaActionCode": "q_security-groups",
      "QuotaUsage": 31,
      "Threshold": 29,
      "ThresholdPercent": 80
    }
  ],
  "MaxResults": 4,
  "NextToken": "1",
  "RequestId": "CB38DDF9-B1E0-48C1-9966-19C443C2841E",
  "TotalCount": 4
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime	Invalid StartTime	The specified start time is invalid.
400	InvalidEndTime	Invalid EndTime	The specified end time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.