CreateRule--云监控-火山引擎

文档中心

导航

CreateRule

最近更新时间：2024.11.20 10:17:43首次发布时间：2022.10.10 15:05:58

创建一个告警策略。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateRule&Version=2018-01-01

ServiceName: Volc_Observe
Region: cn-beijing 
AccessKey: xxx
SecretKey: xxx

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateRule`	接口名称。当前 API 的名称为 `CreateRule`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
RuleName	String	是	`rule_1`	告警策略名称。长度限制在1~128字符之间不能以数字、中划线开头
Description	String	否	`simple desc`	策略描述。不能以数字、中划线、中文符号开头只能包含中文，字母，数字，下划线，中划线、中文符号长度限制在0~255字符之间
RuleType	String	是	`static`	告警策略的类型。 static：手动选择。 dynamic：通过资源名称、项目和标签选择。
Namespace	String	是	`VCM_ECS`	此策略的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace。
SubNamespace	String	是	`Instance`	此策略引用的指标所属的维度。参见云产品监控指标下各产品的SubNamespace。
Level	String	是	`warning`	告警级别。 critical：严重 warning：警告 notice：通知
Conditions	Array of RuleCondition	是	`-`	告警条件。是一个数组，里面可填多个指标判断式，最多10个。
OriginalDimensions	JSON Map	是	`-`	告警资源。
EvaluationCount	Integer	是	`5`	触发告警需要持续的周期。单位为分钟。支持配置为1、3、5、10、15、30、60、120。
EffectStartAt	String	是	`00:00`	策略生效窗口的开始时间。表达方式为HH:MM。
EffectEndAt	String	是	`23:59`	策略生效窗口的截止时间。表达方式为HH:MM。 EffectEndAt > EffectStartAt
EnableState	String	是	`enable`	开启状态。 enable：开启 disable：停用
Regions	Array of String	是	`["cn-beijing,cn-shanghai"]`	当前云产品的所属可用区。当RuleType为static时，只支持选择一个region。当RuleType为dynamic时，支持选择多个region。
SilenceTime	Integer	是	`5`	告警发送周期。单位为分钟。支持配置为5、10、15、30、60、180、360、720、1440。
Webhook	String	否	`http://alert.volc.com/callback`	告警发生时回调的地址。限制条件，请参见告警回调使用说明。
WebhookIds	Array of String	否	`["1"]`	告警回调ID列表。WebhookIds和Webhook参数二选一，不能同时填写。
ConditionOperator	String	否	`&&`	多指标判定条件。 &&：多个指标同时成立才判定为触发告警 \|\|：任意指标满足条件就判定为触发告警
RecoveryNotify	Object of RecoveryNotify	否	`-`	告警恢复通知。
AlertMethods	Array of String	是	`Email`	告警策略的通知方式。 Email：邮件 Phone：电话 SMS：短信 Webhook：告警回调
ContactGroupIds	Array of String	否	`1`	告警通知组ID列表。最多选择5个联系组。当AlertMethods参数为Email，Phone，SMS时，ContactGroupIds参数不能为空。
MultipleConditions	Boolean	否	`true`	告警策略是否用多指标。 true：多指标 false：单指标（默认）
NoData	Object of NoData	否	`-`	无数据告警。
NotifyMode	String	否	`rule`	告警发送聚合策略。 rule（默认）：规则 resource：规则和资源
DimensionConditions	Object of DimensionConditions	否	`-`	dimension配置。目前仅在RuleType为dynamic时有效，支持 project、tag、meta三种匹配方式。

RuleCondition

