跳转到主要内容
POST
创建抑制策略

限制说明

使用说明

  • 需要 Standard 及以上许可证,否则返回 NoLicense。
  • 当新事件命中 target_filters,且同一协作空间内存在一条未恢复、alert_key 不同、命中 source_filters、在该事件前 10 分钟内开始、并且 equals 中每个字段取值都相同的告警时,该事件被抑制。
  • equals 或 source_filters 为空,或新事件缺少 equals 中列出的标签时,该策略永远不会生效。
  • 抑制策略在排除和静默策略之后检查,命中第一条即生效。
  • channel_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_name
string
必填

策略名称,1 到 39 个字符。

Required string length: 1 - 39
equals
string[]
必填

源告警与新事件取值必须相同的字段。只有 title、severity 和 labels.<name> 有效;其他字段(例如 data_source_id)虽能保存,但会导致策略永远不生效。必须传入;空数组同样使策略不生效。

description
string

策略描述,最多 500 个字符。

Maximum string length: 500
source_filters
object[][]

源告警(起抑制作用的告警)需满足的条件,匹配对象是协作空间内已存储的活跃告警。可用字段:title、description、severity(别名 incident_severity、alert_severity)、status(别名 incident_status、alert_status),或任意 labels.<name>。为空时策略不生效。

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

target_filters
object[][]

新进入的告警事件需满足的条件,满足才会被抑制;为空表示所有新事件都是抑制对象。可用字段:title、description、severity(别名 alert_severity、event_severity)、status、alert_key、title_rule、integration_id(别名 data_source_id),或任意 labels.<name>。

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

is_directly_discard
boolean

为 true 时,命中的告警事件被完全丢弃;为 false 时,告警仍会被记录,但标记为被本策略静默。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。