ListRules--云监控-火山引擎

文档中心

导航

ListRules

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

根据指定条件查询告警策略，请求参数中的条件是且的关系。

请求说明

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

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
RuleName	String	否	`test`	查询指定的告警策略名称，会根据此告警名称做模糊匹配。长度限制在1~128字符之间不能以数字、中划线开头
AlertState	Array of String	否	`["normal"]`	查询指定告警状态的告警策略，可以多选。多个参数之间用半角逗号（,）间隔，例如：["normal","alerting"]。 alerting：告警中 normal：正常
Namespace	Array of String	否	`["VCM_ECS"]`	此策略的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace。可以多选。多个参数之间用半角逗号（,）间隔，例如：["VCM_ECS","VCM_VKE"]。
Level	Array of String	否	`["critical"]`	查询指定级别的告警策略，可以多选。多个参数之间用半角逗号（,）间隔，例如：["critical","warning"]。 critical：严重 warning：警告 notice：通知
EnableState	Array of String	否	`["enable"]`	查询指定状态的告警策略，可以多选。多个参数之间用半角逗号（,）间隔，例如：["enable","disable"]。 enable：开启 disable：停用
PageSize	Integer	否	`30`	分页查询参数，用于设置每页行数。默认值：30。
PageNumber	Integer	否	`1`	分页查询参数，用于设置当前页码。默认值：1。实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize
RuleType	String	否	`static`	告警策略的类型。 static：手动选择。 dynamic：通过资源名称、项目和标签选择。

返回参数

参数	类型	示例值	描述
Data	Array of RuleVO	`-`	内容为数组，数组元素为告警策略内容。
PageSize	Integer	`30`	分页查询参数，用于设置每页行数。默认值：30。
PageNumber	Integer	`1`	分页查询参数，用于设置当前页码。默认值：1。
TotalCount	Integer	`2`	符合条件的告警策略数量。

RuleVO

参数	类型	示例值	描述
Id	String	`1502121719593******`	告警策略ID。
RuleName	String	`vketest`	告警策略名称。
Description	String	`测试告警`	策略描述。
Namespace	String	`VCM_VKE`	此策略的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace。
SubNamespace	String	`Cluster`	此策略引用的指标所属的维度。参见云产品监控指标下各产品的SubNamespace。
CreatedAt	String	`1659421463`	告警策略创建时间。表达方式为时间戳。
UpdatedAt	String	`1659529768`	告警策略最后更新时间。表达方式为时间戳。
ContactGroupIds	Array of String	`["148357472501******"]`	告警策略绑定的告警通知组ID。最多选择5个联系组。当AlertMethods参数为Email，Phone，SMS时，ContactGroupIds参数不能为空。
AlertMethods	Array of String	`["Email"]`	告警策略的通知方式。 Email：邮件 Phone：电话 SMS：短信 Webhook：告警回调
WebHook	String	`http://alert.volc.com/callback`	绑定的告警回调URL地址。
AlertState	String	`normal`	告警状态。 alerting：告警中 normal：正常
Level	String	`critical`	告警级别。 critical：严重 warning：警告 notice：通知
Conditions	Array of RuleCondition	`-`	告警条件。是一个数组，里面可填多个指标判断式，最多10个。
OriginalDimensions	JSON Map	`-`	策略检测的资源ID。
EffectStartAt	String	`00:00`	策略生效窗口的开始时间。表达方式为HH:MM。
EffectEndAt	String	`23:59`	策略生效窗口的截止时间。表达方式为HH:MM。
EnableState	String	`enable`	开启状态。 enable：开启 disable：停用
Regions	Array of String	`["cn-beijing,cn-shanghai"]`	当前云产品的所属可用区。当RuleType为static时，只支持选择一个region。当RuleType为dynamic时，支持选择多个region。
EvaluationCount	Integer	`5`	触发告警需要持续的周期。单位为分钟。
SilenceTime	Integer	`5`	告警发送周期。单位为分钟。支持配置为5、30、60、180、360、720、1440。
MultipleConditions	Boolean	`false`	告警策略是否用多指标。 true：多指标 false：单指标（默认）
ConditionOperator	String	`&&`	多指标判定条件。 &&：多个指标同时成立才判定为触发告警 \|\|：任意指标满足条件触发判定为告警
RecoveryNotify	Object of RecoveryNotify	`-`	告警恢复通知。
NotifyMode	String	`rule`	告警发送聚合策略。 rule（默认）：规则 resource：规则和资源
NoData	Object of NoData	`-`	无数据告警。
WebhookIds	Array of String	`-`	告警发生时告警回调ID列表。
RuleType	String	`static`	告警策略的类型。 static：手动选择。 dynamic：通过资源名称、项目和标签选择。
ObjectGroupId	String	`group1`	关联的对象分组。
AlertTemplateName	String	`template`	关联的告警模版名称。
DimensionConditions	Object of DimensionConditions	`-`	dimension配置。

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
Period	String	`60`	统计周期。

