ListQuotaAlarms - Quota Center - Alibaba Cloud Documentation Center

Queries quota alerts.

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
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 For more information, see Alibaba Cloud services that support Quota Center.	ecs
AlarmName	string	No	The name of the alert.	rules
QuotaActionCode	string	No	The ID of the quota. Note The `ProductCode` parameter is required if you specify this parameter.	q_hvnoqv
QuotaDimensions	object []	No	The quota dimensions.
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.	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.	cn-hangzhou

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history