本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 告警策略/ 查询告警规则策略列表

查询告警规则策略列表

更新时间：2025-06-12 GMT+08:00

查看PDF

功能介绍

根据告警规则ID查询策略列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/alarms/{alarm_id}/policies

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户ID 正则匹配：^[a-zA-Z0-9-]{1,64}$
alarm_id	是	String	告警规则ID 正则匹配：^al([0-9A-Za-z]){22}$

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	分页偏移量取值范围： 0-10000 默认取值： 0 正则匹配：^([0]\|[1-9]\|[1-9][0-9]\|[1-9][0-9][0-9]\|[1-9][0-9][0-9][0-9]\|10000)$
limit	否	Integer	分页大小取值范围： 1-100 默认取值： 10 正则匹配：^([1-9]\|[1-9][0-9]\|100)$

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	发送的实体的MIME类型。默认使用application/json; charset=UTF-8。默认取值： application/json; charset=UTF-8
X-Auth-Token	是	String	用户Token

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
policies	Array of ListPolicy objects	策略信息
count	Integer	指定告警规则对应的策略总数取值范围： 0-100

表5 ListPolicy
参数	参数类型	描述
metric_name	String	资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：“服务指标名称”。
extra_info	MetricExtraInfo object	当策略无附加信息时，不需要传递extra_info。
period	Integer	指标周期，单位是秒； 0是默认值，例如事件类告警该字段就用0即可； 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算；如想了解各个云服务的指标原始周期可以参考“支持服务列表”，300代表指标按5分钟聚合周期为一个数据点参与告警计算。取值范围： 0-86400 枚举值： 0 1 300 1200 3600 14400 86400
filter	String	聚合方式, 支持的值为(average\|min\|max\|sum)
comparison_operator	String	阈值符号, 支持的值为(>\|<\|>=\|<=\|=\|!=\|cycle_decrease\|cycle_increase\|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动；指标告警可以使用的阈值符号有>、>=、<、<=、=、!=、cycle_decrease、cycle_increase、cycle_wave；事件告警可以使用的阈值符号为>、>=、<、<=、=、!=；
value	Number	告警阈值。单一阈值时value和alarm_level配对使用，当hierarchical_value和value同时使用时以hierarchical_value为准。具体阈值取值请参见附录中各服务监控指标中取值范围，如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。 [具体阈值取值请参见附录中各服务监控指标中取值范围，如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。]
hierarchical_value	HierarchicalValue object	多层级告警阈值。当hierarchical_value和value同时使用时以hierarchical_value为准。创建或修改告警规则以下2种场景只支持设置一个阈值： 1.告警类型为指标告警且告警策略为所有策略都满足才告警的场景。 2.告警类型为事件告警的场景。
unit	String	数据的单位。
type	String	告警策略类型，默认为空
count	Integer	告警连续触发次数，事件告警时参数值为1~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180
suppress_duration	Integer	告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题，0代表不抑制，满足条件即告警；300代表满足告警触发条件后每5分钟告警一次；取值范围： 0-86400 枚举值： 0 300 600 900 1800 3600 10800 21600 43200 86400
level	Integer	告警级别, 1为紧急，2为重要，3为次要，4为提示。默认值为2。
namespace	String	查看产品层级规则的策略，会同时返回该策略的namespace（服务命名空间）和dimension_name（服务维度名称）用来获取生效的策略归属。各服务命名空间请参考“服务命名空间”
dimension_name	String	查看产品层级规则的策略，会同时返回该策略的namespace（服务命名空间）和dimension_name（服务维度名称）用来获取生效的策略归属。目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务维度名称”

表6 MetricExtraInfo
参数	参数类型	描述
origin_metric_name	String	原始指标名称
metric_prefix	String	指标名称前缀
custom_proc_name	String	用户进程名称
metric_type	String	指标类型

表7 HierarchicalValue
参数	参数类型	描述
critical	Double	紧急级别的阈值取值范围： 0-1.7976931348623156E108
major	Double	重要级别的阈值取值范围： 0-1.7976931348623156E108
minor	Double	次要级别的阈值取值范围： 0-1.7976931348623156E108
info	Double	提示级别的阈值取值范围： 0-1.7976931348623156E108

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

请求示例

查询告警规则ID为alCzk8o9dtSQHtiDgb44Eepw，且分页大小为10的告警规则策略列表。

/v2/{project_id}/alarms/alCzk8o9dtSQHtiDgb44Eepw/policies?offset=0&limit=10

响应示例

状态码：200

查询成功

{
  "policies" : [ {
    "namespace" : "AGT.ECS",
    "metric_name" : "disk_device_read_bytes_rate",
    "extra_info" : { },
    "period" : 1,
    "filter" : "average",
    "comparison_operator" : ">",
    "value" : 75,
    "hierarchical_value" : {
      "critical" : 1
    },
    "unit" : "byte/s",
    "count" : 3,
    "type" : "",
    "suppress_duration" : 10800,
    "level" : 2
  } ],
  "count" : 10
}

状态码


状态码	描述
200	查询成功
400	参数校验失败
404	告警规则不存在
500	系统内部错误

错误码

请参见错误码。

父主题： 告警策略

上一篇：修改告警规则策略(全量修改)

下一篇：告警通知

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问