跳转到主要内容
POST
更新排除规则

限制说明

使用说明

  • 整体替换:未传 description 会被清空;未传 filters 会清除全部条件,规则不再匹配任何事件。
  • channel_id 或 rule_id 不存在时返回 InvalidParameter。
  • 调用者还必须拥有该协作空间的编辑权:账户所有者或管理员、协作空间创建者,或其管理团队成员(managing_team_ids 为空时为所属团队成员),否则返回 AccessDenied。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

更新排除规则所需参数。

channel_id
integer<int64>
必填

所属协作空间 ID,可通过 POST /channel/list 获取。

rule_id
string
必填

排除规则 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$
rule_name
string
必填

规则名称,1 到 39 个字符。

Required string length: 1 - 39
description
string

规则描述,最多 500 个字符。不传会清空原描述。

Maximum string length: 500
filters
object[][]

告警事件匹配条件(AND 组之间为 OR),命中的事件被直接丢弃。可用字段:title、description、severity(别名 alert_severity、event_severity)、status、alert_key、title_rule、integration_id(别名 data_source_id),或任意 labels.<name>。会整体替换原条件;不传则清空条件,规则不再匹配任何事件。

AND 组——组内所有条件须同时满足。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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