UpdateQuotaAlarm - Quota Center - Alibaba Cloud Documentation Center

Operation description

This API operation is deprecated because the quota alert feature has been upgraded. To modify information about new quota usage alerts, use the CloudMonitor API operations PutResourceMetricRules and PutMetricRuleTargets. For more information about using API operations to manage new quota alerts, see Use API operations to manage new 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:UpdateQuotaAlarm

update

*QuotaAlarm

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

None

Request parameters

Parameter	Type	Required	Description	Example
AlarmId	string	Yes	The ID of the quota alert. Note For more information about how to obtain the ID of a quota alert, see ListQuotaAlarms.	a2efa7fc-832f-47bb-8054-39e28012****
AlarmName	string	Yes	The name of the quota alert. Note For more information about how to obtain the name of a quota alert, see ListQuotaAlarms.	rules
ThresholdType	string	No	The type of the quota alert. Valid values: used (default): The alert is triggered based on the used quota. usable: The alert is triggered based on the usable quota.	usable
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 alert threshold must be greater than the current used quota. If you set `ThresholdType` to `usable`, an alert is triggered when the usable quota is less than or equal to this value. The alert threshold must be less than the current usable quota. Note You must set either Threshold or ThresholdPercent.	160
ThresholdPercent	number	No	The percentage of the alert threshold. Valid values: If you set `ThresholdType` to `used`, an alert is triggered when the percentage of the used quota 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 percentage of the usable quota is less than or equal to this value. The value must be in the range of (0%, 50%]. Note You must set either Threshold or ThresholdPercent.	51
WebHook	string	No	The webhook URL. Quota Center sends alert notifications to this URL using an HTTP POST request.	https://alert.aliyun.com/callback

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A95C65B3-7CF4-469E-B1D5-1CA0628A6411

Examples

Success response

JSON format

{
  "RequestId": "A95C65B3-7CF4-469E-B1D5-1CA0628A6411"
}

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	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	ALARM.NAME.REPEAT	The warning name must be unique.	The alert name must be unique.
400	ALARM.NOT.FOUND	The AlarmId provided does not exist in our records.	The quota alert does not exist.
400	THRESHOLD.MAx.ILLEGAL	The quota warning threshold cannot be greater than the current quota.	The threshold for triggering quota alerts cannot be greater than the current quota.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.