跳转到主要内容
POST
更新协作空间

限制说明

使用说明

  • 未传或为 null 的字段保持原值。group、flapping、event_group 一旦传入即整体替换原配置。
  • 传 managing_team_ids: [] 可清空管理团队。
  • auto_resolve_mode 只有与 auto_resolve_timeout 一起传入时才生效;只传 auto_resolve_timeout 时,模式会重置为 trigger。
  • 每次把 is_external_report_enabled 设为 true 都会生成新的 external_report_token,旧令牌随即失效;设为 false 会清空令牌。
  • channel_name 与其他协作空间重名时返回 InvalidParameter;group.method 为 p 或 i 但许可证不足时返回 NoLicense。
  • 调用者还必须拥有该协作空间的编辑权:账户所有者或管理员、协作空间创建者,或其管理团队成员(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 获取。

team_id
integer<int64> | null

新的所属团队 ID,可通过 POST /team/list 获取,必须存在。不传或传 null 保持原值。

managing_team_ids
integer<int64>[]

替换可管理该协作空间的其他团队,最多 3 个,每个 ID 都必须存在。传 [] 清空;不传保持原值。

Maximum array length: 3
channel_name
string | null

新的协作空间名称,1–59 个字符,账户内唯一。修改后的名称不能包含英文逗号,首尾不能有空白字符。不传或传 null 保持原值。

Required string length: 1 - 59
description
string | null

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

Maximum string length: 500
auto_resolve_timeout
integer<int64> | null

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

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

自动恢复的计时方式:trigger 在故障触发时开始计时,只计一次;update 每当有新告警并入时重新计时。只有与 auto_resolve_timeout 一起传入才生效;只传 auto_resolve_timeout 时模式重置为 trigger。

可用选项:
trigger,
update
is_private
boolean | null

为 true 时仅管理团队可见。

group
object

告警聚合配置;传入时整体替换原配置。

flapping
object

抖动检测配置;传入时整体替换原配置。

disable_outlier_detection
boolean | null

禁用新奇故障检测。

disable_auto_close
boolean | null

禁用故障自动关闭。

is_external_report_enabled
boolean | null

true 开启外部上报并生成新令牌,在响应中返回(旧令牌随即失效);false 关闭外部上报并清空令牌。

event_group
object

告警事件合并配置;传入时整体替换原配置。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

仅当请求中 is_external_report_enabled 为 true 时包含 external_report_token,否则 data 为空对象。