根据指定条件查询告警策略。

请求说明

云监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListRules&Version=2018-01-01

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListRules	接口名称。当前 API 的名称为 ListRules。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 2018-01-01。
RuleName	String	否	alarm_rule_demo	告警策略名称，系统会根据此名称进行模糊匹配。长度限制在 1～128 字符之间。不能以数字、中划线-开头。
RuleIds	Array of String	否	['189436315***']	告警策略 ID，数组形式。多个值之间使用英文半角逗号,分割。当 ID 不为空时，优先按 ID 查询。
AlertState	Array of String	否	["normal"]	告警策略状态。 alerting：告警中 normal：正常说明支持多选，多个参数之间用半角逗号,间隔，例如：["normal","alerting"]。
Namespace	Array of String	否	["VCM_ECS"]	监控指标所属的云产品。详情请参见云产品监控指标下各产品的 Namespace。说明支持多选。多个参数之间用半角逗号（,）间隔，例如：["VCM_ECS","VCM_VKE"]。
Level	Array of String	否	["critical"]	告警策略级别。 critical：严重 warning：警告 notice：通知说明支持多选。多个参数之间用半角逗号,间隔，例如：["critical","warning"]。
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：通过资源名称、项目和标签选择。
Dimensions	Array of JSON Map	否	-	使用云服务的 Dimensions 字段筛选告警策略。注意使用该字段筛选告警策略时，Namespace参数必填，否则请求报错。各维度检索数量不超过 30 个。
NotificationId	String	否	18946***	告警通知策略 ID。
ProjectName	String	否	project_1	告警策略所属项目名称。未填写时，默认属于 default 项目。更多项目介绍，请参见项目管理。
TagFilters	Array of ListTagFilter	否	-	使用 Tag 筛选告警策略。
AlertTemplateIds	Array of String	否	['1963447872315***']	告警模版 ID，支持基于告警模板 ID 列表查询。
ObjectGroupIds	Array of String	否	['196349165826***']	对象分组 ID，支持基于对象分组 ID 列表查询。

Dimensions

参数	类型	是否必选	示例值	描述
key	String	是	ResourceID	云服务支持的 Dimensions 字段。例如ResourceID、NodeName等。不同云产品支持的 Dimensions 不同，详情请参见云监控监控指标。
value	String	是	i-ydq828***	云服务 Dimensions 字段对应的值。例如对于云服务器，当 key 为 ResourceID 时，value 为云服务器实例 ID。

ListTagFilter

参数	类型	是否必选	示例值	描述
Key	String	否	doc	标签键。
Values	Array of String	否	demo	标签值。

请求示例

返回参数

参数	类型	示例值	描述
Data	Array of RuleVO	-	告警策略详情。
TotalCount	Integer	2	符合条件的告警策略数量。

RuleVO

参数	类型	示例值	描述
Id	String	1502121719593******	告警策略 ID。
RuleName	String	alarm_rule_demo	告警策略名称。
Description	String	this is a alerm rule demo	告警策略描述信息。
Namespace	String	VCM_VKE	监控指标所属的云产品。详情请参见云产品监控指标下各产品的 Namespace。
SubNamespace	String	Cluster	监控指标所属的维度。详情请参见云产品监控指标下各产品的 SubNamespace。
CreatedAt	String	1659421463	告警策略创建时间，时间戳格式。
UpdatedAt	String	1659529768	告警策略最后更新时间，时间戳格式。
ContactGroupIds	Array of String	["148357472501******"]	告警策略绑定的告警通知组 ID。
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"]	云产品所属可用区 ID。
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 列表。
Tags	Array of ResourceTag	-	告警策略关联的 Tag。
Webhook	String	http://alert.volc.com/callback	告警策略绑定的告警回调 URL 地址。说明使用WebHook、Webhook或webhook均能正常工作。详情请参见官方说明。
ProjectName	String	default	告警策略所属项目。
ObjectGroupId	String	group1	告警策略关联的对象分组。
NotificationId	String	189465***	通知策略 ID。
LevelConditions	Array of LevelCondition	-	告警分级配置。
NotifyTemplates	Array of NotifyTemplateBasic	-	通知模版配置。
AlertTemplateName	String	template	告警策略关联的告警模版名称。
EvaluationInterval	Integer	1	检查周期，用于实现 M 个周期 N 次告警。其中，EvaluationInterval 表示 M，EvaluationCount 表示 N。 EvaluationInterval=CheckInterval*EvaluationCount，若留空不配置，默认使用 EvaluationCount 的值。
DimensionConditions	Object of DimensionConditions	-	Dimension 配置。

RuleCondition

参数	类型	示例值	描述
MetricName	String	Instance_CpuBusy	监控指标的名称。详情请参见云监控指标查询下各产品的 MetricName。
Statistics	String	avg	统计方法，取值： avg：平均值。 max：最大值。 min：最小值。说明统计方法会应用到检测时间段内的数据上。例如，默认每次检测数据的时间跨度是 1 分钟，如果统计方法为 avg，那就是对 1 分钟内的数据取平均值。
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	统计周期。
EvaluationWindow	Integer	1	统计时间窗口，即告警统计数据的周期。

OriginalDimensions

参数	类型	示例值	描述
key	String	ResourceID	指标 Dimensions 名称，例如：ResourceID、NodeName 等。
value	Array 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。
Level	String	notice	无数据告警级别。取值： critical：严重 warning：警告 notice：通知

ResourceTag

参数	类型	示例值	描述
Key	String	doc	标签键。
Value	String	demo	标签值。

LevelCondition

参数	类型	示例值	描述
Level	String	warning	告警通知等级，取值： notice：通知 warning：警告 critical：严重 recovery：恢复
Conditions	Array of RuleCondition	-	告警分级配置。

NotifyTemplateBasic

参数	类型	示例值	描述
Channel	String	email	通知渠道，取值： email：邮箱 sms：短信 phone：电话 lark：飞书 dingtalk：钉钉 wecom：企业微信 slack：Slack api：回调地址
NotifyTemplateId	String	189828***00	通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。

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：部分资源。

ProjectCondition

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

KVComparator

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

参数	类型	示例值	描述
Key	String	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：不等于

返回示例

错误码

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