跳转到主要内容
POST
创建协作空间

限制说明

使用说明

  • channel_name 在账户内必须唯一,重名返回 InvalidParameter。
  • group.method 为 p 需要 Standard 及以上许可证,为 i 需要 Pro 许可证。超过当前套餐的协作空间数量上限同样返回 NoLicense。
  • 传入 escalate_rule 时,会同时创建一条名为 Default 的已启用分派策略,只有一个环节,对 escalate_rule.target 通知一次。
  • plugin_ids 中的每个 ID 会创建一个该类型的协作空间专属集成,集成名称为该类型名称。
  • is_external_report_enabled 为 true 时,响应中会额外返回 external_report_token。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

创建协作空间所需的参数。

team_id
integer<int64>
必填

所属团队 ID,可通过 POST /team/list 获取。必填且必须存在。

channel_name
string
必填

协作空间名称,1–59 个字符,账户内唯一。不能包含英文逗号,首尾不能有空白字符。

Required string length: 1 - 59
managing_team_ids
integer<int64>[]

可管理该协作空间的其他团队 ID,最多 3 个。

Maximum array length: 3
description
string

描述信息,最多 500 个字符。

Maximum string length: 500
escalate_rule
object

创建一条名为 Default 的已启用分派策略,只有一个环节,对 target 通知一次。不传则创建的协作空间没有分派策略。

group
object

告警聚合配置。不传时不聚合(method 为 n)。

flapping
object

抖动检测配置。不传时使用默认值。

auto_resolve_timeout
integer<int64>

自动恢复超时,单位秒。0 表示不自动恢复,最长 30 天。

必填范围: 0 <= x <= 2592000
auto_resolve_mode
enum<string>

自动恢复的计时方式。trigger(默认)在故障触发时开始计时,只计一次;update 每当有新告警并入故障时重新计时。

可用选项:
trigger,
update
plugin_ids
integer<int64>[]

集成类型 ID(即 POST /integration/list 返回的集成上的 plugin_id)。每个 ID 会创建一个该类型的协作空间专属集成,名称为该类型名称。ID 不存在时返回 InvalidParameter。单次请求最多 50 项,更多请分多次调用。重复的值会被忽略。

Maximum array length: 50
is_private
boolean

为 true 时仅管理团队可见。

disable_outlier_detection
boolean

禁用新奇故障检测。

disable_auto_close
boolean

禁用故障自动关闭。

is_external_report_enabled
boolean

为 true 时允许外部上报人向该协作空间提交故障,响应中返回生成的 external_report_token。

event_group
object

告警事件合并配置。不传时使用默认配置(启用合并,窗口 1440 分钟)。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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