跳转到主要内容
POST
创建自动化规则

限制说明

使用说明

  • 传 0 创建个人规则。使用 App Key 且省略 team_id 时同样创建个人规则。创建团队规则要求调用者是该团队成员,账户所有者和管理员也不例外。
  • 规则的作用域在创建时确定:更新自动化规则时,team_id 与已存值不同会被拒绝。如需在其他作用域运行同一任务,请新建规则。
  • 即使只使用其他触发器,cron_expr 也必填;请传一个合法表达式并将 schedule_trigger_enabled 设为 false。
  • cron_expr 按 timezone 计算;未提供时依次使用调用者的成员时区、账户时区,最后为 Asia/Shanghai。
  • http_post_trigger_enabled=true 会创建并启用 HTTP POST 触发器。http_post_token 只在本次响应中返回,请妥善保存。触发方式:向 http_post_trigger_url 发送 POST,并带请求头 Authorization: Bearer <http_post_token>;可选的 JSON 请求体 {"text": "..."} 不超过 256 KB。
  • 只要传了任一 oncall_incident_* 字段,oncall_incident_channel_ids 与 oncall_incident_severities 都必须非空。命中条件的故障会以 trigger_kind=oncall_incident 发起运行。
  • 当 war_room_trigger_enabled=true 或传了 war_room_channel_ids 时,war_room_channel_ids 与 war_room_severities 都必须非空。命中条件的故障创建作战室(IM 群聊)后,Agent 会直接在该群聊中运行,运行记录的 trigger_kind 为 war_room_created。
  • 通过 API 创建的规则在 Web 控制台中运行(execution_place=web_console);run_in=current-chat 仅在与 AI SRE Agent 的实时 IM 会话中可用,通过 API 传入会被拒绝。
  • 响应为新建的规则;对创建者而言 can_edit 恒为 true。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

创建自动化规则。

name
string
必填

规则显示名称,1–255 个字符;首尾空格会被去除。

Required string length: 1 - 255
cron_expr
string
必填

按 timezone 本地时间计算的调度表达式。支持 4 段(hour day month weekday,分钟默认为 0)或 5 段(minute hour day month weekday)。分钟必须是一个固定整数;不支持秒级 6 段;同时指定日期和星期几会被拒绝。即使规则只使用其他触发器也必填:请传一个合法表达式并将 schedule_trigger_enabled 设为 false。

示例:

"15 9 * * *"

prompt
string
必填

每次运行发给 AI SRE Agent 的任务指令。去除首尾空格后不能为空。

Minimum string length: 1
team_id
integer<int64> | null

规则作用域。0:调用者的个人规则。>0:团队规则,调用者必须是该团队成员。省略:使用 App Key 时为个人规则;由 AI SRE Agent 创建时继承其会话的作用域。作用域创建后不可修改。

必填范围: x >= 0
run_in
enum<string> | null

规则运行的位置。web(默认):在 Web 控制台会话中运行。current-chat:在创建规则时所在的 IM 群聊中运行;仅在与 AI SRE Agent 的实时 IM 会话中可用,API 调用传入会返回 400。

可用选项:
web,
current-chat,
null
enabled
boolean

创建后是否启用规则的自动触发器(定时、HTTP POST、On-call 故障、作战室)。默认 false。手动运行不受此影响。

timezone
string

计算 cron_expr 所用的 IANA 时区名,例如 Asia/Shanghai。Local、CST、UTC+8、GMT+8 等含糊名称会被拒绝。省略时依次使用调用者的成员时区、账户时区,最后为 Asia/Shanghai。

schedule_trigger_enabled
boolean | null

是否启用定时触发器。省略时为 true;只希望由其他触发器触发的规则请传 false。

environment_kind
enum<string>

运行环境类型。省略或空字符串表示自动选择。可选值:cloud(平台托管的云端沙箱)、byoc(账户内自托管的 BYOC 运行器,需配合 environment_id);自动选择时优先使用在线的 BYOC 运行器,否则使用云端沙箱。

可用选项:
,
cloud,
byoc
environment_id
string

BYOC 运行器 ID。environment_kind=byoc 时必填,其他类型下传入会被拒绝。个人规则只能使用账户级运行器;团队规则可使用账户级运行器或本团队的运行器。

http_post_trigger_enabled
boolean

是否创建并启用 HTTP POST 触发器。为 true 时,响应会返回 http_post_trigger_url 和一次性的 http_post_token。

oncall_incident_trigger_enabled
boolean

是否启用 On-call 故障触发器。创建该触发器时(本字段为 true,或传了协作空间 ID 或严重程度),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

是否将相似故障合并分析。为 true(默认)时,与本规则正在分析的故障(运行中或 10 分钟内刚结束的运行)高度相似的新故障会加入该运行的会话,而不新开运行;其自身的运行记录为 skipped,并带有 joined_session_id。为 false 时,每个命中的故障都单独发起运行。

war_room_trigger_enabled
boolean

是否启用作战室触发器。当 war_room_channel_ids 中某个协作空间的故障(严重程度在 war_room_severities 中)创建作战室(IM 群聊)时触发,Agent 会直接在该群聊中运行。创建该触发器时(本字段为 true,或传了 war_room_channel_ids),两个列表都必须非空。

war_room_channel_ids
integer<int64>[]

创建作战室时会发起运行的协作空间 ID。每个 ID 必须为正数。

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

故障创建作战室时会发起运行的严重程度:Critical(最严重)、Warning 或 Info(最轻)——即 On-call 故障的严重程度。

可用选项:
Critical,
Warning,
Info

响应

成功

所有 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

自动化规则。