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

接口根据告警策略ID查询告警策略。

请求说明

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

调试

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

请求参数

参数类型是否必选示例值描述
ActionString是ListRulesByIds接口名称。当前 API 的名称为 ListRulesByIds。
VersionString是2018-01-01接口版本。当前 API 的版本为 2018-01-01。
IdsArray of String是["1502121719593******"]告警策略 ID。

请求示例

POST https://open.volcengineapi.com?Action=ListRulesByIds&Version=2018-01-01
Content-Type: application/json
{
    "Ids": [
        "1502121719593******"
    ]
}

返回参数

参数类型示例值描述
DataArray of RuleVO-告警策略详情。

RuleVO

参数类型示例值描述
IdString1502121719593******告警策略 ID。
RuleNameStringalarm_rule_demo告警策略名称。
DescriptionString这是一个告警策略样例告警策略描述信息。
NamespaceStringVCM_VKE监控指标所属的产品空间。参见 云产品监控指标 下各产品的 Namespace。
SubNamespaceStringCluster监控指标所属的维度。参见 云产品监控指标 下各产品的 SubNamespace。
CreatedAtString1659421463告警策略创建时间，时间戳形式。
UpdatedAtString1659529768告警策略最后更新时间，时间戳形式。

ContactGroupIds

Array of String

["148357472501******"]

告警策略绑定的告警通知组 ID。

  • 最多选择 5 个联系组。
  • 当AlertMethods为Email、Phone或SMS时，该参数必填。

AlertMethods

Array of String

["Email"]

告警通知方式。

  • Email：邮件
  • Phone：电话
  • SMS：短信
  • Webhook：告警回调
WebHookStringhttp://alert.volc.com/callback告警回调 URL 地址。

AlertState

String

normal

告警状态。

  • alerting：告警中
  • normal：正常

Level

String

critical

告警级别。

  • critical：严重
  • warning：警告
  • notice：通知
ConditionsArray of RuleCondition-告警条件。数组形式，支持填写多个指标判断语句，最多 10 个。
OriginalDimensionsJSON Map-告警策略检测的资源 ID。
EffectStartAtString00: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 之间使用英文半角逗号,隔开。
EvaluationCountInteger5触发告警需要持续的周期。单位为分钟。
SilenceTimeInteger5告警发送周期。单位为分钟。支持配置为 5、30、60、180、360、720、1440。

MultipleConditions

Boolean

false

告警策略是否用多指标。

  • true：多指标。
  • false：（默认）单指标。

ConditionOperator

String

&&

多指标判定条件。

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

NotifyMode

String

rule

告警发送聚合策略。

  • rule（默认）：基于规则进行告警聚合。
  • Resource：基于规则和资源进行告警聚合。
NoDataObject of NoData-无数据告警。
WebhookIdsArray of String-告警发生时告警回调 ID 列表。

RuleType

String

static

告警对象选择方式。

  • static：手动选择。
  • dynamic：通过资源名称、项目和标签选择。
ObjectGroupIdStringgroup1告警策略关联的对象分组。
AlertTemplateNameStringtemplate告警策略关联的告警模版名称。
DimensionConditionsObject of DimensionConditions-Dimension 配置。
ProjectNameStringdefault告警策略所属项目。

RuleCondition

参数类型示例值描述
MetricNameStringInstance_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

参数类型示例值描述
keyStringResourceID指标 Dimension 名称，例如ResourceID、NodeName等。
valueArray of String["i-ybw74rtkvd9z6f******", "i-ybvwojvnep9z6g******"]指标 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

参数类型示例值描述
KeyStringtestKey标签的键（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

参数类型示例值描述
KeyStringResourceName资源名称。目前仅支持配置为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：不等于
TagKeyStringtest告警分组执行的实际 key，例如在告警屏蔽中，使用该 key 和 alertGroup 里的tag.key进行匹配。

返回示例

{
    "ResponseMetadata": {
        "Action": "ListRulesByIds",
        "Region": "cn-beijing",
        "Service": "Volc_Observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": [
            {
                "Id": "1502121719593******",
                "Level": "critical",
                "NoData": {
                    "Enable": true,
                    "EvaluationCount": 10
                },
                "Regions": [
                    "cn-beijing,cn-shanghai"
                ],
                "WebHook": "http://alert.volc.com/callback",
                "RuleName": "vketest",
                "RuleType": "static",
                "CreatedAt": "1659421463",
                "Namespace": "VCM_VKE",
                "UpdatedAt": "1659529768",
                "AlertState": "normal",
                "Conditions": [
                    {
                        "Threshold": "100",
                        "MetricName": "Instance_CpuBusy",
                        "MetricUnit": "Percent",
                        "Statistics": "avg",
                        "ComparisonOperator": ">"
                    }
                ],
                "NotifyMode": "rule",
                "WebhookIds": [
                    ""
                ],
                "Description": "测试告警",
                "EffectEndAt": "23:59",
                "EnableState": "enable",
                "ProjectName": "default",
                "SilenceTime": 5,
                "AlertMethods": [
                    "Email"
                ],
                "SubNamespace": "Cluster",
                "EffectStartAt": "00:00",
                "ObjectGroupId": "group1",
                "RecoveryNotify": {
                    "Enable": true
                },
                "ContactGroupIds": [
                    "148357472501******"
                ],
                "EvaluationCount": 5,
                "AlertTemplateName": "template",
                "ConditionOperator": "&&",
                "MultipleConditions": true,
                "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"
                        ]
                    }
                }
            }
        ]
    }
}