查询告警规则列表（推荐） - ListAlarmRules

project_id

是

String

参数解释:

项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

alarm_id

否

String

参数解释：

告警规则ID。

约束限制：

不涉及。

取值范围：

以al开头，后跟22位的字母或数字。

默认取值：

不涉及。

name

否

String

参数解释：

告警名称。

约束限制：

不涉及。

取值范围：

只能包含0-9/a-z/A-Z/_/-或汉字，长度为[1,128]个字符。

默认取值：

不涉及。

namespace

否

String

参数解释：

查询服务的命名空间，各服务命名空间请参考“服务命名空间”。

约束限制：

不涉及。

取值范围：

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度在 0 到 32个字符之间。

默认取值：

不涉及。

resource_id

否

String

参数解释：

告警资源ID。

约束限制：

不涉及。

取值范围：

多维度情况按字母升序排列并使用逗号分隔。 长度为[0,700]个字符。

默认取值：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

只能包含小写字母、数字、“-”、“_”，可以自定义企业项目ID，长度为36个字符。也可以为0（代表默认企业项目ID），all_granted_eps（代表所有企业项目ID）。

默认取值：

不涉及。

product_name

否

String

参数解释：

产品层级跨维规则查询时支持产品名称查询，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id"。

约束限制：

不涉及。

取值范围：

长度为[0,128]个字符。

默认取值：

不涉及。

resource_level

否

String

参数解释：

产品层级跨维规则查询时支持规则所属类型查询，resource_level取值为product即为云产品类型，不填或者取值为dimension则为子维度类型。

约束限制：

不涉及。

取值范围：

枚举值。

• product：云产品。

• dimension：子维度。

默认取值：

不涉及。

offset

否

Integer

参数解释：

分页偏移量。

约束限制：

不涉及。

取值范围：

[0,10000]

默认取值：

0

limit

否

Integer

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

[1,100]

默认取值：

10

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为16384。

默认取值:

不涉及。

alarms

Array of alarms objects

参数解释：

告警规则列表。

取值范围：

长度为[1,100]个字符。

count

Integer

参数解释：

告警规则总数。

取值范围：

[0,10000]

alarm_id

String

参数解释：

告警规则id。如 al123232232341232132

取值范围：

以al开头，后跟22个数字或字母。长度为24个字符。

name

String

参数解释：

告警名称。

取值范围：

只能包含0-9/a-z/A-Z/_/-或汉字，长度[1，128]个字符。

description

String

参数解释：

告警描述。

取值范围：

长度为[0,256]个字符。

namespace

String

参数解释：

查询服务的命名空间，各服务命名空间请参考“服务命名名称”。

取值范围：

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度为[0,32]个字符。

policies

Array of Policy objects

参数解释：

告警策略

取值范围：

最多包含100个策略。

resources

Array of ResourcesInListResp objects

参数解释：

资源列表，关联资源需要使用查询告警规则资源接口获取。

取值范围：

最多支持3000个资源。

type

String

参数解释：

告警规则类型

取值范围：

枚举值。

• ALL_INSTANCE：全部资源指标告警。

• RESOURCE_GROUP：资源分组指标告警。

• MULTI_INSTANCE：指定资源指标告警。

• EVENT.SYS：系统事件告警。

• EVENT.CUSTOM：自定义事件告警。

• DNSHealthCheck：健康检查告警。

enabled

Boolean

参数解释：

是否开启告警规则。

取值范围：

布尔值。

• true:开启。

• false:关闭。

notification_enabled

Boolean

参数解释：

是否开启告警通知。

取值范围：

布尔值。

• true:开启。

• false:关闭。

alarm_notifications

Array of NotificationResp objects

参数解释：

触发告警时，通知组/主题订阅的信息。

ok_notifications

Array of NotificationResp objects

参数解释：

告警恢复时，通知组/主题订阅的信息。

notification_begin_time

String

参数解释：

告警通知开启时间。

取值范围：

只能包含数字、“:”，长度为[1,64]个字符。

notification_end_time

String

参数解释：

告警通知关闭时间。

取值范围：

只能包含数字、“:”，长度为[1,64]个字符。

effective_timezone

String

参数解释：

时区，形如："GMT-08:00"、"GMT+08:00"、"GMT+0:00"。

取值范围：

长度为[1,16]个字符。

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

只能包含小写字母、数字、“-”。

alarm_template_id

String

参数解释：

告警规则关联告警模板ID，如果传了，告警规则关联的策略会和告警模板策略联动变化。

取值范围：

以at开头，只包含字母、数字，长度为[2,64]个字符。

product_name

String

参数解释：

产品层级跨维规则需要指明的规则产品名称，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id"。

取值范围:

长度为[0,128]个字符。

resource_level

String

参数解释：

产品层级跨维规则需要指明为产品层级规则，resource_level取值为product即为云产品类型，不填或者取值为dimension则为子维度类型。

取值范围:

枚举值。

• product：云产品。

• dimension：子维度。

tags

Array of ResourceTag objects

参数解释：

租户标签列表

取值范围:

最多支持20个标签。

metric_name

String

参数解释：

