跳转到主要内容
POST
创建静默策略

限制说明

使用说明

  • time_filter(一次性窗口)与 time_filters(周期窗口)必须且只能设置其一,且 filters 至少包含一个条件,否则返回 InvalidParameter。
  • 每个进入的事件依次经过排除策略、静默策略、抑制策略。命中第一条启用、时间窗口覆盖当前时刻且 filters 匹配的静默策略即生效。
  • 设置 from_incident_id 时,每个故障只能有一条启用的静默策略,再次创建返回 InvalidParameter。
  • 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

创建静默策略所需的参数。time_filter 与 time_filters 必须且只能设置其一,filters 不能为空。

channel_id
integer<int64>
必填

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

rule_name
string
必填

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

Required string length: 1 - 39
description
string

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

Maximum string length: 500
from_incident_id
string

创建该策略所依据的故障 ID(24 位十六进制)。故障必须存在,且每个故障只能有一条启用的静默策略。

Pattern: ^[0-9a-fA-F]{24}$
time_filters
object[]

周期静默窗口。time_filters 与 time_filter 必须且只能设置其一。

time_filter
object

一次性静默窗口。time_filter 与 time_filters 必须且只能设置其一。

filters
object[][]

告警事件匹配条件(AND 组之间为 OR),时间窗口内命中的事件被静默。必填,且至少包含一个条件。可用字段: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 时,告警仍会被记录,但标记为被本策略静默。

is_auto_delete
boolean

为 true 时,使用一次性 time_filter 的策略在 end_time(或最近一次更新时间,取较晚者)约 24 小时后被永久移除。通过 from_incident_id 创建的策略同样按此方式清理。使用周期 time_filters 的策略不会被自动移除。默认 false。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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