查询关键词告警规则 - ListKeywordsAlarmRules

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

keywords_alarm_rules

Array of KeywordsAlarmRuleRespList objects

参数解释：

关键词告警规则ID。

projectId

String

参数解释：

项目ID。

取值范围：

不涉及。

keywords_alarm_rule_id

String

参数解释：

关键词告警规则ID。

取值范围：

不涉及。

keywords_alarm_rule_name

String

参数解释：

关键词告警规则名称。

取值范围：

不涉及。

keywords_alarm_rule_description

String

参数解释：

关键词告警规则的简要描述。

取值范围：

不涉及。

condition_expression

String

参数解释：

告警条件表达式。

取值范围：

不涉及。

keywords_requests

Array of KeywordsRequestResponse objects

参数解释：

关键词告警规则信息。

frequency

FrequencyRespBody object

参数解释：

关键词告警统计周期信息。

keywords_alarm_level

String

参数解释：

关键词告警级别。

取值范围：

• Info：提示

• Minor：次要

• Major：重要

• Critical：紧急

domain_id

String

参数解释：

账号ID，获取方式请参见：获取账号ID。

取值范围：

不涉及。

create_time

Long

参数解释：

创建时间(毫秒时间戳)。

取值范围：

不涉及。

update_time

Long

参数解释：

更新时间(毫秒时间戳)。

取值范围：

不涉及。

status

String

参数解释：

关键词告警状态。

取值范围：

• RUNNING (开启)

• STOPPING (关闭)

trigger_condition_count

Integer

参数解释：

告警触发条件：满足条件次数。

取值范围：

不涉及。

trigger_condition_frequency

Integer

参数解释：

告警触发条件：统计周期次数。

取值范围：

不涉及。

whether_recovery_policy

Boolean

参数解释：

是否配置告警恢复策略。

取值范围：

• true：配置告警恢复策略。

• false：不配置告警恢复策略。

recovery_policy

Integer

参数解释：

告警恢复策略周期次数。

取值范围：

1-10

notification_frequency

Integer

参数解释：

关键词告警通知频率，单位(分钟)。

取值范围：

• 0

• 5

• 10

• 15

• 30

• 60

• 180

• 360

alarm_action_rule_name

String

参数解释：

告警行动规则名称。

取值范围：

不涉及。

tags

Array of tagsResBody objects

参数解释：

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

log_stream_id

String

参数解释：

日志流ID，获取方式请参见：获取日志组ID和日志流ID。

取值范围：

不涉及。

log_stream_name

String

参数解释：

日志流名称。

取值范围：

不涉及。

log_group_id

String

参数解释：

日志组ID。

取值范围：

不涉及。

log_group_name

String

参数解释：

日志组名称。

取值范围：

不涉及。

keywords

String

参数解释：

在日志搜索能查到的日志关键字。

取值范围：

不涉及。

condition

String

参数解释：

告警查询条件。

取值范围：

<、- >、 <=、>=

number

Integer

参数解释：

告警匹配条数。

取值范围：

不涉及。

search_time_range

Integer

参数解释：

查询执行告警任务时最近数据的时间范围。

取值范围：

• 最小值：1

• 最大值：60

search_time_range_unit

String

参数解释：

查询告警时间范围单位。

取值范围：

• minute

• hour

custom_date

CustomDate object

参数解释：

根据与告警执行时间的相对时间自定义告警查询时间区间。

is_time_range_relative

Boolean

参数解释：

告警查询日志的时间区间为相对时间还是整点时间。

取值范围：

• true: 相对时间。

• false: 整点时间。

conditions

Array of KeywordsAlarmConditions objects

参数解释：

支持根据不同条件触发不同级别的告警。当使用该参数时，将优先使用该参数中的条件触发告警，无视keywords_alarm_level参数以及keywords_requests中的condition、number参数。

log_group_name_alias

String

参数解释：

日志组别名。

取值范围：

不涉及。

log_stream_name_alias

String

参数解释：

日志流别名。

取值范围：

不涉及。

eps_id

String

参数解释：

企业项目ID。

取值范围：

