查询一键告警关联告警规则列表

project_id

是

String

参数解释:

租户ID

约束限制:

不涉及。

取值范围:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

one_click_alarm_id

是

String

一键告警ID

Content-Type

是

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

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

默认取值：

application/json; charset=UTF-8

X-Auth-Token

是

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

alarms

Array of alarms objects

告警规则列表

alarm_id

String

告警规则id，以al开头，包含22个数字或字母

name

String

告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字，长度1-128

description

String

告警描述，长度0-256

namespace

String

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

policies

Array of OneClickAlarmPolicy objects

告警策略

resources

Array of ResourcesInListResp objects

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

type

String

参数解释：

告警规则类型

约束限制：

不涉及。

取值范围：

枚举值。ALL_INSTANCE为全部资源指标告警，RESOURCE_GROUP为资源分组指标告警，MULTI_INSTANCE为指定资源指标告警，EVENT.SYS为系统事件告警，EVENT.CUSTOM自定义事件告警，DNSHealthCheck为健康检查告警；

默认取值：

不涉及。

枚举值：

• EVENT.SYS

• EVENT.CUSTOM

• DNSHealthCheck

• RESOURCE_GROUP

• MULTI_INSTANCE

• ALL_INSTANCE

enabled

Boolean

是否开启告警规则。true:开启，false:关闭。

notification_enabled

Boolean

是否开启告警通知。true:开启，false:关闭。

alarm_notifications

Array of Notification objects

告警触发的动作

ok_notifications

Array of Notification objects

告警恢复触发的动作

notification_begin_time

String

告警通知开启时间

notification_end_time

String

告警通知关闭时间

effective_timezone

String

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

notification_manner

String

NOTIFICATION_GROUP(通知组)/TOPIC_SUBSCRIPTION(主题订阅)/NOTIFICATION_POLICY(通知策略)

枚举值：

• NOTIFICATION_GROUP

• TOPIC_SUBSCRIPTION

• NOTIFICATION_POLICY

notification_policy_ids

Array of strings

关联的通知策略ID列表

alarm_policy_id

String

告警策略ID。

metric_name

String

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

period

Integer

告警条件判断周期，单位为秒，支持的值为1，300，1200，3600，14400，86400。说明：当period设置为1时，表示以原始的指标数据判断告警。当alarm_type为（EVENT.SYS| EVENT.CUSTOM）时允许为0。

枚举值：

• 0

• 1

• 300

• 1200

• 3600

• 14400

• 86400

filter

String

聚合方式。average： 平均值，variance：方差，min：最小值，max：最大值，sum：求和，tp99：99百分位数，tp95：95百分位数，tp90：90百分位数

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

数据的单位。

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表示只告警一次，300表示每5分钟告警一次，600表示每10分钟告警一次，900表示每15分钟告警一次，1800表示每30分钟告警一次，3600表示每1小时告警一次，10800表示每3小时告警一次，21600表示每6小时告警一次，43200表示每12小时告警一次，86400表示每1天告警一次。

枚举值：

• 0

• 300

• 600

• 900

• 1800

• 3600

• 10800

• 21600

• 43200

• 86400

level

Integer

告警级别, 1为紧急，2为重要，3为次要，4为提示。默认值为2。

enabled

Boolean

是否启用一键告警。true:开启，false：关闭。

selected_unit

String

用户在页面中选择的指标单位， 用于后续指标数据回显和计算

critical

Double

紧急级别的阈值

取值范围：

-1.7976931348623156E108-1.7976931348623156E108

major

Double

重要级别的阈值

取值范围：

-1.7976931348623156E108-1.7976931348623156E108

minor

Double

次要级别的阈值

取值范围：

-1.7976931348623156E108-1.7976931348623156E108

info

Double

提示级别的阈值

取值范围：

-1.7976931348623156E108-1.7976931348623156E108

resource_group_id

String

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

正则匹配：^rg([a-z]|[A-Z]|[0-9]){22}$

resource_group_name

String

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

dimensions

Array of MetricDimension objects

维度信息

name

String

指标维度名称

正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

value

String

指标维度值

正则匹配：^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-)*)|){0,256}$

type

String

通知类型。notification为SMN通知，contact为云账号联系人，contactGroup为通知组。autoscaling为AS通知，只在AS中使用，不推荐客户使用。groupwatch、ecsRecovery及iecAction，已废弃，不推荐使用。

枚举值：

• notification

• autoscaling

• groupwatch

• ecsRecovery

• contact

• contactGroup

• iecAction

notification_list

Array of strings

告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notification_list列表不能为空；当type为autoscaling时，列表必须为[]。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notification_list值保持一致。

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

500

系统内部错误