调用CreateQuotaAlarm创建配额用量告警_配额中心(Quota Center)-阿里云帮助中心

创建配额告警。

接口说明

配额告警功能已升级，本 API 即将废弃，请您使用云监控 API PutResourceMetricRules 、 PutMetricRuleTargets 对新版配额告警规则进行创建。使用 API 对新版配额告警进行操作的更多信息，请参见使用 API 管理新版配额告警。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quotas:CreateQuotaAlarm

create

*QuotaAlarm

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

无

请求参数

名称	类型	必填	描述	示例值
ProductCode	string	是	云产品的缩写名称。说明关于如何获取云产品的缩写名称，请参见 ListProductQuotas 中的`ProductCode`。	config
QuotaActionCode	string	是	配额 ID。说明关于如何获取云产品的配额 ID，请参见 ListProductQuotas 中的`QuotaActionCode`。	q_hvnoqv
AlarmName	string	是	配额告警名称。	q_hvnoqv alarm
ThresholdType	string	否	配额告警类型。取值： used（默认值）：已使用量告警。 usable：剩余可用量告警。	used
Threshold	number	否	配额告警阈值的数值。取值：当`ThresholdType`选择`used`时，如果配额的已使用量大于等于预设数值，您会收到告警通知。配额告警阈值必须大于配额的已使用量。当`ThresholdType`选择`usable`时，如果配额的剩余可用量小于等于预设数值，您会收到告警通知。配额告警阈值必须小于配额的剩余可用量。说明该参数与 ThresholdPercent 必须设置一个。	150
ThresholdPercent	number	否	配额告警阈值的百分比。取值：当`ThresholdType`选择`used`时，如果配额的已使用量大于等于预设百分比，您会收到告警通知。取值范围：（50%, 100%]。当`ThresholdType`选择`usable`时，如果配额的剩余可用量小于等于预设百分比，您会收到告警通知。取值范围：（0%, 50%]。说明该参数与 Threshold 必须设置一个。	50
WebHook	string	否	配额中心将告警信息通过 HTTP 协议的 POST 请求发送到指定公网的 URL 地址。	https://alert.aliyun.com/callback
QuotaDimensions	array<object>	否	配额维度。配额项的属性，维度`Dimensions`+配额 ID`QuotaActionCode`确定唯一的配额项。说明部分云产品维度必填，可以通过 ListProductQuotaDimensions 查询云产品支持的配额维度，返回参数`Requisite`表示该维度是否必填。
	object	否	无。
Key	string	否	配额维度的 Key。说明 `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N 的取值范围取决于对应云产品支持的维度个数，可通过 ListProductQuotaDimensions 查询云产品支持的配额维度，返回数组长度就是 N。	regionId
Value	string	否	配额维度的 Value。说明 `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N 的取值范围取决于对应云产品支持的维度个数，可通过 ListProductQuotaDimensions 查询云产品支持的配额维度，返回数组长度就是 N。	cn-hangzhou
OriginalContext	string	否

返回参数

名称	类型	描述	示例值
	object
AlarmId	string	告警 ID。	18b3be23-b7b0-4d45-91bc-d0c331aa****
RequestId	string	请求 ID。	BD219E2B-E687-45EE-B5F3-61FB730551B1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	QUOTA.UNSUPPORT.ALARM	This quota does not support creating alarm
400	ALARM.NAME.REPEAT	The warning name must be unique.	预警名称不可重复。
400	QUOTA.ALARM.MAX	Quota alarm have reached the upper limit of 100	已达配额预警数上限。
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.	统一告警不支持告警类型为已使用量告警，并且不支持配额告警阈值类型为数值
400	THRESHOLD.ILLEGAL	The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100].	ThresholdPercent和Threshold不能同时为空或者ThresholdPercent需要在 (0,100]的范围内。
400	QUOTA.OFFLINE	The quota has been offline.	该配额已下市。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。