不涉及。

time_range

TimeRange object

参数解释：

时间范围配置。

start

Integer

参数解释：

查询起始时间相对于告警计划执行时间的偏移量数值。

取值范围：

• start_unit取值为second，start取值范围为 1-86400；

• start_unit取值为minute，start取值范围为 1-1440；

• start_unit取值为hour，start取值范围为 1-24。

start_unit

String

参数解释：

查询起始时间相对于告警计划执行时间的偏移量单位。

取值范围：

• hour

• minute

• second

end

Integer

参数解释：

查询结束时间相对于告警计划执行时间的偏移量数值。

取值范围：

• end_unit取值为second，end取值范围为 0-86399；

• end_unit取值为minute，end取值范围为 0-1439；

• end_unit取值为hour，end取值范围为 0-23。

end_unit

String

参数解释：

查询结束时间相对于告警计划执行时间的偏移量单位。

取值范围：

• hour

• minute

• second

condition

String

参数解释：

触发条件，即满足该条件时，会触发告警。

取值范围：

不涉及。

number

Integer

参数解释：

匹配条数。当关键词搜索结果的日志条数达到设定的条数时，会触发告警。

取值范围：

不涉及。

alarm_level

String

参数解释：

告警级别。

取值范围：

• Info：提示

• Minor：次要

• Major：重要

• Critical：紧急

sql_time_zone

String

参数解释：

SQL语句的时区设置。用处理时间相关函数或时间类型的字段返回时的时区转换。

时区格式有-0800、 -08:00、America/Los_Angeles和UTC等。

例如：select MILLIS_TO_TIMESTAMP(0) as time 表示将毫秒值的时间戳转化为时间类型。

• 当sql_time_zone取值为UTC 时，time返回的时间格式为1970-01-01T00:00:00.000Z。

• 当sql_time_zone取值为+0800时，time返回的时间格式1970-01-01T08:00:00.000+08:00。

• 当sql_time_zone取值为America/Los_Angeles时，time返回的时间格式为1969-12-31T16:00:00.000-08:00。

取值范围：

不涉及。

start_time

Long

参数解释：

查询起始时间，timestamp时间戳格式，表示从1970-01-01T00:00:00.000Z UTC计算起的毫秒数。

取值范围：

• 大于0。

• 当小于日志流保存时间的最小值时，会默认修改为日志流保存时间区间的最小值。

end_time

Long

参数解释：

查询结束时间，timestamp时间戳格式，表示从1970-01-01T00:00:00.000Z UTC计算起的毫秒数。

取值范围：

大于0。

start_time_gt

Boolean

参数解释：

查询是否包含起始时间点。

取值范围：

• true：包含起始时间点。

• false：不包含起始时间点。

end_time_lt

Boolean

参数解释：

查询是否包含结束时间点。

取值范围：

• true：包含结束时间点。

• false：不包含结束时间点。

type

String

参数解释：

告警统计周期类型。

取值范围：

• CRON：cron表达式。

• HOURLY：每小时。

• DAILY：每天。

• WEEKLY：每周。

• FIXED_RATE：固定间隔。

cron_expr

String

参数解释：

CRON表达式。当type取值为CRON时，返回该字段。CRON最小精度为分钟，格式为24小时制。

取值范围：

不涉及。

hour_of_day

Integer

参数解释：

每天每小时。当type取值为DAILY或HOURLY时，返回该字段。

取值范围：

不涉及。

day_of_week

Integer

参数解释：

每周。当type取值为WEEKLY时，返回该字段。

取值范围：

不涉及。

fixed_rate

Integer

参数解释：

固定间隔。当type取值为FIXED_RATE时，返回该字段。

取值范围：

不涉及。

fixed_rate_unit

String

参数解释：

固定间隔时间单位。

取值范围：

• minute

• hour

key

String

参数解释：

标签键。

取值范围：

不涉及。

value

String

参数解释：

标签值。

取值范围：

不涉及。

error_code

String

参数解释：

错误码，请参见：错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

调用失败响应信息描述。

取值范围：

不涉及。

200

请求响应成功。

500

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