All Products
Search
Document Center

Quota Center:ListQuotaAlarms

Last Updated:Oct 12, 2023

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.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

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
MaxResultsintegerNo

The maximum number of records that you want to return for the query.

Valid values: 1 to 200. Default value: 30.

20
ProductCodestringNo

The abbreviation of the Alibaba Cloud service name.

Note For more information, see Alibaba Cloud services that support Quota Center.
ecs
AlarmNamestringNo

The name of the alert.

rules
QuotaActionCodestringNo

The ID of the quota.

Note The ProductCode parameter is required if you specify this parameter.
q_hvnoqv
QuotaDimensionsobject []No

The quota dimensions.

KeystringNo

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
ValuestringNo

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

ParameterTypeDescriptionExample
object

None.

TotalCountinteger

The total number of quota alerts.

2
QuotaAlarmsobject []

The details about the quota alert.

ThresholdPercentfloat

The percentage of the alert threshold.

80
ThresholdTypestring

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
QuotaDimensionsobject

The quota dimensions.

{"regionId":"cn-hangzhou"}
CreateTimestring

The time when the quota alert was created.

2020-11-27T07:23:34Z
QuotaActionCodestring

The ID of the quota.

q_hvnoqv
AlarmNamestring

The name of the alert event.

rules
NotifyTargetstring

The alert contact. The value is accountContact.

accountContact
NotifyChannelsarray

The alert notification methods.

string

The alert notification methods. Valid values:

  • sms
  • email
sms
QuotaUsagefloat

The used quota.

73
QuotaValuefloat

The value of the quota.

200
AlarmIdstring

The ID of the alert.

a2efa7fc-832f-47bb-8054-39e28012****
Thresholdfloat

The numeric value of the alert threshold.

160
ProductCodestring

The abbreviation of the Alibaba Cloud service name.

config
WebHookstring

The webhook URL.

https://www.aliyun.com/webhook
ExceedThresholdboolean

Indicates whether the alert threshold was reached. Valid values:

  • false
  • true
false
NextTokenstring

The token that marks the position at which the query ends.

Note An empty value indicates that all data is returned.
1
RequestIdstring

The ID of the request.

87F3B755-3BD2-4C76-B36A-93247002918C
MaxResultsinteger

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 timeSummary of changesOperation
No change history