Skip to main content
POST
创建告警规则

限制说明

使用说明

  • nameds_typecron_patternrule_configs.queries 为必填项。
  • ds_list(支持通配符)或 ds_ids 必须有一个非空。
  • cron_pattern 使用标准 5 字段 cron 语法。
  • channel_ids 可为空,告警将通过全局集成路由。
  • namefolder_id 内必须唯一;重名会返回 InvalidParameter
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

完整的告警规则配置。

id
integer<uint64>

规则 ID。更新时必填,创建时省略(服务端自动分配)。

account_id
integer<uint64>

账户 ID,由服务端按认证信息自动填充,无需提供。

folder_id
integer<uint64>

规则所属文件夹 ID,可通过 POST /monit/folder/list 获取。

name
string

规则名称,同一文件夹内必须唯一。

labels
object

自定义标签。

ds_type
string

数据源类型标识,可选值可通过 POST /monit/rule/dstypes 查询(如 prometheuselasticsearch)。

ds_list
string[]

数据源名称模式(支持通配符)。

ds_ids
integer<uint64>[]

数据源 ID 列表,与 ds_list 合并后共同决定规则监控的数据源,使用 ID 可避免数据源改名后失效。ds_listds_ids 至少提供一个。

enabled
boolean

是否启用规则。更新为 false 时服务端会清理该规则的活跃告警。

debug_log_enabled
boolean

是否开启调试日志,开启后 edge 评估该规则时输出详细日志,用于排查规则未按预期触发等问题。

rule_configs
object

检测配置,包含查询列表与触发/恢复条件,结构见 RuleConfigs

cron_pattern
string

调度表达式:6 段(含秒)cron 表达式或 @every 30s 间隔描述。不允许以 CRON_TZ=TZ= 开头,时区请填写到 timezone 字段。

timezone
string
默认值:Asia/Shanghai

告警规则执行时区,决定 cron 调度与生效时间窗口的解释方式。仅接受 IANA 时区名(如 Asia/ShanghaiUTCEurope/London);不接受 LocalUTC+8CST 等简写或偏移量。留空时按 Asia/Shanghai 处理。

delay_seconds
integer

评估时查询窗口向前偏移的秒数,用于补偿数据摄入延迟。

enabled_times
object[]

规则生效的时间窗口。省略或传空数组时,默认每天 00:00–23:59 生效。

annotations
object

附加注解键值对,随告警事件下发;键不允许以 $ 开头(该前缀保留给查询字段)。

description_type
enum<string>
默认值:text

描述内容的格式。省略或为空时默认使用 texttext = 纯文本;markdown = Markdown 格式,告警详情中按 Markdown 渲染。

可用选项:
text,
markdown
description
string

规则描述,Markdown 格式。

channel_ids
integer<uint64>[]

告警发送到的协作空间 ID 列表。

repeat_interval
integer<int64>

通知重复间隔(秒)。

repeat_total
integer<int64>

最大重复通知次数。

creator_id
integer<uint64>

创建人 ID,由服务端按当前用户自动填充,无需提供。

creator_name
string

创建人名称,由服务端自动填充,无需提供。

updater_id
integer<uint64>

最近更新人 ID,由服务端自动填充,无需提供。

updater_name
string

最近更新人名称,由服务端自动填充,无需提供。

created_at
integer<int64>

创建时间,Unix 秒级时间戳,由服务端生成,无需提供。

updated_at
integer<int64>

最近更新时间,Unix 秒级时间戳,由服务端生成,无需提供。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

完整的告警规则配置。