You need to enable JavaScript to run this app.
导航
配额中心
  • 文档首页
    • /配额中心/API概览/API目录/配额告警API/CreateAlarmRule - 创建配额告警
CreateAlarmRule - 创建配额告警
最近更新时间：2023.01.09 20:09:04首次发布时间：2022.12.27 10:18:24
我的收藏

请求参数

接口参数

参数类型位置是否必填描述
ActionstringQuery是CreateAlarmRule
VersionstringQuery是2022-07-01

业务变量参数

参数类型位置是否必填描述
ProviderCodestringBody是产品提供方
ProductNamestringBody否产品名称
QuotaCodestringBody是配额名称

QuotaType

string

Body

是

配额类型，取值

  • normal：通用配额

  • spec：资源实例配额

DescriptionstringBody否告警策略描述

Dimensions

string

Body

否

配额维度

[
    {
        "Name":"region_code",
        "Value":"cn-north"
    },
    {
        "Name":"charge_type",
        "Value":"PostPaid"
    },
    {
        "Name":"zone_id",
        "Value":"cn-north-a"
    }
]
RuleNamestringBody是告警策略名
StatisticsstringBody否统计方式，默认取值avg：平均值统计

AlarmType

string

Body

是

告警类型，取值：

  • usage：使用量

  • remain：余量

ThresholdstringBody是告警阈值

MetricUnit

string

Body

是

阈值类型，取值：

  • Count：数值

  • Percent：百分比

SilenceTimeintBody否告警静默时间，默认60min，取值15/60/1440min

EnableState

String

Body

否

开启状态，默认开启，取值：

  • enable：开启

  • disable：禁用

请求示例

http://open.volcengineapi.com/?Version=2022-07-01&Action=CreateAlarmRule
&ProviderCode=platformServices
&QuotaCode=quota_alarm
&RuleName=策略名
&Statistics=avg
&AlarmType=usage
&Threshold=35
&MetricUnit=Count
&SilenceTime=60
&ProductName=服务名
&QuotaType=normal
&Descripon=策略描述
&Dimensions=[{"Name":"region_code","Value":"quota-test"}]
&EnableState=enable

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221222112731819ED9E34DA83CBE7676"
    },
    "Result": {
        "RuleID": "1605766959574548480"
    }
}