跳转到主要内容
POST
更新自动化规则

限制说明

使用说明

  • 省略或传 null 的字段保持不变。*_channel_ids / *_severities 传空数组时也保留已存的列表。
  • team_id 不可修改:传入与已存值不同的值会返回 400;重复传入当前值是允许的。
  • cron_expr 与 timezone 可以单独传,另一个保持已存值。传 timezone: "" 会存为 UTC。
  • 只传 environment_kind 不传 environment_id 时,会清空已存的 environment_id。
  • 规则没有 HTTP POST 触发器时,http_post_trigger_enabled=true 会创建一个并返回其 token。rotate_http_post_trigger_token=true 会签发新 token(旧 token 立即失效),要求该触发器处于启用状态。新 token 只在本次响应中返回。
  • 通过更新新建 On-call 故障或作战室触发器时,必须同时提供对应的协作空间 ID 和严重程度。
  • 管理权限:个人规则(team_id=0)仅创建者可管理;团队规则仅该团队成员可管理。账户所有者和管理员没有例外,需加入该团队。
  • 同一规则正在执行另一次更新、删除或手动运行时,本调用返回 HTTP 423,code 为 "RequestLocked",请稍后重试。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

更新自动化规则。字段省略或传 null 表示不修改。

rule_id
string
必填

目标规则 ID,取自 POST /safari/automation/rule/list 返回的列表。

name
string | null

新的显示名称,最多 255 个字符。去除空格后为空会被拒绝。

Maximum string length: 255
team_id
integer<int64> | null

规则作用域不可修改。请省略本字段或传当前值;传其他值会返回 400。

必填范围: x >= 0
enabled
boolean | null

是否启用规则的自动触发器。省略则保持不变。

cron_expr
string | null

新的调度表达式,格式与创建时相同:4 段(hour day month weekday)或 5 段(minute hour day month weekday),分钟为固定整数,不支持秒,不能同时指定日期和星期几。省略则保持当前表达式。

示例:

"15 9 * * *"

timezone
string | null

cron_expr 使用的新 IANA 时区。传空字符串会存为 UTC。省略或传 null 保持当前时区。

schedule_trigger_enabled
boolean | null

是否启用定时触发器。省略则保持不变。

prompt
string | null

新的 Agent 任务指令。省略则保持不变。

environment_kind
enum<string> | null

新的运行环境:"" 自动选择(优先使用在线的 BYOC 运行器,否则使用云端沙箱)、cloud 平台托管的云端沙箱、byoc 使用 environment_id 指定的运行器。只传本字段不传 environment_id 时会清空已存的 environment_id。

可用选项:
,
cloud,
byoc
environment_id
string | null

BYOC 运行器 ID;最终 environment_kind 为 byoc 时必填,其他情况下会被拒绝。

http_post_trigger_enabled
boolean | null

启用或停用 HTTP POST 触发器。规则没有该触发器时传 true 会创建一个,并在本次响应中返回其 token。

oncall_incident_trigger_enabled
boolean | null

启用或停用 On-call 故障触发器。规则还没有该触发器时,创建它还需同时提供 oncall_incident_channel_ids 和 oncall_incident_severities。

oncall_incident_channel_ids
integer<int64>[]

非空时替换监听的协作空间 ID;空数组或省略则保留已存的 ID。

必填范围: x >= 1
oncall_incident_severities
enum<string>[]

非空时替换监听的严重程度(Critical(最严重)、Warning 或 Info(最轻)——即 On-call 故障的严重程度);空数组或省略则保留已存的值。

可用选项:
Critical,
Warning,
Info
oncall_incident_merge_similar
boolean | null

是否将相似故障合并分析(含义见创建接口)。省略则保持不变。

war_room_trigger_enabled
boolean | null

启用或停用作战室触发器。规则还没有该触发器时,创建它还需同时提供 war_room_channel_ids 和 war_room_severities。省略则保持不变。

war_room_channel_ids
integer<int64>[]

非空时替换会触发运行的作战室协作空间 ID;空数组或省略则保留已存的 ID。

必填范围: x >= 1
war_room_severities
enum<string>[]

非空时替换作战室触发的严重程度(Critical(最严重)、Warning 或 Info(最轻)——即 On-call 故障的严重程度);空数组或省略则保留已存的值。

可用选项:
Critical,
Warning,
Info
rotate_http_post_trigger_token
boolean

为 true 时签发新的 HTTP POST 触发器 token,旧 token 失效。该触发器必须存在且处于启用状态。新 token 只在本次响应中返回。

响应

成功

所有 Flashduty 公开 API 共用的标准响应结构。成功时 data 为接口专属载荷且不含 error;失败时 error 存在而 data 缺失。request_id 始终存在,并会同步写入 Flashcat-Request-Id 响应头。

request_id
string
必填

本次请求的唯一 ID,与 Flashcat-Request-Id 响应头一致。反馈问题时请携带该 ID。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

响应结构中的错误 payload,仅在非 2xx 响应时出现。

data
object

自动化规则。