GetQuotaAlarm - Quota Center - Alibaba Cloud Documentation Center

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

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:GetQuotaAlarm	get	QuotaAlarm acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}	none	none

Request parameters

Parameter	Type	Required	Description	Example
AlarmId	string	No	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	81B9D511-F3DD-43B1-9A81-1795DDB52ADF
QuotaAlarm	object	The details of the quota alert.
ThresholdPercent	float	The percentage of the alert threshold.	50
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
QuotaDimension	object	The quota dimension.	{"regionId":"cn-hangzhou"}
CreateTime	string	The time when the quota alert was created.	2021-01-21T03:47:28Z
QuotaActionCode	string	The ID of the quota.	q_security-groups
AlarmName	string	The name of the quota alert.	tf-testacccn-hangzhouquotasquotaalarm81611
NotifyTarget	string	The alert contact.	accountContact
NotifyChannels	array	The alert notification methods.
NotifyChannels	string	The notification methods of the quota alert. Valid values: sms: SMS messages email: emails	["sms", "email"]
QuotaUsage	float	The used quota.	28
QuotaValue	float	The quota value.	804
AlarmId	string	The ID of the quota alert.	78d7e436-4b25-4897-84b5-d7b656bb****
Threshold	float	The numeric value of the alert threshold.	29
ProductCode	string	The abbreviation of the cloud service name.	ecs
Webhook	string	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 code	Error code	Error message
400	RAM.PERMISSION.DENIED	You 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 time	Summary of changes	Operation
2023-09-22	API Description Update. The Error code has changed	View Change Details
2023-09-04	The Error code has changed	View Change Details
2023-05-06	The response structure of the API has changed	View Change Details