跳转到主要内容
POST
创建或替换富化规则

限制说明

使用说明

  • rules 整体替换已存的规则集,传 [] 可删除全部规则。
  • 集成必须存在(否则返回 InvalidParameter),且调用方须有权编辑该集成:账户管理员、集成创建者、能编辑其所属协作空间的成员(协作空间内的集成),或集成所属团队的成员;既无团队也不属于协作空间的集成任何成员都可编辑。其他人返回 AccessDenied。
  • 规则按数组顺序作用于每个进入的告警事件和变更事件,后面的规则能看到前面规则写入的标签。if 条件未全部满足的规则会被跳过;运行时失败的规则(正则未匹配、映射未命中、API 调用失败等)同样跳过,不影响事件本身。
  • if 中的条件键必须是告警或变更事件的键(如 title、description、labels.<name>),其他键返回 InvalidParameter。
  • 保存时不校验 schema_id、api_id 是否存在;指向不存在或已删除的映射规则 / API 的规则在运行时不生效。mapping_type 为 api 的 mapping 规则只对告警事件生效。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json
integration_id
integer<int64>
必填

待配置富化规则的集成 ID。

rules
object[]
必填

有序的规则列表,整体替换该集成的规则集;传 [] 可删除全部规则。规则按此顺序执行。单次请求最多 100 项,更多请分多次调用。

Maximum array length: 100

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。