All Products
Search
Document Center

Quota Center:CreateQuotaAlarm

Last Updated:Nov 24, 2025

Creates a quota alert.

Operation description

This API operation is deprecated because the quota alert feature has been upgraded. Use the Cloud Monitor API operations PutResourceMetricRules and PutMetricRuleTargets to create new quota alert rules. For more information, see Use API operations to manage the new version of quota alerts.

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:CreateQuotaAlarm

create

*QuotaAlarm

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

None None

Request parameters

Parameter

Type

Required

Description

Example

ProductCode

string

Yes

The abbreviation of the Alibaba Cloud service name.

Note

For more information about how to obtain the abbreviation of an Alibaba Cloud service name, see the ProductCode parameter in ListProductQuotas.

config

QuotaActionCode

string

Yes

The quota ID.

Note

For more information about how to obtain the quota ID of an Alibaba Cloud service, see the QuotaActionCode parameter in ListProductQuotas.

q_hvnoqv

AlarmName

string

Yes

The name of the quota alert.

q_hvnoqv alarm

ThresholdType

string

No

The type of the quota alert. Valid values:

  • used (default): an alert for the used quota.

  • usable: an alert for the available quota.

used

Threshold

number

No

The numeric value of the alert threshold. Valid values:

  • If you set ThresholdType to used, an alert is triggered when the used quota is greater than or equal to this value. The threshold must be greater than the current used quota.

  • If you set ThresholdType to usable, an alert is triggered when the available quota is less than or equal to this value. The threshold must be less than the current available quota.

Note

You must specify either this parameter or ThresholdPercent.

150

ThresholdPercent

number

No

The percentage of the alert threshold. Valid values:

  • If you set ThresholdType to used, an alert is triggered when the used quota percentage is greater than or equal to this value. The value must be in the range of (50%, 100%].

  • If you set ThresholdType to usable, an alert is triggered when the available quota percentage is less than or equal to this value. The value must be in the range of (0%, 50%].

Note

You must specify either this parameter or Threshold.

50

WebHook

string

No

The public URL for receiving alert notifications. Quota Center sends HTTP POST requests to this URL.

https://alert.aliyun.com/callback

QuotaDimensions

array<object>

No

The quota dimensions. A quota dimension is an attribute of a quota item. The combination of Dimensions and QuotaActionCode uniquely identifies a quota item.

Note

This parameter is required for some Alibaba Cloud services. To query the dimensions that an Alibaba Cloud service supports, call the ListProductQuotaDimensions operation. The Requisite parameter in the response indicates whether a dimension is required.

object

No

None.

Key

string

No

The key of the quota dimension.

Note

You must specify both Dimensions.N.Key and Dimensions.N.Value. The value of N indicates the number of dimensions that the Alibaba Cloud service supports. To query the supported dimensions, call the ListProductQuotaDimensions operation. The value of N is the length of the returned array.

regionId

Value

string

No

The value of the quota dimension.

Note

You must specify both Dimensions.N.Key and Dimensions.N.Value. The value of N indicates the number of dimensions that the Alibaba Cloud service supports. To query the supported dimensions, call the ListProductQuotaDimensions operation. The value of N is the length of the returned array.

cn-hangzhou

OriginalContext

string

No

Response elements

Element

Type

Description

Example

object

AlarmId

string

The ID of the alert.

18b3be23-b7b0-4d45-91bc-d0c331aa****

RequestId

string

The ID of the request.

BD219E2B-E687-45EE-B5F3-61FB730551B1

Examples

Success response

JSON format

{
  "AlarmId": "18b3be23-b7b0-4d45-91bc-d0c331aa****",
  "RequestId": "BD219E2B-E687-45EE-B5F3-61FB730551B1"
}

Error codes

HTTP status code

Error code

Error message

Description

400 QUOTA.UNSUPPORT.ALARM This quota does not support creating alarm
400 ALARM.NAME.REPEAT The warning name must be unique. The alert name must be unique.
400 QUOTA.ALARM.MAX Quota alarm have reached the upper limit of 100 The maximum number of quota alerts has been reached.
400 UNSUPPORTED.ALARM.TYPE Unified alarm does not support alarm types for used quantity alarms, and does not support numerical threshold types of quota alarms. Unified alarm does not support alarm types for used quantity alarms, and does not support numerical threshold types of quota alarms.
400 THRESHOLD.ILLEGAL The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100]. The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100].
400 QUOTA.OFFLINE The quota has been offline. The quota has been offline.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.