创建告警策略。 ## 请求说明 * 请求方式：POST * 请求地址：https://cloudmonitor.cn\-beijing.volcengineapi.com?Action=CreateRule&Version=2018\-01\-01 ## 调试 ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |CreateRule |接口名称。当前 API 的名称为 `CreateRule`。 | |Version |String |是 |2018\-01\-01 |接口版本。当前 API 的版本为 `2018-01-01`。 | |RuleName |String |是 |alarm_rule_demo |告警策略名称。|\ | | | | ||\ | | | | |* 长度限制在 1～128 字符之间。|\ | | | | |* 不能以数字、中划线`-`开头。 | |Description |String |否 |this is a alerm rule demo |告警策略描述信息。|\ | | | | ||\ | | | | |* 不能以数字、中划线、中文符号开头。|\ | | | | |* 只能包含中文，字母，数字，下划线`_`，中划线`-`、中文符号。|\ | | | | |* 长度限制在 0～255 字符之间。 | |RuleType |String |是 |static |告警策略的类型。|\ | | | | ||\ | | | | |* **static**：手动选择。|\ | | | | |* **dynamic**：通过资源名称、项目和标签选择。 | |Namespace |String |是 |VCM_ECS |此策略的监控指标所属的云产品。详情请参见 [云产品监控指标](/docs/6408/1115078) 下各产品的 **Namespace**。 | |SubNamespace |String |是 |Instance |此策略引用的指标所属的维度。详情请参见 [云产品监控指标](/docs/6408/1115078) 下各产品的 **SubNamespace**。 | |OriginalDimensions |JSON Map |是 |\- |告警资源。 | |Level |String |是 |warning |告警级别。|\ | | | | ||\ | | | | |* **critical**：严重|\ | | | | |* **warning**：警告|\ | | | | |* **notice**：通知 | |EvaluationCount |Integer |是 |5 |触发告警需要持续的周期。单位为分钟。支持配置为 1、3、5、10、15、30、60、120。 | |EnableState |String |是 |enable |开启状态。|\ | | | | ||\ | | | | |* **enable**：开启|\ | | | | |* **disable**：停用 | |Regions |Array of String |是 |["cn\-beijing,cn\-shanghai"] |云产品所属可用区 ID。|\ | | | | ||\ | | | | |* 当`RuleType`为`static`时，只支持配置 1 个 Region ID。|\ | | | | |* 当`RuleType`为`dynamic`时，支持配置多个 Region ID。多个 Region ID 之间使用英文半角逗号`,`隔开。|\ | | | | ||\ | | | | |:::tip|\ | | | | |配置为`ALL`时，表示选择云产品全部可用区。|\ | | | | ||\ | | | | |:::| |MultipleConditions |Boolean |否 |true |告警策略是否用多指标。|\ | | | | ||\ | | | | |* **true**：多指标|\ | | | | |* **false**：单指标（默认） | |NoData |Object of [NoData](#nodata) |否 |\- |无数据告警。 | |DimensionConditions |Object of [DimensionConditions](#dimensionconditions) |否 |\- |Dimension 配置。仅当`RuleType`配置为`dynamic`时有效，支持 project、tag、meta 三种匹配方式。 | |LevelConditions |Array of [LevelCondition](#levelcondition) |否 |\- |告警分级。 | |Conditions |Array of [RuleCondition](#rulecondition) |是 |\- |告警条件。数组形式，支持填写多个指标判断语句，最多 10 个。 | |ConditionOperator |String |否 |&& |多指标判定条件。|\ | | | | ||\ | | | | |* **&&** ：多个指标同时成立才判定为触发告警|\ | | | | |* **\|\|** ：任意指标满足条件就判定为触发告警 | |SilenceTime |Integer |是 |5 |告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。 | |NotifyMode |String |否 |rule |告警发送聚合策略。|\ | | | | ||\ | | | | |* **rule**：（默认）基于规则进行告警聚合。|\ | | | | |* **Resource**：基于规则和资源进行告警聚合。 | |RecoveryNotify |Object of [RecoveryNotify](#recoverynotify) |否 |\- |告警恢复通知。 | |ProjectName |String |否 |default |告警策略所属项目名称。未填写时，默认属于 default 项目。更多项目介绍，请参见 [项目管理](https://www.volcengine.com/docs/6649/94336)。 | |Tags |Array of [ResourceTag](#resourcetag) |否 |\- |告警策略绑定 Tag。 | |NotificationId |String |否 |1 |通知策略 ID。|\ | | | | |可以调用 [ListNotifications](https://www.volcengine.com/docs/6408/1527081) 接口，获取通知策略 ID。|\ | | | | |:::warning|\ | | | | |该参数的优先级比`AlertMethods`更高，因此，当使用该参数指定告警通知策略 ID 时，其他告警通知的配置（`AlertMethods`、`ContactGroupIds`、`WebhookIds`，`EffectStartAt`、`EffectEndAt`等）将失效。|\ | | | | ||\ | | | | |:::| |AlertMethods |Array of String |是 |Phone |告警通知方式。|\ | | | | ||\ | | | | |* **Email**：邮件|\ | | | | |* **Phone**：电话|\ | | | | |* **SMS**：短信|\ | | | | |* **Webhook**：告警回调 | |WebhookIds |Array of String |否 |["1"] |当`AlertMethods`配置为`Webhook`时，指定告警 Webhook 回调 ID。|\ | | | | |可以调用 [ListWebhooks](https://www.volcengine.com/docs/6408/1283208) 接口，获取 Webhook 回调 ID。|\ | | | | |:::warning|\ | | | | |`WebhookIds`和`Webhook`参数仅能配置一个，不能同时配置。|\ | | | | ||\ | | | | |:::| |Webhook |String |否 |http://alert.volc.com/callback |当`AlertMethods`配置为`Webhook`时，指定告警 Webhook 告警回调地址。限制条件，请参见 [告警回调使用说明](https://www.volcengine.com/docs/6408/118191) 。|\ | | | | |:::warning|\ | | | | |`WebhookIds`和`Webhook`参数仅能配置一个，不能同时配置。|\ | | | | ||\ | | | | |:::| |ContactGroupIds |Array of String |否 |1 |当`AlertMethods`配置为`Email`、`Phone`或`SMS`时，指定告警联系组 ID。|\ | | | | |可以调用 [ListContactGroups](https://www.volcengine.com/docs/6408/78957) 接口，获取联系组 ID。|\ | | | | |:::tip|\ | | | | |最多配置 5 个联系组。|\ | | | | ||\ | | | | |:::| |EffectStartAt |String |是 |00:00 |告警策略生效的开始时间，格式为`HH:MM`，例如：00:00。 | |EffectEndAt |String |是 |23:59 |告警策略生效的截止时间，格式为`HH:MM`，例如：23:59。|\ | | | | |:::tip|\ | | | | |`EffectEndAt`时间必须晚于`EffectStartAt`时间。|\ | | | | ||\ | | | | |:::| |NotifyTemplates |Array of [NotifyTemplateBasic](#notifytemplatebasic) |否 |\- |通知模版配置。 | ### OriginalDimensions |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |key |String |是 |ResourceID |指标 Dimension 名称，例如`ResourceID`、`NodeName`等。|\ | | | | ||\ | | | | |* 不同云产品的 Dimensions 名称不同，详情请参见 [云监控指标查询](https://console.volcengine.com/cloud_monitor/docs)。|\ | | | | |* `ResourceID`为必填项，且大小写必须与 [云监控指标查询](https://console.volcengine.com/cloud_monitor/docs) 中的一致。|\ | | | | |* 支持同时填写多个 Dimension 名称，并基于多个 Dimension 名称进行分组。举例如下：|\ | | | | | * 当您仅填写`ResourceID`时，系统会按照`ResourceID`进行告警分组。|\ | | | | | * 当您同时填写`ResourceID`和`NodeName`时，系统会首先按照`ResourceID`进行告警分组。然后在每个分组内，再按照`NodeName`进行分组。 | |value |Array of String |是 |["i\-123oiuoiu23uiow\*\*\*\*\*","i\-123oiuoiu23uiow\*\*\*\*\*"] |指标 Dimension 值，数组形式。多个值之间使用英文半角逗号`,`分割。允许使用通配符`*`选择全部实例的值。例如：["\*"] 。 | ### NoData |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Enable |Boolean |否 |true |是否开启无数据告警。取值：|\ | | | | ||\ | | | | |* **true**：开启无数据告警。|\ | | | | |* **false**：（默认）关闭无数据告警。 | |EvaluationCount |Integer |否 |10 |无数据告警触发阈值，如果在配置的阈值周期内检测无数据上报，则会触发无数据告警。|\ | | | | ||\ | | | | |* 当`Enable`配置为`true`时，该字段为必填。|\ | | | | |* 整数形式，取值范围为 3～20。 | |Level |String |否 |notice |无数据告警级别。取值：|\ | | | | ||\ | | | | |* **critical**：严重|\ | | | | |* **warning**：警告|\ | | | | |* **notice**：通知 | ### DimensionConditions |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Type |String |否 |meta |Dimensions 类型。取值：|\ | | | | ||\ | | | | |* **project**：根据项目选择告警对象。|\ | | | | |* **tag**：根据标签选择告警对象。|\ | | | | |* **meta**：根据资源名称选择告警对象。 | |TagCondition |Object of [TagCondition](#tagcondition) |否 |\- |根据标签选择告警对象的条件。当`Type`为`tag`时必填。 | |MetaCondition |Object of [MetaCondition](#metacondition) |否 |\- |根据资源名称选择告警对象的条件。当`Type`为`meta`时必填。 | |ProjectCondition |Object of [ProjectCondition](#projectcondition) |否 |\- |根据项目选择告警对象的条件。当`Type`为`project`时必填。 | ### LevelCondition |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Level |String |否 |warning |告警通知等级，取值：|\ | | | | ||\ | | | | |* **notice**：通知|\ | | | | |* **warning**：警告|\ | | | | |* **critical**：严重|\ | | | | |* **recovery**：恢复 | |Conditions |Array of [RuleCondition](#rulecondition) |否 |\- |告警分级配置。 | ### RuleCondition |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |MetricName |String |否 |Instance_CpuBusy |监控指标的名称。详情请参见 [云监控指标查询](https://console.volcengine.com/cloud_monitor/metricDoc?tabKey=metric) 下各产品的 **MetricName**。 | |Statistics |String |否 |avg |统计方法，取值：|\ | | | | ||\ | | | | |* **avg**：平均值。|\ | | | | |* **max**：最大值。|\ | | | | |* **min**：最小值。|\ | | | | ||\ | | | | |:::tip|\ | | | | |统计方法会应用到检测时间段内的数据上。例如，默认每次检测数据的时间跨度是 1 分钟，如果统计方法为 avg，那就是对 1 分钟内的数据取平均值。|\ | | | | ||\ | | | | |:::| |ComparisonOperator |String |否 |\> |比较符号。支持普通阈值告警： \>、\>=、<、<=、!=、= ，以及以下同环比告警：|\ | | | | ||\ | | | | |* last_period_increase_pct：环比上周期上涨。|\ | | | | |* last_period_decrease_pct：环比上周起下降。|\ | | | | |* last_period_abs_pct：环比上周期上涨或下降。|\ | | | | |* last_day_increase_pct：同比昨天同一时段上涨。|\ | | | | |* last_day_decrease_pct：同比昨天同一时段下降。|\ | | | | |* last_day_abs_pct：同比昨天同一时段上涨或下降。|\ | | | | |* last_week_increase_pct：同比上周同一时段上涨。|\ | | | | |* last_week_decrease_pct：同比上周同一时段下降。|\ | | | | |* last_week_abs_pct：同比上周同一时段上涨或下降。 | |Threshold |String |否 |100 |指标阈值。|\ | | | | ||\ | | | | |* 支持输入正数或 0。|\ | | | | |* 最多支持三位小数。 | |MetricUnit |String |否 |Percent |监控指标的单位。详情请参见 [云监控指标查询](https://console.volcengine.com/cloud_monitor/metricDoc?tabKey=metric) 下各产品的 **MetricUnit**。|\ | | | | |:::tip|\ | | | | ||\ | | | | |* 同环比告警，MetricUnit 需要填写为 "Percent"。|\ | | | | |* MetricUnit 中是否带有 IEC 表示不同的进位：|\ | | | | | * 带有 IEC：进位是 1024|\ | | | | | * 不带 IEC：进位是 1000|\ | | | | ||\ | | | | |:::| ### RecoveryNotify |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Enable |Boolean |否 |true |是否开启告警恢复通知。取值：|\ | | | | ||\ | | | | |* **true**：（默认）开启告警恢复通知。|\ | | | | |* **false**：关闭告警恢复通知。 | ### ResourceTag |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Key |String |否 |doc |标签键。|\ | | | | ||\ | | | | |* 支持中文、英文大写字母、英文小写字母、数字和空格。|\ | | | | |* 支持以下特殊字符`_.:/=+-@`。|\ | | | | |* 不能以空格为开头或结尾。|\ | | | | |* `volc:`和`/sys:`为系统预留的标签键，添加标签时，标签键的开头不能设置为任何大小写形式的`volc:`和`/sys:`。|\ | | | | |* 标签键的长度需为 1～128 个字符。 | |Value |String |否 |demo |标签值。|\ | | | | ||\ | | | | |* 支持中文、英文大写字母、英文小写字母、数字和空格。|\ | | | | |* 支持以下特殊字符`_.:/=+-@`。|\ | | | | |* 不能以空格为开头或结尾。|\ | | | | |* 标签键的长度需为 0～255 个字符。 | ### NotifyTemplateBasic |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Channel |String |否 |email |通知渠道，取值：|\ | | | | ||\ | | | | |* **email**：邮箱|\ | | | | |* **sms**：短信|\ | | | | |* **phone**：电话|\ | | | | |* **lark**：飞书|\ | | | | |* **dingtalk**：钉钉|\ | | | | |* **wecom**：企业微信|\ | | | | |* **slack**：Slack|\ | | | | |* **api**：回调地址 | |NotifyTemplateId |String |否 |189828\*\*\*00 |通知模版 ID。|\ | | | | |:::warning|\ | | | | |每种通知渠道仅支持配置 1 个通知模版 ID。|\ | | | | ||\ | | | | |:::| ### TagCondition |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Tags |Array of [KVComparator](#kvcomparator) |否 |\- |标签列表。|\ | | | | ||\ | | | | |* 最多支持配置 10 个标签列表。|\ | | | | |* 标签值不能超过 50 个字符。 | |Condition |String |否 |and |判断条件。|\ | | | | ||\ | | | | |* **and**：全部满足。|\ | | | | |* **or**：任意满足。 | ### MetaCondition |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Metas |Array of [MetaKVComparator](#metakvcomparator) |否 |\- |资源列表。|\ | | | | ||\ | | | | |* 最多支持配置 10 个资源名称列表。|\ | | | | |* 当`Comparator`为`equal`或`not_equal`时，输入的资源名称字符长度没有限制。|\ | | | | |* 当`Comparator`为`contain`、`not_contain`、`prefix_match`或`suffix_match`时，输入的资源名称不能超过 100 个字符。 | |Condition |String |否 |or |判断条件。|\ | | | | ||\ | | | | |* **and**：全部满足。|\ | | | | |* **or**：任意满足。 | |AllDimensions |Boolean |否 |true |是否为全量资源。|\ | | | | ||\ | | | | |* **true**：全部资源。|\ | | | | |* **false**：部分资源。 | ### ProjectCondition |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Projects |Array of String |否 |["testDefault1", "testDefault2"] |项目名称列表。数组形式。多个值之间使用英文半角逗号`,`分割。 | ### KVComparator |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Key |String |否 |testKey |标签的键（Key）。 | |Values |Array of String |否 |["testValues", "testValues2"] |标签的值（Value）。|\ | | | | ||\ | | | | |* 当`Comparator`为`exist`时，包含 Key 对应的所有 Value，不支持输入。|\ | | | | |* 当`Comparator`为`equal`或`not_equal`时，支持输入多个 Value。|\ | | | | |* 当`Comparator`为`contain`、`not_contain`、`prefix_match`或`suffix_match`时，仅支持输入 1 个 Value。 | |Comparator |String |否 |equal |标签匹配时的比较符。|\ | | | | ||\ | | | | |* **contain**：包含|\ | | | | |* **not_contain**：不包含|\ | | | | |* **prefix_match**：前缀匹配|\ | | | | |* **suffix_match**：后缀匹配|\ | | | | |* **equal**：等于|\ | | | | |* **not_equal**：不等于|\ | | | | |* **exist**：存在 | ### MetaKVComparator |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Key |String |否 |ResourceName |资源名称。目前仅支持配置为`ResourceName`。 | |Values |Array of String |否 |["testResource1", "testResource2"] |资源的 Values。|\ | | | | ||\ | | | | |* 当`Comparator`为`equal`或`not_equal`时，支持配置多个 Value。|\ | | | | |* 当`Comparator`配置为`contain`、`not_contain`、`prefix_match`或`suffix_match`时，仅支持配置 1 个 Value。 | |Comparator |String |否 |equal |资源匹配时的比较符。|\ | | | | ||\ | | | | |* **contain**：包含|\ | | | | |* **not_contain**：不包含|\ | | | | |* **prefix_match**：前缀匹配|\ | | | | |* **suffix_match**：后缀匹配|\ | | | | |* **equal**：等于|\ | | | | |* **not_equal**：不等于 | ## 请求示例 ```json POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=CreateRule&Version=2018-01-01 Content-Type: application/json { "RuleName": "alarm_rule_demo", "RuleType": "static", "SilenceTime": 5, "SubNamespace": "Instance", "Webhook": "http://alert.volc.com/callback", "AlertMethods": [ "Email" ], "ConditionOperator": "&&", "Conditions": [ { "Threshold": "100", "MetricName": "Instance_CpuBusy", "MetricUnit": "Percent", "Statistics": "avg", "ComparisonOperator": ">" } ], "ContactGroupIds": [ "" ], "Description": "this is a alerm rule demo", "DimensionConditions": { "Type": "meta", "TagCondition": { "Tags": [ { "Key": "testKey", "Values": [ "testValues", "testValues2" ], "Comparator": "equal" } ], "Condition": "and" }, "MetaCondition": { "Metas": [ { "Key": "ResourceName", "TagKey": "test", "Values": [ "testResource1", "testResource2" ], "Comparator": "equal" } ], "Condition": "or", "AllDimensions": true }, "ProjectCondition": { "Projects": [ "testDefault1", "testDefault2" ] } }, "EffectEndAt": "23:59", "EffectStartAt": "00:00", "EnableState": "enable", "EvaluationCount": 5, "Level": "warning", "NotifyTemplates": [ "Channel": "email", "NotifyTemplateId": "189828***00" ], "LevelConditions": [ { "Level": "warning", "Conditions": [ { "Threshold": "100", "MetricName": "Instance_CpuBusy", "MetricUnit": "Percent", "Statistics": "avg", "ComparisonOperator": ">" } ] } ], "MultipleConditions": true, "Namespace": "VCM_ECS", "NoData": { "Level": "", "Enable": true, "EvaluationCount": 10 }, "NotifyMode": "rule", "OriginalDimensions": {}, "ProjectName": "", "RecoveryNotify": { "Enable": true }, "Regions": [ "cn-beijing,cn-shanghai" ], "Tags": [ { "Key": "doc", "Value": "demo" } ] } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Data |Array of String |["1354766247190\*\*\*\*\*\*"] |告警策略 ID。 | ## 返回示例 ```json { "ResponseMetadata": { "Action": "CreateRule", "Region": "cn-beijing", "Service": "cloudmonitor", "Version": "2018-01-01", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Data": [ "1354766247190******" ] } } ``` ## 错误码本接口无特有的错误码。更多信息请参见 [错误码](https://www.volcengine.com/docs/6408/78947)。