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

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

one_click_alarm_id

是

String

参数解释

一键告警ID，通过查询一键告警列表接口获取一键告警ID。

约束限制

不涉及

取值范围

长度为1到64字符，只能包含字母数字

默认取值

不涉及

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

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

X-Auth-Token

否

String

参数解释:

用户Token。Token认证，具体操作请参考认证鉴权。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

alarms

Array of alarms objects

告警规则列表

alarm_id

String

参数解释：

告警规则id。如 al260110T163723S8DUtBVrM

取值范围：

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

name

String

参数解释：

告警规则名称。

取值范围：

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

description

String

参数解释：

告警规则描述信息。

取值范围：

长度为0到256个字符。

namespace

String

参数解释：

查询服务的命名空间，各服务命名空间请参阅支持监控的服务列表。

取值范围：

格式为service.item，如SYS.ECS（弹性云服务器）；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在3到32个字符之间。

policies

Array of OneClickAlarmPolicy objects

参数解释：

告警策略。

resources

Array of ResourcesInListResp objects

参数解释：

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

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 Notification objects

参数解释：

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

ok_notifications

Array of Notification objects

参数解释：

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

notification_begin_time

String

参数解释：

告警通知开启时间，如：00:00。

取值范围：

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

notification_end_time

String

参数解释：

告警通知关闭时间。如 08:00

取值范围：

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

effective_timezone

String

参数解释：

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

取值范围：

长度为1到16个字符。

notification_manner

String

参数解释：

告警的通知方式。

取值范围：

• NOTIFICATION_GROUP：通知组

• TOPIC_SUBSCRIPTION：主题订阅

• NOTIFICATION_POLICY：通知策略

notification_policy_ids

Array of strings

参数解释：

关联的通知策略ID列表。

alarm_policy_id

String

参数解释：

告警策略ID。

取值范围：

长度为[1,64]个字符，只能包含字母、数字、-

metric_name

String

参数解释：

资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

取值范围：

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

period

Integer

参数解释：

告警条件判断周期,单位为秒。

取值范围：

枚举值。

• 0是默认值，事件类告警该字段用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：环比波动

value

Number

参数解释：

告警阈值。具体阈值取值请参见支持监控的服务列表。

取值范围：

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

hierarchical_value

HierarchicalValue object

参数解释：

多层级告警阈值。

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代表不抑制；在累计触发场景，0代表只告警一次。

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

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

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

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

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

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

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

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

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

level

Integer

参数解释：

告警级别。

取值范围：

• 1：紧急

• 2：重要

• 3：次要

• 4：提示

enabled

Boolean

参数解释

是否启用一键告警

取值范围

• true:开启

• false：关闭

selected_unit

String

参数解释：

用户在页面中选择的指标单位， 用于后续指标数据回显和计算。字符串最大长度为64。

取值范围：

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

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获取，具体操作请参《消息通知服务API参考》中查询主题列表查询主题列表章节。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

error_code

String

参数解释：

用于标识请求异常的具体原因。

取值范围：

字符串长度为0到256个字符。

error_msg

String

参数解释：

用于描述请求异常的具体信息。

取值范围：

字符串长度为0到256个字符。

request_id

String

参数解释：

用于唯一标识一次请求，便于问题追踪。

取值范围：

字符串长度为0到256个字符。

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

500

系统内部错误