跳转到主要内容
POST
查询专属集成列表

限制说明

使用说明

  • 这些接口管理协作空间专属集成;公共集成使用 /integration/*。
  • App Key 的接口授权范围(api_scopes)须允许本次操作;权限按 App Key 所属用户判断。
  • 查看私有空间还要求您是账户所有者、Admin、空间创建者,或所属团队、管理团队的成员;公开空间仍需上述接口权限。
  • channel_id 必填;p 默认 1,limit 默认 100,最多 100。
  • plugin_type 和 status 各接受单个值。
  • 返回完整 integration_key;settings 中已保存的密钥类值返回 ******。集成 Key 用于告警接入,与管理接口的 App Key 不同。

授权

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

p
integer
默认值:1

页码,从 1 开始。

必填范围: x >= 1
limit
integer
默认值:100

每页条数,最多 100 条。

必填范围: 1 <= x <= 100
name
string

按集成名称过滤。

Maximum string length: 49
plugin_type
string

按单个集成类型过滤。

status
enum<string>

按状态过滤:enabled 表示接收告警,disabled 表示暂停接入。

可用选项:
enabled,
disabled

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

一页专属集成结果。