You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /云监控/API 参考/告警策略/UpdateRule
UpdateRule
最近更新时间：2025.01.08 16:52:57首次发布时间：2022.10.10 15:05:58
我的收藏

更新告警策略。

请求说明

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

调试

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

请求参数

参数类型是否必选示例值描述
ActionString是UpdateRule接口名称。当前 API 的名称为 UpdateRule。
VersionString是2018-01-01接口版本。当前 API 的版本为 2018-01-01。
IdString是1572416252557******告警策略 ID。

RuleName

String

是

alarm_rule_demo

告警策略名称。

  • 长度限制在 1～128 字符之间。
  • 不能以数字、中划线开头。

Description

String

否

这是一个告警规则样例

告警策略描述信息。

  • 不能以数字、中划线、中文符号开头。
  • 只能包含中文，字母，数字，下划线，中划线、中文符号。
  • 长度限制在 0～255 字符之间。

RuleType

String

是

static

告警对象选择方式。

  • static：手动选择。
  • dynamic：通过资源名称、项目和标签选择。
NamespaceString是VCM_ECS监控指标所属的云产品。参见 云产品监控指标 下各产品的 Namespace。
SubNamespaceString是Instance监控指标所属的维度。参见 云产品监控指标 下各产品的 SubNamespace。

Level

String

是

critical

告警级别。

  • critical：严重
  • warning：警告
  • notice：通知
ConditionsArray of RuleCondition是-告警条件。数组形式，支持填写多个指标判断语句，最多 10 个。
OriginalDimensionsJSON Map是-告警策略检测的资源 ID。
EvaluationCountInteger是5触发告警需要持续的周期。单位为分钟。支持配置为 1、3、5、10、15、30、60、120。
EffectStartAtString是00:00告警策略生效的开始时间，格式为HH:MM，例如：00:00。

EffectEndAt

String

是

23:59

告警策略生效的截止时间，格式为HH:MM，例如：23:59。

说明

EffectEndAt时间必须晚于EffectStartAt时间。

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 之间使用英文半角逗号,隔开。
SilenceTimeInteger是5告警发送周期。单位为分钟。支持配置为 5、30、60、180、360、720、1440。

Webhook

String

否

http://alert.volc.com/callback

告警回调地址。限制条件，请参见 告警回调使用说明。
WebhookIds和Webhook参数仅能配置一个，不能同时填写。

WebhookIdsArray of String否["1"]告警回调 ID 列表。WebhookIds和Webhook参数仅能配置一个，不能同时填写。

ConditionOperator

String

否

&&

多指标判定条件。

  • &&：多个指标同时成立才判定为触发告警。
  • ||：任意指标满足条件触发判定为告警。
RecoveryNotifyObject of RecoveryNotify否-告警恢复通知。

AlertMethods

Array of String

是

Phone

告警通知方式。

  • Email：邮件
  • Phone：电话
  • SMS：短信
  • Webhook：告警回调

ContactGroupIds

Array of String

否

1

告警通知组 ID 列表。

  • 最多配置 5 个联系组。
  • 当AlertMethods参数配置为Email、Phone或SMS时，该参数不能为空。

MultipleConditions

Boolean

否

false

告警策略是否用多指标。

  • true：多指标
  • false：（默认）单指标
NoDataObject of NoData否-无数据告警。
DimensionConditionsObject of DimensionConditions否-Dimension 配置。仅当RuleType配置为dynamic时有效，支持 project、tag、meta 三种匹配方式。

NotifyMode

String

否

rule

告警发送聚合策略。

  • rule：（默认）基于规则进行告警聚合。
  • Resource：基于规则和资源进行告警聚合。
ProjectNameString否default告警策略所属项目名称。未填写时，默认属于 default 项目。更多项目介绍，请参见 项目管理。

RuleCondition

参数类型是否必选示例值描述
MetricNameString否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

指标 Dimension 名称，例如ResourceID、NodeName等。

  • 不同云产品的 Dimensions 名称不同，详情请参见 云监控指标查询。
  • ResourceID为必填项，且大小写必须与 云监控指标查询 中的一致。
  • 支持同时填写多个 Dimension 名称，并基于多个 Dimension 名称进行分组。举例如下：
    • 当您仅填写ResourceID时，系统会按照ResourceID进行告警分组。
    • 当您同时填写ResourceID和NodeName时，系统会首先按照ResourceID进行告警分组。然后在每个分组内，再按照NodeName进行分组。
valueArray of String是["i-123oiuoiu23uiow*****","i-123oiuoiu23uiow*****"]指标 Dimension 值，数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符*选择全部实例的值。例如：["*"] 。

RecoveryNotify

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

Enable

Boolean

否

true

是否开启告警恢复通知。取值：

  • true：（默认）开启告警恢复通知。
  • false：关闭告警恢复通知。

NoData

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

Enable

Boolean

否

true

是否开启无数据告警。取值：

  • true：开启无数据告警。
  • false：（默认）关闭无数据告警。

EvaluationCount

Integer

否

10

无数据告警触发阈值，如果在配置的阈值周期内检测无数据上报，则会触发无数据告警。

  • 当Enable配置为true时，该字段为必填。
  • 整数形式，取值范围为 3～20。

DimensionConditions

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

Type

String

否

meta

Dimensions 类型。取值：

  • project：根据项目选择告警对象。
  • tag：根据标签选择告警对象。
  • meta：根据资源名称选择告警对象。
TagConditionObject of TagCondition否-根据标签选择告警对象的条件。当Type为tag时必填。
MetaConditionObject of MetaCondition否-根据资源名称选择告警对象的条件。当Type为meta时必填。
ProjectConditionObject 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：部分资源。

ProjectCondition

参数类型是否必选示例值描述
ProjectsArray of String否["testDefault1", "testDefault2"]项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。

KVComparator

参数类型是否必选示例值描述
KeyString否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

参数类型是否必选示例值描述
KeyString否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：不等于
TagKeyString否test告警分组执行的实际 key，例如在告警屏蔽中，使用该 key 和 alertGroup 里的tag.key进行匹配。

请求示例

POST https://open.volcengineapi.com?Action=UpdateRule&Version=2018-01-01
Content-Type: application/json
{
    "RuleName": "alarm_rule_demo",
    "RuleType": "static",
    "SilenceTime": 5,
    "SubNamespace": "Instance",
    "Webhook": "http://alert.volc.com/callback",
    "WebhookIds": [
        "1"
    ],
    "AlertMethods": [
        ""
    ],
    "ConditionOperator": "&&",
    "Conditions": [
        {
            "Threshold": "100",
            "MetricName": "Instance_CpuBusy",
            "MetricUnit": "Percent",
            "Statistics": "avg",
            "ComparisonOperator": ">"
        }
    ],
    "ContactGroupIds": [
        ""
    ],
    "Description": "这是一个告警规则样例",
    "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,
    "Id": "1572416252557******",
    "Level": "critical",
    "MultipleConditions": true,
    "Namespace": "VCM_ECS",
    "NoData": {
        "Enable": true,
        "EvaluationCount": 10
    },
    "NotifyMode": "rule",
    "OriginalDimensions": {},
    "ProjectName": "default",
    "RecoveryNotify": {
        "Enable": true
    },
    "Regions": [
        "cn-beijing,cn-shanghai"
    ]
}

返回参数

参数类型示例值描述
DataArray of String[]返回的数据内容，空占位符。

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateRule",
        "Region": "cn-beijing",
        "Service": "Volc_Observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": [
            ""
        ]
    }
}

错误码

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