查询告警通知屏蔽列表

project_id

是

String

租户ID

正则匹配：^[a-zA-Z0-9-]{1,64}$

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

默认取值：

100

正则匹配：^([1-9]|[1-9][0-9]|100)$

sort_key

否

String

排序关键字，与sort_dir同时使用。

目前只支持create_time与update_time

create_time表示按创建时间排序，update_time表示按修改时间排序

枚举值：

• create_time

• update_time

sort_dir

否

String

排序顺序，与sort_key同时使用。DESC表示降序排序；ASC表示升序排序；

枚举值：

• ASC

• DESC

Content-Type

是

String

发送的实体的MIME类型。默认使用application/json; charset=UTF-8。

默认取值：

application/json; charset=UTF-8

X-Auth-Token

是

String

用户Token

relation_type

是

String

屏蔽告警通知或者屏蔽告警计算的实现方式。ALARM_RULE：通过告警规则屏蔽告警通知，RESOURCE：通过资源屏蔽告警通知，RESOURCE_POLICY_NOTIFICATION：通过告警策略和告警资源屏蔽告警通知，RESOURCE_POLICY_ALARM：通过告警策略和告警资源屏蔽计算告警，DEFAULT：默认包含RESOURCE、RESOURCE_POLICY_NOTIFICATION（查询告警屏蔽列表时使用）。

枚举值：

• ALARM_RULE

• RESOURCE

• RESOURCE_POLICY_NOTIFICATION

• RESOURCE_POLICY_ALARM

• DEFAULT

relation_ids

是

Array of strings

关联编号（目前是告警规则ID）

metric_name

否

String

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

resource_level

否

String

dimension: 子维度,product: 云产品

枚举值：

• dimension

• product

mask_id

否

String

屏蔽规则ID,可选

正则匹配：^nm([0-9A-Za-z]){0,62}$

mask_name

否

String

屏蔽规则名称,可选，只能为字母、数字、汉字、-、_，最大长度为64

正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

mask_status

否

String

屏蔽状态,可选。MASK_EFFECTIVE：已生效，MASK_INEFFECTIVE：未生效。

枚举值：

• MASK_EFFECTIVE

• MASK_INEFFECTIVE

resource_id

否

String

资源维度值,提供一个维度的资源ID即可,可选

namespace

否

String

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

dimensions

否

Array of ResourceDimension objects

资源的维度信息

name

是

String

资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务指标维度”。

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

value

是

String

资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。

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

notification_masks

Array of notification_masks objects

通知屏蔽列表

count

Integer

通知屏蔽列表总数

取值范围：

0-99999

notification_mask_id

String

屏蔽规则ID

mask_name

String

屏蔽规则名称，只能为字母、数字、汉字、-、_，最大长度为64

relation_type

String

屏蔽告警通知或者屏蔽告警计算的实现方式。ALARM_RULE：通过告警规则屏蔽告警通知，RESOURCE：通过资源屏蔽告警通知，RESOURCE_POLICY_NOTIFICATION：通过告警策略和告警资源屏蔽告警通知，RESOURCE_POLICY_ALARM：通过告警策略和告警资源屏蔽计算告警。

枚举值：

• ALARM_RULE

• RESOURCE

• RESOURCE_POLICY_NOTIFICATION

• RESOURCE_POLICY_ALARM

relation_id

String

关联编号

resource_type

String

屏蔽资源类型。ALL_INSTANCE：全部资源，MULTI_INSTANCE：多实例资源

枚举值：

• ALL_INSTANCE

• MULTI_INSTANCE

metric_names

Array of strings

关联指标名称，relation_type为RESOURCE时存在该字段

product_metrics

Array of ProductMetric objects

按云产品维度屏蔽时的指标信息

resource_level

String

dimension: 子维度,product: 云产品

枚举值：

• dimension

• product

product_name

String

资源为云产品时的云产品名称

resources

Array of ResourceCategory objects

关联资源类型，relation_type为RESOURCE时存在该字段,只需要查询出资源的namespace+维度名即可

mask_status

String

屏蔽状态。UN_MASKED：未屏蔽，MASK_EFFECTIVE：已生效，MASK_INEFFECTIVE：未生效。

枚举值：

• UN_MASKED

• MASK_EFFECTIVE

• MASK_INEFFECTIVE

mask_type

String

屏蔽类型。START_END_TIME：按起止时间屏蔽，FOREVER_TIME：永久时间屏蔽，CYCLE_TIME：按周期时间屏蔽。

枚举值：

• START_END_TIME

• FOREVER_TIME

• CYCLE_TIME

create_time

Integer

告警屏蔽的创建时间，UNIX时间戳，单位毫秒。

update_time

Integer

告警屏蔽的更新时间，UNIX时间戳，单位毫秒。

start_date

String

屏蔽起始日期，yyyy-MM-dd。

start_time

String

屏蔽起始时间，HH:mm:ss。

end_date

String

屏蔽截止日期，yyyy-MM-dd。

end_time

String

屏蔽截止时间，HH:mm:ss。

effective_timezone

String

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

policies

Array of PoliciesInListResp objects

告警策略列表。

dimension_name

String

按云产品维度屏蔽时的指标维度信息，有多个时用","连接

metric_name

String

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

namespace

String

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

dimension_names

Array of strings

资源的维度信息，多个维度通过字母序排序后逗号拼接

alarm_policy_id

String

告警策略ID。

metric_name

String

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

extra_info

MetricExtraInfo object

告警策略附加信息，默认为空。

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

数据的单位。

count

Integer

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

type

String

告警策略类型。（暂时未使用）

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

alarm_level

Integer

告警级别，1为紧急，2为重要，3为次要，4为提示

selected_unit

String

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

origin_metric_name

String

原始指标名称

metric_prefix

String

指标名称前缀

custom_proc_name

String

用户进程名称

metric_type

String

指标类型

critical

Double

紧急级别的阈值

取值范围：

0-1.7976931348623156E108

major

Double

重要级别的阈值

取值范围：

0-1.7976931348623156E108

minor

Double

次要级别的阈值

取值范围：

0-1.7976931348623156E108

info

Double

提示级别的阈值

取值范围：

0-1.7976931348623156E108

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

200

批量查询通知屏蔽规则成功

400

参数校验失败

500

系统内部错误