You need to enable JavaScript to run this app.
导航

UpdateRule

最近更新时间2024.02.05 14:17:01

首次发布时间2022.10.10 15:05:58

调用UpdateRule接口更新告警策略。

Request URL

POST https://open.volcengineapi.com?Action=UpdateRule&Version=2018-01-01

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

请求参数

参数

类型

是否必填

示例值

描述

Id

Integer

1572416252557******

要修改的告警策略ID。

RuleName

String

testabc

告警策略名称。

Description

String

测试告警

策略描述。

RuleType

String

static

告警策略的类型。
当前仅支持static

Namespace

String

VCM_ECS

此策略的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace

SubNamespace

String

Instance

此策略引用的指标所属的维度。参见云产品监控指标下各产品的SubNamespace

Level

String

critical

告警级别。

  • critical:严重
  • warning:警告
  • notice:通知

Conditions

Array

-

告警条件。 是一个数组,里面可填多个指标判断式,最多10个。元素内容,请参见Conditions请求参数

OriginalDimensions

Map

-

策略检测的资源ID。 是Map结构,元素内容请参见OriginalDimensions请求参数

EvaluationCount

Integer

5

连续几次检测达到阈值才告警。

EffectStartAt

String

00:00

策略生效窗口的开始时间。表达方式为HH:MM。

EffectEndAt

String

23:59

策略生效窗口的截止时间。表达方式为HH:MM。

EnableState

String

enable

开启状态。

  • enable:开启
  • disable:停用

Regions

Array

["cn-beijing"]

生效的RegionId列表。目前只能填一个RegionId。

SilenceTime

Integer

5

告警发送周期。单位为分钟。支持配置为5、30、60、180、360、720、1440。

WebHook

String

http://alert.volc.com/callback

告警发生时回调的地址。限制条件,请参见告警回调使用说明

MultipleConditions

Bool

false

告警策略是否用多指标。

  • true:多指标
  • false:单指标(默认)

ConditionOperator

String

&&

多指标判定条件。

  • &&:多个指标同时成立才判定为触发告警
  • ||:任意指标满足条件触发判定为告警

RecoveryNotify

String

-

告警恢复通知。
详情请参见RecoveryNotify请求参数

注意

邮件、电话、短信、告警回调(飞书、钉钉、企业微信)有告警恢复通知,其他API告警回调无告警恢复通知。

Conditions请求参数

参数

类型

是否必填

示例值

描述

MetricName

String

Instance_CpuBusy

监控指标的名称。参见云产品监控指标下各产品的MetricName

Statistics

String

avg

统计方法,目前支持avgmaxmin
统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是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

此指标的判断阈值。

MetricUnit

String

Percent

监控指标的单位。参见云产品监控指标下各产品的MetricUnit

说明

同环比告警,MetricUnit需要填写为"Percent"。

OriginalDimensions请求参数

参数

类型

是否必填

示例值

描述

Key

String

ResourceID

指标的Dimensions名称。例如:ResourceID、NodeName等。

Value

Array

["i-123oiuoiu23uiow*****","i-123oiuoiu23uiow*****"]

指标的Dimension的值,是一个数组。
如果希望选择"全部"实例的值,可以填星号 "*"。例如:["*"]。

RecoveryNotify请求参数

参数

类型

是否必填

示例值

描述

Enable

Boolean

true

是否开启告警恢复通知。默认自动开启。

返回数据

参数

类型

示例值

描述

Data

Array of String

[]

返回的数据内容,空占位符。

请求示例

POST https://open.volcengineapi.com?Action=UpdateRule&Version=2018-01-01
ServiceName=Volc_Observe
Region=cn-beijing 
AccessKey=xxx 
SecretKey=xxx 

{
    "Id": "1572416252557******",
    "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,
    "WebHook":"http://alert.volc.com/callback",
    "RecoveryNotify": {
        "Enable": true
    }
}

返回示例

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