查询关键词告警规则

project_id

是

String

参数解释：

项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

最小长度：32

最大长度：32

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token，获取方式请参见：获取用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

最小长度：1000

最大长度：2000

Content-Type

是

String

参数解释：

用于定义消息体的格式，该字段填为：application/json;charset=utf8。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

最小长度：30

最大长度：30

keywords_alarm_rules

Array of KeywordsAlarmRuleRespList objects

项目id

projectId

String

项目id

最小长度：32

最大长度：32

keywords_alarm_rule_id

String

关键词告警id

最小长度：36

最大长度：36

keywords_alarm_rule_name

String

关键词告警名称

最小长度：1

最大长度：64

keywords_alarm_rule_description

String

关键词告警信息描述

最小长度：0

最大长度：64

condition_expression

String

条件

最小长度：0

最大长度：64

keywords_requests

Array of KeywordsRequest objects

关键词详细信息

frequency

Frequency object

告警统计周期

keywords_alarm_level

String

告警级别

枚举值：

• Info

• Minor

• Major

• Critical

keywords_alarm_send

Boolean

是否发送

domain_id

String

domainId

最小长度：32

最大长度：32

create_time

Long

创建时间（毫秒时间戳）

最小值：13

最大值：13

update_time

Long

更新时间（毫秒时间戳）

最小值：13

最大值：13

topics

Array of Topics objects

通知主题

template_name

String

消息模板名称

status

String

告警状态

枚举值：

• RUNNING 启用

• STOPPING 停止

trigger_condition_count

Integer

触发条件：触发周期；默认为1

trigger_condition_frequency

Integer

触发条件：触发次数；默认为1

whether_recovery_policy

Boolean

是否打开恢复通知；默认false

recovery_policy

Integer

恢复策略周期；默认为3

notification_frequency

Integer

通知频率,单位(分钟)

枚举值：

• 0

• 5

• 10

• 15

• 30

• 60

• 180

• 360

alarm_action_rule_name

String

告警行动规则名称

说明：

alarm_action_rule_name和notification_save_rule可以选填一个，如果都填，优先选择alarm_action_rule_name

tags

Array of tagsBody objects

告警标签

log_stream_id

String

参数解释：

日志流id。

取值范围：

不涉及。

最小长度：36

最大长度：36

log_stream_name

String

参数解释：

日志流名称。

取值范围：

不涉及。

最小长度：1

最大长度：64

log_group_id

String

参数解释：

日志组id。

取值范围：

不涉及。

最小长度：36

最大长度：36

log_group_name

String

参数解释：

日志组名称。

取值范围：

不涉及。

最小长度：1

最大长度：64

keywords

String

参数解释：

关键词。

取值范围：

不涉及。

最小长度：1

最大长度：1024

condition

String

参数解释：

添加。

取值范围：

不涉及。

number

Integer

参数解释：

条数。

取值范围：

不涉及。

最小值：1

最大值：2147483647

search_time_range

Integer

参数解释：

查询执行任务时最近数据的时间范围（当search_time_range_unit为minute，则最大值为60；当search_time_range_unit为hour，则最大值为24）。

取值范围：

• 最小值1

• 最大值60

默认取值：

1

search_time_range_unit

String

参数解释：

查询时间单位。

取值范围：

• minute

• hour

默认取值：

minute

枚举值：

• minute

type

String

参数解释：

统计周期类型。

取值范围：

• CRON cron表达式

• HOURLY 每小时

• DAILY 每天

• WEEKLY 每周

• FIXED_RATE 固定间隔

枚举值：

• CRON

• HOURLY

• DAILY

• WEEKLY

• FIXED_RATE

cron_expr

String

参数解释：

当字段type为"CRON"时取该字段。

示例:

0/9 * * * * 从每小时的第0分钟开始，每9分钟执行一次

0 18 * * * 每天18点0分发送一次

取值范围：

不涉及

最小长度：1

最大长度：1024

hour_of_day

Integer

参数解释：

当字段type为"DAILY"或者"WEEKLY"时取该字段。

取值范围：

不涉及

默认值：

0

day_of_week

Integer

参数解释：

当字段type为"WEEKLY"时取该字段（周日~周六）。

取值范围：

不涉及

默认值：

0

最小值：1

最大值：7

fixed_rate

Integer

参数解释：

当字段type为"FIXED_RATE"时取该字段（当fixed_rate_unit单位为minute，最大值60；当fixed_rate_unit单位为hour，最大值24）。

取值范围：

不涉及

默认值：

0

最小值：1

最大值：60

fixed_rate_unit

String

参数解释：

时间单位枚举值

取值范围：

• minute

• hour

默认值：

0

枚举值：

• minute

• hour

name

String

参数解释：

SMN主题名称。

取值范围：

不涉及。

topic_urn

String

参数解释：

SMN主题的唯一的资源标识。

取值范围：

不涉及。

display_name

String

参数解释：

发送邮件时，显示的发件人名称。。

取值范围：

不涉及。

push_policy

Integer

参数解释：

消息推送的策略，该属性目前不支持修改，后续将支持修改。

取值范围：

• 0：发送失败，保留到失败队列。

• 1：直接丢弃发送失败的消息。

key

String

参数解释：

标签键。

约束限制：

• 标签键名称不可重复。

• 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。

取值范围：

• 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符，但首尾不能包含空格，且不能以_sys_开头。

• 标签键长度不能超过128个字符。

默认取值：

不涉及。

value

String

参数解释：

标签值。

约束限制：

标签是以键值对（key-value）的形式表示，key和value为一一对应关系。

取值范围：

• 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。

• 标签值长度不能超过255个字符。

默认取值：

不涉及。

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

枚举值：

• Invalid projectId

200

请求响应成功。

500

表明服务端能被请求访问到，但是服务内部出错。