资源的监控指标名称，各服务的指标名称可查看：“服务指标名称”。

约束限制：

不涉及。

取值范围：

必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。

默认取值：

不涉及。

period

Integer

参数解释：

指标周期，单位是秒。如想了解各个云服务的指标原始周期可以参考“支持服务列表”。

约束限制：

不涉及。

取值范围：

枚举值。

• 0代表立即触发，仅限事件场景使用。

• 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算。

• 300代表指标按5分钟聚合周期为一个数据点参与告警计算。

• 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。

• 3600代表指标按1小时聚合周期为一个数据点参与告警计算。

• 14400代表指标按4小时聚合周期为一个数据点参与告警计算。

• 86400代表指标按1天聚合周期为一个数据点参与告警计算。

默认取值：

不涉及。

filter

String

参数解释：

聚合方式。

约束限制：

不涉及。

取值范围：

average： 平均值，variance：方差，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为准。

取值范围：

最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108。

默认取值：

不涉及。

hierarchical_value

HierarchicalValue object

参数解释：

多层级告警阈值。

约束限制：

当hierarchical_value和value同时使用时以hierarchical_value为准。

创建或修改告警规则以下2种场景只支持设置一个阈值：

1.告警类型为指标告警且告警策略为所有策略都满足才告警的场景。

2.告警类型为事件告警的场景。

unit

String

参数解释：

数据的单位。

约束限制：

不涉及。

取值范围：

长度为[0,32]个字符。

默认取值：

不涉及。

count

Integer

参数解释：

告警连续触发次数。

约束限制：

不涉及。

取值范围：

事件告警时参数值为1~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180。

默认取值：

不涉及。

suppress_duration

Integer

参数解释：

告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。

约束限制：

不涉及。

取值范围：

枚举值，只能为0、300、600、900、1800、3600、10800、21600、43200、86400。

• 0：在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。

• 300代表满足告警触发条件后每5分钟告警一次。

• 600代表满足告警触发条件后每10分钟告警一次。

• 900代表满足告警触发条件后每15分钟告警一次。

• 1800代表满足告警触发条件后每30分钟告警一次。

• 3600代表满足告警触发条件后每60分钟告警一次。

• 10800代表满足告警触发条件后每3小时告警一次。

• 21600代表满足告警触发条件后每6小时告警一次。

• 43200代表满足告警触发条件后每12小时告警一次。

• 86400代表满足告警触发条件后每一天告警一次。

默认取值：

不涉及。

level

Integer

参数解释：

告警级别。

约束限制：

不涉及。

取值范围：

只能为1、2、3、4。1为紧急，2为重要，3为次要，4为提示。

默认取值：

2

namespace

String

参数解释：

产品层级规则增加namespace（服务命名空间）和dimension_name（服务维度名称，用于指明生效策略的资源归属。各服务命名空间请参考“服务命名空间”。

约束限制：

不涉及。

取值范围：

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在0到32个字符之间。

默认取值：

不涉及。

dimension_name

String

参数解释：

指标维度名称，各服务资源的指标维度名称可查看：“服务维度名称”。产品层级规则需要增加namespace（服务命名空间）和dimension_name（服务维度名称），用于指明策略生效的资源归属。

约束限制：

不涉及。

取值范围：

目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk

默认取值：

不涉及。

enabled

Boolean

参数解释:

告警策略是否生效。

约束限制:

不涉及。

取值范围:

取值为true、false

• true：策略生效

• false：策略无效

默认取值:

不涉及。

critical

Double

参数解释：

紧急级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

major

Double

参数解释：

重要级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

minor

Double

参数解释：

次要级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

info

Double

参数解释：

提示级别的阈值。

约束限制：

不涉及。

取值范围：

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值：

不涉及。

resource_group_id

String

参数解释：

资源分组ID，监控范围为资源分组时存在该值。

取值范围：

以rg开头，后跟22个字母或数字。

resource_group_name

String

参数解释：

资源分组名称，监控范围为资源分组时存在该值。

取值范围：

长度为[1,128]个字符。

dimensions

Array of MetricDimensionResp objects

参数解释：

维度信息。

name

String

参数解释：

指标维度名称。

取值范围：

以字母开头，长度为[1,32]个字符。

value

String

参数解释：

指标维度值。

取值范围：

长度为[0,256]个字符。

type

String

参数解释：

通知类型。

取值范围：

枚举值。

• notification：通知组或主题订阅。

• contact：云账号联系人。

• contactGroup：（已废弃）通知组。

• autoscaling：AS通知，只在AS中使用，不推荐客户使用。

• groupwatch：已废弃，不推荐使用。

• ecsRecovery：已废弃，不推荐使用。

• iecAction：已废弃，不推荐使用。

notification_list

Array of strings

参数解释：

告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。

key

String

参数解释：

标签名。

约束限制：

不涉及。

取值范围：

最大长度128个unicode字符。

默认取值：

不涉及。

value

String

参数解释：

标签值。

约束限制：

不涉及。

取值范围：

最大长度255个unicode字符。

默认取值：

不涉及。

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

200

查询成功

400

参数校验失败

500

系统内部错误