ListQuotaAlarms - Quota Center - Alibaba Cloud Documentation Center

Queries quota alerts.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quotas:ListQuotaAlarms	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token that marks the position from which you want to start the query. Note An empty value indicates that the query starts from the beginning.	1
MaxResults	integer	No	The maximum number of records that you want to return for the query. Valid values: 1 to 200. Default value: 30.	20
ProductCode	string	No	The abbreviation of the Alibaba Cloud service name. Note To query the abbreviation of an Alibaba Cloud service name, call the ListProducts operation and check the value of `ProductCode` in the response.	ecs
AlarmName	string	No	The name of the alert.	rules
QuotaActionCode	string	No	The quota ID. Note To obtain the quota ID of a cloud service, call the ListProductQuotas operation and check the value of `QuotaActionCode` in the response. If you specify this parameter, you must specify `ProductCode`.	q_hvnoqv
QuotaDimensions	array<object>	No	The quota dimensions.
	object	No	The quota dimension.
Key	string	No	The key of the dimension. Note The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service. This parameter is required if you set the `ProductCode` parameter to `ecs`, `ecs-spec`, `actiontrail`, or `ess`.	regionId
Value	string	No	The value of the dimension. Note The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service. This parameter is required if you set the `ProductCode` parameter to `ecs`, `ecs-spec`, `actiontrail`, or `ess`.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
MaxResults	integer	The maximum number of records that are returned for the query.	1
NextToken	string	The token that marks the position at which the query ends. Note An empty value indicates that all data is returned.	1
QuotaAlarms	array<object>	The details about the quota alert rules.
QuotaAlarm	object	The details about the quota alert rule.
AlarmId	string	The ID of the alert.	a2efa7fc-832f-47bb-8054-39e28012****
AlarmName	string	The name of the alert event.	rules
CreateTime	string	The time when the quota alert was created.	2020-11-27T07:23:34Z
ExceedThreshold	boolean	Indicates whether the alert threshold was reached. Valid values: false true	false
NotifyChannels	array	The alert notification methods.
NotifyChannels	string	The alert notification methods. Valid values: sms email	sms
NotifyTarget	string	The alert contact. Note Valid value: accountContact. Only the account contact is supported.	accountContact
ProductCode	string	The abbreviation of the Alibaba Cloud service name.	config
QuotaActionCode	string	The ID of the quota.	q_hvnoqv
QuotaDimensions	object	The quota dimensions.	{"regionId":"cn-hangzhou"}
QuotaUsage	float	The used quota.	73
QuotaValue	float	The value of the quota.	200
Threshold	float	The numeric value of the alert threshold.	160
ThresholdPercent	float	The percentage of the alert threshold.	80
ThresholdType	string	The type of the quota alert. Valid values: used: The alert is created for the used quota. usable: The alert is created for the available quota.	used
WebHook	string	The webhook URL.	https://www.aliyun.com/webhook
RequestId	string	The ID of the request.	87F3B755-3BD2-4C76-B36A-93247002918C
TotalCount	integer	The total number of quota alerts.	2

Examples

Sample success responses

JSONformat

{
  "MaxResults": 1,
  "NextToken": "1",
  "QuotaAlarms": [
    {
      "AlarmId": "a2efa7fc-832f-47bb-8054-39e28012****",
      "AlarmName": "rules\n",
      "CreateTime": "2020-11-27T07:23:34Z",
      "ExceedThreshold": false,
      "NotifyChannels": [
        "sms"
      ],
      "NotifyTarget": "accountContact",
      "ProductCode": "config",
      "QuotaActionCode": "q_hvnoqv",
      "QuotaDimensions": {
        "regionId": "cn-hangzhou"
      },
      "QuotaUsage": 73,
      "QuotaValue": 200,
      "Threshold": 160,
      "ThresholdPercent": 80,
      "ThresholdType": "used",
      "WebHook": "https://www.aliyun.com/webhook"
    }
  ],
  "RequestId": "87F3B755-3BD2-4C76-B36A-93247002918C",
  "TotalCount": 2
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history