跳转到主要内容
POST
创建公共集成

限制说明

使用说明

  • plugin_type 必须是 POST /integration/type/list 中 supports_api_create: true 的类型,否则返回 InvalidParameter。
  • status 为 disabled 的类型返回 InvalidParameter;当前套餐不包含的类型返回 NoLicense。
  • 这些接口仅管理公共(账户级)集成,不管理协作空间专属集成。
  • 不传 integration_key 时自动生成;传入时须满足长度、账户后缀与唯一性校验。
  • 传 is_test: true 时请检查 test.success,不能只根据 HTTP 200 判断插件测试成功。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

创建集成的请求体。

plugin_type
string
必填

集成类型,必须是 POST /integration/type/list 中 supports_api_create: true 的类型。

示例:

"standard.alert"

name
string

集成名称,非空时为 2–49 字符;不传或为空时使用集成类型名称。

Required string length: 2 - 49
示例:

"Prod metrics alerts"

description
string

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

Maximum string length: 499
team_id
integer<int64>

所属团队 ID;不传或传 0 表示不设置团队,非零 ID 必须属于当前账户。

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

1467226103121

settings
object

集成类型专属配置,可传字段取决于 plugin_type。

integration_key
string

可选预生成 Key,长度 35,末尾为账户 ID 对 1000 取余后补零至三位,且不能已被使用;不传时自动生成。

Required string length: 35
is_test
boolean

创建时执行插件测试;不传时为 false,测试结果查看返回的 test.success。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

创建结果与集成 Key。