All Products
Search
Document Center

Quota Center:GetQuotaAlarm

Last Updated:Jan 26, 2024

In this example, the operation is called to query the details of a quota alert. The details of the alert are returned. The query results include the alert ID, alert name, alert contact, and time when the quota alert was created.

Operation description

In this example, the operation is called to query the details of a quota alert whose ID is 78d7e436-4b25-4897-84b5-d7b656bb****. The details of the alert are returned. The query result includes the alert ID, alert name, alert contact, and the time when the quota alert was created.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AlarmIdstringNo

The ID of the quota alert.

For more information about how to query the ID of a quota alert, see ListQuotaAlarms .

78d7e436-4b25-4897-84b5-d7b656bb****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

81B9D511-F3DD-43B1-9A81-1795DDB52ADF
QuotaAlarmobject

The details of the quota alert.

ThresholdPercentfloat

The percentage of the alert threshold.

50
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
QuotaDimensionobject

The quota dimension.

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

The time when the quota alert was created.

2021-01-21T03:47:28Z
QuotaActionCodestring

The ID of the quota.

q_security-groups
AlarmNamestring

The name of the quota alert.

tf-testacccn-hangzhouquotasquotaalarm81611
NotifyTargetstring

The alert contact.

accountContact
NotifyChannelsarray

The alert notification methods.

string

The notification methods of the quota alert. Valid values:

  • sms: SMS messages
  • email: emails
["sms", "email"]
QuotaUsagefloat

The used quota.

28
QuotaValuefloat

The quota value.

804
AlarmIdstring

The ID of the quota alert.

78d7e436-4b25-4897-84b5-d7b656bb****
Thresholdfloat

The numeric value of the alert threshold.

29
ProductCodestring

The abbreviation of the cloud service name.

ecs
Webhookstring

The webhook URL. Quota Center sends alert notifications to the specified URL by using HTTP POST requests.

https://alert.aliyun.com/callback

Examples

Sample success responses

JSONformat

{
  "RequestId": "81B9D511-F3DD-43B1-9A81-1795DDB52ADF",
  "QuotaAlarm": {
    "ThresholdPercent": 50,
    "ThresholdType": "used",
    "QuotaDimension": {
      "regionId": "cn-hangzhou"
    },
    "CreateTime": "2021-01-21T03:47:28Z",
    "QuotaActionCode": "q_security-groups",
    "AlarmName": "tf-testacccn-hangzhouquotasquotaalarm81611",
    "NotifyTarget": "accountContact",
    "NotifyChannels": [
      "[\"sms\", \"email\"]"
    ],
    "QuotaUsage": 28,
    "QuotaValue": 804,
    "AlarmId": "78d7e436-4b25-4897-84b5-d7b656bb****",
    "Threshold": 29,
    "ProductCode": "ecs",
    "Webhook": "https://alert.aliyun.com/callback"
  }
}

Error codes

HTTP status codeError codeError message
400RAM.PERMISSION.DENIEDYou are not authorized to do this action or the API input parameter is invalid.

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

Change history

Change timeSummary of changesOperation
2023-09-22API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-09-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
2023-05-06The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.