OriginalDimensions

参数	类型	示例值	描述
key	String	`ResourceID`	指标的Dimensions名称，例如：ResourceID、NodeName等。
value	Array of String	`["i-ybw74rtkvd9z6f****", "i-ybvwojvnep9z6g****"]`	指标的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：不等于

请求示例

POST https://open.volcengineapi.com?Action=ListRules&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "RuleName": "testabc",
    "AlertState": [
        "normal"
    ],
    "Namespace": [
        "VCM_ECS"
    ],
    "Level": [
        "critical",
        "warning"
    ],
    "EnableState": [
        "enable"
    ],
    "PageSize": 30,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209211700000102120522060*******",
        "Action": "ListRules",
        "Version": "2018-01-01",
        "Service": "",
        "Region": ""
    },
    "Result": {
        "Data": [
            {
                "Namespace": "VCM_ECS",
                "ResourceType": "云服务器",
                "SubNamespace": "Instance",
                "Dimension": "实例",
                "Id": "157241625255*******",
                "CreatedAt": "1663728223",
                "UpdatedAt": "1663748593",
                "Regions": [
                    "cn-beijing"
                ],
                "AccountId": "2100******",
                "RuleName": "test",
                "RuleType": "static",
                "Level": "warning",
                "EnableState": "disable",
                "ContactGroupIds": [
                    "1562776379697******"
                ],
                "AlertMethods": [
                    "Webhook",
                    "Email"
                ],
                "WebHook": "",
                "Description": "",
                "CheckInterval": 1,
                "EvaluationCount": 1,
                "SilenceTime": 5,
                "EffectStartAt": "00:00",
                "EffectEndAt": "23:59",
                "Dimensions": [
                    {
                        "ResourceID": "*"
                    }
                ],
                "OriginalDimensions": {
                    "ResourceID": [
                        "*"
                    ]
                },
                "Conditions": [
                    {
                        "MetricName": "Instance_CpuBusy",
                        "MetricUnit": "Percent",
                        "Statistics": "avg",
                        "ComparisonOperator": "<=",
                        "Threshold": "100",
                        "Period": "60"
                    }
                ],
                "TriggerCondition": "多指标告警（任意）：\n带外CPU利用率平均值<=100%， 持续1个周期（1周期=1分钟）\n带外磁盘读带宽平均值<=999MiB/s， 持续1个周期（1周期=1分钟）\n带外磁盘写带宽平均值<=999MiB/s， 持续1个周期（1周期=1分钟）",
                "AlertState": "normal",
                "ConditionOperator": "||",
                "MultipleConditions": true,
                "AlarmTemplateId": "",
                "AlarmTemplateType": ""
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "OrderBy": "",
        "Asc": false
    }
}

错误码

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

云监控

请求说明

Header

调试

请求参数

Query

Body

返回参数

RuleVO

RuleCondition

OriginalDimensions

RecoveryNotify

NoData

DimensionConditions

TagCondition

MetaCondition

ProjectCondition

KVComparator

MetaKVComparator

请求示例

返回示例

错误码