跳转到主要内容
POST
创建分派策略

限制说明

使用说明

  • 策略按 priority 从小到大匹配,第一条启用且 time_filters、filters 都命中新故障的策略负责该故障,其后的策略不再匹配。不传 priority 时排在现有策略之后。
  • template_id 必须是已存在的通知模板,person_ids 中的成员必须存在,team_ids 中的团队必须有成员,否则返回 InvalidParameter。
  • 新建的策略为 enabled 状态。
  • 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 获取。

template_id
string
必填

通知模板 ID(24 位十六进制),可通过 POST /template/list 获取,必须存在。

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

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

Required string length: 1 - 39
layers
object[]
必填

按顺序排列的通知环节,故障从第一个环节开始。至少需要配置一个环节。

Minimum array length: 1
priority
integer | null

匹配顺序,取值 0 到 200,数值越小越先匹配。不传时排在现有策略之后(当前最大优先级 + 1)。

必填范围: 0 <= x <= 200
aggr_window
integer

新分派故障首次通知前的延迟(秒),0–3600;0 表示立即通知。

必填范围: 0 <= x <= 3600
description
string

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

Maximum string length: 500
time_filters
object[]

策略可参与匹配的周期时间窗口;不传或为空表示任何时间。

filters
object[][]

故障匹配条件(AND 组之间为 OR),匹配的是告警所属的故障而不是告警本身。可用字段:title、description、severity(别名 incident_severity、alert_severity)、status(别名 incident_status、alert_status)、dedup_key、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

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