数据结构

CloseInactive

Integer

10

释放日志文件句柄的等待时间。当日志文件超过指定时间仍然没有写入新的日志时，释放该日志文件的句柄。
单位为秒，取值范围为 1~300 秒，默认为 60 秒。

CloseRemoved

Boolean

true

日志文件被移除之后，是否释放该日志文件的句柄。默认为 false。

CloseRenamed

Boolean

true

日志文件被重命名之后，是否释放该日志文件的句柄。默认为 false。

CloseEOF

Boolean

true

读取至日志文件的末尾之后，是否释放该日志文件的句柄。默认为 false。

CloseTimeout

Integer

1800

LogCollector 监控日志文件的最大时长。单位为秒，默认为0秒，表示不限制 LogCollector 监控日志文件的时长。
LogCollector 开始监控日志文件时开始计时，超出指定时长后，无论日志文件是否读取完毕，立即释放该日志文件的句柄，结束监控。

Name

String

test-alarm

告警策略名称。

AlarmId

String

a******

告警策略的 ID。

ProjectId

String

p********

告警策略所属的日志项目 ID。

Status

Boolean

true

是否开启告警策略。默认值为 true，即开启告警策略。

QueryRequest

Array of QueryRequest

/

检索分析语句，可配置 1~3 条。详细说明请参考QueryRequest。

RequestCycle

RequestCycle

/

告警任务的执行周期。详细说明请参考RequestCycle。

Condition

String

$1.errNum>0

告警触发条件。

TriggerPeriod

Integer

1

持续周期。持续满足触发条件 TriggerPeriod 个周期后，再进行告警；最小值为 1，最大值为 10。

AlarmPeriod

Integer

60

告警通知发送的周期。当告警持续触发次数达到指定限额（TriggerPeriod）时，日志服务会根据指定的周期发送告警通知。
此参数用于指定所有渠道的告警通知发送周期。单位为分钟。

AlarmPeriodDetail

AlarmPeriodSetting

/

告警通知发送的周期。当告警持续触发次数达到指定限额（TriggerPeriod）时，日志服务会根据指定的周期发送告警通知。
此参数用于为各渠道分别设置发送周期，详细说明请参考 AlarmPeriodSetting。

Severity

String

notice

告警通知的级别，即告警的严重程度。枚举值包括 notice、warning 或 critical，严重程度递增。

AlarmNotifyGroup

Array of AlarmNotifyGroupInfo

/

告警对应的通知列表。详细说明请参考 AlarmNotifyGroupInfo。

UserDefineMsg

String

test

告警通知的内容。

CreateTime

String

2021-08-19 11:41:29

创建告警策略的时间。

ModifyTime

String

2021-08-19 11:41:32

告警策略最近修改的时间。

AlarmNotifyGroupName

String

test-alarm-nofify

告警通知组名称。

AlarmNotifyGroupId

String

t****

告警通知组 ID。

NotifyType

Array of String

Trigger

告警通知的类型。可选值，选择一个或者多个：

• Trigger - 告警触发
• Recovery - 告警恢复

Receivers

Array of Receiver

/

接收告警的 IAM 用户列表。可设置 1~10 个 IAM 用户。详细信息请参考 Receiver。

CreateTime

String

2021-08-19 11:41:29

告警通知组创建的时间。

ModifyTime

String

2021-08-19 11:41:32

告警通知组修改的时间。

IamProjectName

String

default

告警组所属的 IAM 项目。

SMS

Integer

必选

短信告警周期，单位为分钟，取值范围为 10~1440。

Phone

Integer

必选

电话告警周期，单位为分钟，取值范围为 10~1440。

Email

Integer

必选

邮件告警周期，单位为分钟，取值范围为 1~1440。

GeneralWebhook

Integer

必选

自定义 webhook 告警周期，单位为分钟，取值范围为 1~1440。

TopicId

String

必选

告警策略执行的日志主题 ID。

TopicName

String

可选

告警策略执行的日志主题名称。

Query

String

必选

查询语句，支持的最大长度为 1024。

Number

Integer

必选

告警对象序号；从 1 开始递增。

StartTimeOffset

Integer

必选

查询范围起始时间相对当前的历史时间，单位为分钟，取值为非正，最大值为 0，最小值为 -1440。

EndTimeOffset

Integer

必选

查询范围终止时间相对当前的历史时间，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为 0，最小值为 -1440。

StartTime

String

必选

00:00:00

可接收告警通知的开始时间。24 小时制，格式为HH:mm:ss，时间范围为 00:00～23:59。
StartTime 不能大于 EndTime。

EndTime

String

必选

23:59:59

可接收告警通知的结束时间。24 小时制，格式为 HH:mm:ss，时间范围为 00:00～23:59。
StartTime 不能大于 EndTime。

AlarmContentTemplateId

String

必选

al****

告警内容模版 ID。

ReceiverType

String

必选

User

接收对象类型。可设置为：

• User：IAM 用户。
• UserGroup：IAM 用户组。

ReceiverNames

Array of String

可选

["aaa","bbb"]

IAM 用户或用户组名称。

ReceiverChannels

Array of String

可选

["Email","Sms"]

通知接收渠道。支持设置一个或多个渠道。可设置为：

• Email：邮件。
• Sms：短信。
• Phone：电话。
• GeneralWebhook：自定义Webhook。

GeneralWebhookUrl

String

可选

https://xxxx.feushu.com/xxxx

自定义接口回调地址。

GeneralWebhookMethod

String

可选

POST

自定义接口回调方法，仅支持设置为 POST 或 PUT。

GeneralWebhookHeaders

Array of JSON

可选

[{"key":"Content-Type","value":"application/json"}]

自定义接口回调请求头。

GeneralWebhookBody

String

可选

/

自定义 WebHook 请求体。建议根据对应服务的回调接口格式要求设置请求体内容。

Type

String

必选

执行周期类型。

• Period：周期执行，即每隔一段时间执行一次。
• Fixed：定期执行，即每天的固定时间点执行一次。

Time

Integer

必选

告警任务的执行周期。支持如下两种配置方式：

• 指定具体分钟数：取值范围为 1~1440，单位为分钟。
• 指定 Cron 表达式：Cron 表达式的最小粒度为分钟，24 小时制。例如 0 18 * * * 表示每天 18 点整执行一次告警任务。