GetQuotaAlarm - Quota Center - Alibaba Cloud Documentation Center

Queries the details of a specific quota alert.

Operation description

The quota alert feature has been upgraded. This API operation is deprecated. This operation queries the details of legacy quota usage alerts only. To query the details of new quota usage alerts, call the Cloud Monitor API operation DescribeMetricRuleList. For more information about managing new quota alerts using API operations, see Manage new quota alerts using API operations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quotas:GetQuotaAlarm

get

*QuotaAlarm

acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}

None

Request parameters

Parameter	Type	Required	Description	Example
AlarmId	string	No	The ID of the quota alert. For more information about how to get the ID of a quota alert, see ListQuotaAlarms.	78d7e436-4b25-4897-84b5-d7b656bb****

Response elements

Element	Type	Description	Example
	object	None.
QuotaAlarm	object	The details of the quota alert.
AlarmId	string	The ID of the quota alert.	78d7e436-4b25-4897-84b5-d7b656bb****
AlarmName	string	The name of the quota alert.	q_security-groups alarm
CreateTime	string	The time when the quota alert was created.	2021-01-21T03:47:28Z
NotifyChannels	array	The notification channels for the alert.
	string	A notification channel. Valid values: sms: text message. email: email.	["sms", "email"]
NotifyTarget	string	The notification object for the quota alert.	accountContact
ProductCode	string	The abbreviation of the Alibaba Cloud service name.	ecs
QuotaActionCode	string	The quota ID.	q_security-groups
QuotaDimension	object	The quota dimension.	{"regionId":"cn-hangzhou"}
QuotaUsage	number	The quota usage.	28
QuotaValue	number	The quota value.	804
Threshold	number	The numeric value of the alert threshold.	29
ThresholdPercent	number	The percentage of the alert threshold.	50
ThresholdType	string	The type of the quota alert. Valid values: used: The alert is based on the used quota. usable: The alert is based on the available quota.	used
Webhook	string	The webhook URL to which Quota Center sends alert information using an HTTP POST request.	https://alert.aliyun.com/callback
RequestId	string	The request ID.	81B9D511-F3DD-43B1-9A81-1795DDB52ADF

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	RAM.PERMISSION.DENIED	You are not authorized to do this action or the API input parameter is invalid.	You have no access
400	ALARM.NOT.FOUND	The AlarmId provided does not exist in our records.	The quota alert does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.