查询告警通知屏蔽列表

project_id

是

String

租户ID。

最小长度：1

最大长度：64

正则匹配：^[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)$

Content-Type

是

String

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

缺省值：application/json; charset=UTF-8

最小长度：1

最大长度：64

X-Auth-Token

是

String

用户Token。

最小长度：1

最大长度：16384

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）

数组长度：1 - 100

mask_id

否

String

屏蔽规则ID,可选

最小长度：1

最大长度：64

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

mask_name

否

String

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

最小长度：1

最大长度：64

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

mask_status

否

String

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

最小长度：1

最大长度：32

枚举值：

• MASK_EFFECTIVE

• MASK_INEFFECTIVE

resource_id

否

String

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

最小长度：1

最大长度：700

namespace

否

String

资源命名空间，例如弹性云服务器命名空间(格式为service.item；service和item必须是字符串，以字母开头，可包含0-9/a-z/A-Z/_；长度范围[3,32]。)

dimensions

否

Array of Dimension objects

资源的维度信息

数组长度：1 - 4

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

通知屏蔽列表

数组长度：1 - 100

count

Integer

通知屏蔽列表总数

最小值：0

最大值：99999

notification_mask_id

String

屏蔽规则编号

mask_name

String

屏蔽规则名称

relation_type

String

关联类型

枚举值：

• ALARM_RULE

• RESOURCE

• RESOURCE_POLICY_NOTIFICATION

• RESOURCE_POLICY_ALARM

relation_id

String

关联编号，relation_type为ALARM_RULE时存在该字段

resources

Array of ResourceCategory objects

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

数组长度：1 - 100

mask_status

String

屏蔽状态

枚举值：

• UN_MASKED

• MASK_EFFECTIVE

• MASK_INEFFECTIVE

mask_type

String

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

枚举值：

• START_END_TIME

• FOREVER_TIME

• CYCLE_TIME

start_date

String

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

start_time

String

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

end_date

String

屏蔽到期日期,，yyyy-MM-dd

end_time

String

屏蔽到期时间，HH:mm:ss

policies

Array of PoliciesInListResp objects

告警策略列表。

数组长度：0 - 50

namespace

String

资源命名空间，例如弹性云服务器命名空间(格式为service.item；service和item必须是字符串，以字母开头，可包含0-9/a-z/A-Z/_；长度范围[3,32]。)

dimension_names

Array of strings

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

最小长度：1

最大长度：131

数组长度：1 - 100

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。

枚举值：

• 1

• 300

• 1200

• 3600

• 14400

• 86400

filter

String

数据聚合的方式。支持max、min、average、sum、variance，分别表示最大值、最小值、平均值、求和值、方差值。

枚举值：

• max

• min

• average

• sum

• variance

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为准。取值范围[0, Number.MAX_VALUE]，Number.MAX_VALUE值为1.7976931348623157e+108。具体阈值取值请参见附录中各服务监控指标中取值范围，如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。[具体阈值取值请参见附录中各服务监控指标中取值范围，如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。](tag: dt,g42,dt_test,hk_g42,hk_sbc,hws,hws_hk,ocb,sbc,tm)

unit

String

数据的单位。

count

Integer

触发告警的连续发生次数，取值范围[1, 5]。

type

String

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

最小长度：0

最大长度：32

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

原始指标名称。

最小长度：1

最大长度：4096

正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$

metric_prefix

String

指标名称前缀。

最小长度：1

最大长度：4096

正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$

custom_proc_name

String

用户进程名称。

最小长度：1

最大长度：250

metric_type

String

指标类型。

最小长度：1

最大长度：32

正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求id

最小长度：0

最大长度：256

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求id

最小长度：0

最大长度：256

200

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

400

参数校验失败

500

系统内部错误