跳转到主要内容
POST
创建专属集成

限制说明

使用说明

  • 这些接口管理协作空间专属集成;公共集成使用 /integration/*。
  • App Key 的接口授权范围(api_scopes)须允许本次操作;权限按 App Key 所属用户判断。
  • 您还须拥有目标空间的管理权限:账户所有者、Admin、空间创建者,或管理团队成员。未设置管理团队时,按所属团队判断。
  • 创建过这条集成不单独授予空间管理权限;集成中心管理权限也不授予本接口访问权。
  • 目标空间必须已启用;集成类型须已启用、属于 event.alert,且您的订阅支持该类型。
  • 已知 plugin_type 时可直接创建,无需先查询类型。也可选用 POST /integration/type/list 查询告警类型;该接口支持协作空间查看、管理或集成中心查看权限,App Key 的 api_scopes 还须允许 integration.api:read:typeList。
  • 省略 name 时使用集成类型的默认名称;省略 integration_key 时自动生成。自带 Key 须为 35 个字符、匹配账户后缀,且未被其他集成使用。
  • 成功后返回 integration_id 和 integration_key;后续操作使用返回的 integration_id。
  • 每次调用均记录到账户审计日志。
  • 同一空间的集成正在变更时返回 RequestLocked,请稍后重试。

授权

app_key
string
query
必填

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

请求体

application/json

在已启用的协作空间创建专属集成。

channel_id
integer<int64>
必填

目标协作空间 ID,空间须已启用。

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

20001

plugin_type
string
必填

已启用的告警集成类型标识,例如 standard.alert。

name

集成名称,提供时为 2–49 个字符;省略或为空时使用集成类型的默认名称。

description
string

集成描述,最多 499 个字符。

Maximum string length: 499
integration_key

可选的自带集成 Key;非空时须为 35 个字符、匹配账户后缀,且未被其他集成使用。

settings
object

集成类型对应的配置;响应中已保存的密钥类值以 ****** 返回。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

创建完成的专属集成及其接入 Key。