跳转到主要内容
POST
更新专属集成

限制说明

使用说明

  • 这些接口管理协作空间专属集成;公共集成使用 /integration/*。
  • App Key 的接口授权范围(api_scopes)须允许本次操作;权限按 App Key 所属用户判断。
  • 您还须拥有目标空间的管理权限:账户所有者、Admin、空间创建者,或管理团队成员。未设置管理团队时,按所属团队判断。
  • 创建过这条集成不单独授予空间管理权限;集成中心管理权限也不授予本接口访问权。
  • 返回完整 integration_key;settings 中已保存的密钥类值返回 ******。集成 Key 用于告警接入,与管理接口的 App Key 不同。
  • 仅更新传入的字段;省略或设为 null 时保留原值。description: "" 清空描述。
  • 传入 settings 时按该类型的配置规则保存;已脱敏或省略的密钥类字段保留原值。保留原密钥时,不能同时更改对应的目标地址。
  • 此接口不更改所属空间、集成类型或集成 Key。
  • 每次调用均记录到账户审计日志。
  • 同一空间的集成正在变更时返回 RequestLocked,请稍后重试。

授权

app_key
string
query
必填

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

请求体

application/json

专属集成的部分更新;省略或为 null 的字段保留原值。

integration_id
integer<int64>
必填

创建、列表或详情接口返回的专属集成 ID;不接受公共集成 ID。

必填范围: x >= 1
示例:

10001

name
string | null

新名称,2–49 个字符;省略或为 null 时保留原名称。

Required string length: 2 - 49
description
string | null

新描述,最多 499 个字符;空字符串清空,省略或为 null 时保留。

Maximum string length: 499
settings
object | null

按集成类型替换配置;省略或为 null 时保留,已脱敏或省略的密钥类字段保留原值。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

协作空间专属集成,包含完整集成 Key 和脱敏配置。