首页 >配额中心 >API参考 >API目录 >配额告警 >CreateQuotaAlarm - 创建配额用量告警

CreateQuotaAlarm - 创建配额用量告警

调用CreateQuotaAlarm接口创建配额告警。

接口说明

本文将提供一个示例,为config(配置审计)的配额q_hvnoqv(规则创建数量)创建配额告警。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProductCodestring

云服务名称缩写。

说明关于支持配额中心的云服务,请参见支持配额中心的云服务
config
QuotaActionCodestring

配额ID。

q_hvnoqv
AlarmNamestring

配额告警名称。

规则创建数量告警
ThresholdTypestring

配额告警类型。取值:

  • used:已使用量告警。
  • usable:剩余可用量告警。
used
Thresholdnumber

配额告警阈值的数值。取值:

  • ThresholdType选择used时,如果配额的已使用量大于等于预设数值,您会收到告警通知。配额告警阈值必须大于配额的已使用量。

  • ThresholdType选择usable时,如果配额的剩余可用量小于等于预设数值,您会收到告警通知。配额告警阈值必须小于配额的剩余可用量。

说明该参数与ThresholdPercent必须设置一个。
150
ThresholdPercentnumber

配额告警阈值的百分比。取值:

  • ThresholdType选择used时,如果配额的已使用量大于等于预设百分比,您会收到告警通知。取值范围:(50%, 100%]。

  • ThresholdType选择usable时,如果配额的剩余可用量小于等于预设百分比,您会收到告警通知。取值范围:(0%, 50%]。

说明该参数与Threshold必须设置一个。
50
WebHookstring

配额中心将告警信息通过HTTP协议的POST请求发送到指定公网的URL地址。

https://alert.aliyun.com/callback
QuotaDimensionsarray

配额维度列表。

object

无。

Keystring

配额维度的Key。

N的取值范围取决于对应云服务支持的维度个数。

说明当ProductCode为ecs、ecs-spec、actiontrail或ess时,该参数必须设置。
regionId
Valuestring

配额维度的Value。

N的取值范围取决于对应云服务支持的维度个数。

说明当ProductCode为ecs、ecs-spec、actiontrail或ess时,该参数必须设置。
cn-hangzhou

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
AlarmIdstring

告警ID。

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

请求ID。

BD219E2B-E687-45EE-B5F3-61FB730551B1

示例

请求示例

http(s)://[Endpoint]/?Action=CreateQuotaAlarm
&AlarmName=规则创建数量告警
&ProductCode=config
&QuotaActionCode=q_hvnoqv
&Threshold=150
&<公共请求参数>

正常返回示例

JSON格式

{
  "AlarmId": "a2efa7fc-832f-47bb-8054-39e28012****",
  "RequestId": "88BAD9A9-0C47-4139-8531-08CB333F3384"
}

XML格式

<CreateQuotaAlarmResponse>
		<AlarmId>a2efa7fc-832f-47bb-8054-39e28012****</AlarmId>
		<RequestId>88BAD9A9-0C47-4139-8531-08CB333F3384</RequestId>
</CreateQuotaAlarmResponse>

错误码

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

阿里云首页 配额中心 相关技术圈