Skip to main content
POST
批量更新规则字段

限制说明

使用说明

  • fields 数组中指定要更新的字段名,如 ["enabled", "channel_ids"]
  • 仅更新指定字段,其他字段保持不变。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json
ids
integer<uint64>[]
必填

要更新的规则 ID 列表。

fields
enum<string>[]
必填

要更新的字段名列表。只有列出的字段会被更新,新值从同名请求字段读取;未列出的字段即使传值也会被忽略。

可用选项:
labels,
ds_type,
ds_list,
ds_ids,
enabled,
debug_log_enabled,
cron_pattern,
timezone,
delay_seconds,
enabled_times,
annotations,
description,
channel_ids,
repeat_interval,
repeat_total
labels
object

自定义标签键值对,整体替换现有标签。仅当 fields 包含 labels 时生效。

ds_type
string

数据源类型标识,可选值可通过 POST /monit/rule/dstypes 查询。仅当 fields 包含 ds_type 时生效。

ds_list
string[]

数据源名称匹配模式列表,支持通配符。仅当 fields 包含 ds_list 时生效。

ds_ids
integer<uint64>[]

数据源 ID 列表,与 ds_list 合并后共同决定规则监控的数据源,使用 ID 可避免数据源改名后失效。仅当 fields 包含 ds_ids 时生效。

enabled
boolean

是否启用规则。置为 false 时服务端会清理该规则的活跃告警。仅当 fields 包含 enabled 时生效。

debug_log_enabled
boolean

是否开启调试日志,开启后 edge 评估该规则时输出详细日志,用于排查问题。仅当 fields 包含 debug_log_enabled 时生效。

cron_pattern
string

调度表达式:6 段(含秒)cron 表达式或 @every 30s 间隔描述,不允许 CRON_TZ=/TZ= 前缀。仅当 fields 包含 cron_pattern 时生效。

timezone
string
默认值:Asia/Shanghai

告警规则执行时区,IANA 时区名,默认 Asia/Shanghai

delay_seconds
integer

评估时查询窗口向前偏移的秒数,用于补偿数据摄入延迟。仅当 fields 包含 delay_seconds 时生效。

enabled_times
object[]

规则生效的时间窗口数组,元素结构见 EnabledTime。仅当 fields 包含 enabled_times 时生效。

annotations
object

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

description
string

规则描述(Markdown)。仅当 fields 包含 description 时生效。

channel_ids
integer<uint64>[]

告警发送到的协作空间 ID 列表,可为空。仅当 fields 包含 channel_ids 时生效。

repeat_interval
integer<int64>

告警通知重复间隔(秒)。仅当 fields 包含 repeat_interval 时生效。

repeat_total
integer<int64>

最大重复通知次数。仅当 fields 包含 repeat_total 时生效。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]
必填

批量规则操作中每条规则的处理结果列表。