参数	类型	是否必选	示例值	描述
MetricName	String	否	`Instance_CpuBusy`	监控指标的名称。参见云产品监控指标下各产品的MetricName。
Statistics	String	否	`avg`	统计方法。目前支持avg、max、min。统计方法会应用到检测时间段内的数据上。例如，默认每次检测数据的时间跨度是1分钟，如果统计方法为avg，那就是对1分钟内的数据做avg。
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`	监控指标的单位。参见云产品监控指标下各产品的MetricUnit。说明同环比告警，MetricUnit需要填写为"Percent"。 MetricUnit中是否带有IEC表示不同的进位：带有IEC：进位是1024 不带IEC：进位是1000

OriginalDimensions

参数	类型	是否必选	示例值	描述
key	String	是	`ResourceID`	指标的Dimensions名称，例如：ResourceID、NodeName等。
value	Array of String	是	`["i-123oiuoiu23uiow***","i-123oiuoiu23uiow***"]`	指标的Dimension的值，是一个数组。如果希望选择"全部"实例的值，可以填星号 ""。例如：[""] 。

RecoveryNotify

参数	类型	是否必选	示例值	描述
Enable	Boolean	否	`true`	是否开启告警恢复通知。默认自动开启。

NoData

参数类型是否必选示例值描述

Enable Boolean 否 true 是否开启无数据告警。默认关闭。

参数	类型	是否必选	示例值	描述
Enable	Boolean	否	`true`	是否开启无数据告警。默认关闭。
EvaluationCount	Integer	否	`10`	连续几次检测无数据才告警。 Enable配置为true时，EvaluationCount为必填。取值范围为3～20之间的整数。

EvaluationCount

Integer

否

10

连续几次检测无数据才告警。

Enable配置为true时，EvaluationCount为必填。
取值范围为3～20之间的整数。

DimensionConditions

参数	类型	是否必选	示例值	描述
Type	String	否	`meta`	Dimensions类型。 project：根据标签配置告警对象 tag：根据标签配置告警对象 meta：根据资源名称配置告警对象
TagCondition	Object of TagCondition	否	`-`	Type为tag时必填，标签的匹配条件。
MetaCondition	Object of MetaCondition	否	`-`	Type为meta时必填，资源名称的匹配条件。
ProjectCondition	Object of ProjectCondition	否	`-`	Type为project时必填，项目的匹配条件。

TagCondition

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Tags	Array of KVComparator	否	`-`	标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
Condition	String	否	`and`	判断条件。 and：全部满足 or：任意满足

MetaCondition

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Metas	Array of 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：部分资源

Metas

Array of 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。

参数	类型	是否必选	示例值	描述
Key	String	否	`testKey`	标签的key。
Values	Array of String	否	`["testValues", "testValues2"]`	标签的key对应的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：存在

Values

Array of String

否

["testValues", "testValues2"]

标签的key对应的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 资源的Key。目前只能配置为ResourceName。

参数	类型	是否必选	示例值	描述
Key	String	否	`ResourceName`	资源的Key。目前只能配置为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：不等于

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：不等于

返回参数

参数	类型	示例值	描述
Data	Array of String	`["1354766247190******"]`	告警策略ID。

请求示例

POST https://open.volcengineapi.com?Action=CreateRule&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "RuleName": "testabc",
    "RuleType": "static",
    "Namespace": "VCM_ECS",
    "SubNamespace": "Instance",
    "Regions": [
        "cn-beijing"
    ],
    "Conditions": [
        {
            "MetricName": "Instance_CpuBusy",
            "Statistics": "avg",
            "ComparisonOperator": ">",
            "Threshold": "4",
            "MetricUnit": "Percent"
        },
        {
            "MetricName": "MemoryUsedUtilization",
            "Statistics": "avg",
            "ComparisonOperator": ">",
            "Threshold": "3",
            "MetricUnit": "Percent"
        }
    ],
    "EffectStartAt": "00:00",
    "EffectEndAt": "23:59",
    "MultipleConditions": true,
    "Level": "critical",
    "SilenceTime": 5,
    "EnableState": "enable",
    "OriginalDimensions": {
        "ResourceID": [
           "i-123oiuoiu23uiow*****","i-123oiuoiu23uiow*****"
        ]
    },
    "ConditionOperator": "&&",
    "EvaluationCount": 1,
    "NoData": {
        "Enable": true,
        "EvaluationCount": 10
    },
    "NotifyMode": "rule",
    "WebHook":"http://alert.volc.com/callback",
    "RecoveryNotify": {
        "Enable": true
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "",
        "Action": "CreateRule",
        "Version": "2018-01-01",
        "Service": "",
        "Region": ""
    },
    "Result": {
        "Data": [
            "1354766247190******"
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码。

云监控

请求说明

Header

调试

请求参数

Query

Body

RuleCondition

OriginalDimensions

RecoveryNotify

NoData

DimensionConditions

TagCondition

MetaCondition

ProjectCondition

KVComparator

MetaKVComparator

返回参数

请求示例

返回示例

错误码