跳转到主要内容
POST
查询公共集成列表

限制说明

使用说明

  • orderby 默认 created_at;plugin_type 按底层插件排序。结果先按 ref_id 升序排列,orderby 在相同 ref_id 内生效。
  • plugin_type、status、category 支持逗号分隔多值;ref_ids 每个值必须以 c_、a_ 或 w_ 开头;c_ 过滤值通过格式校验,但不会返回协作空间专属集成。
  • 传入 is_my_team 时仅返回你所在团队的集成,team_ids 会在该范围内进一步收窄;你不属于任何团队,或 team_ids 与你的团队没有交集时,返回空列表。
  • 这些接口仅管理公共(账户级)集成,不管理协作空间专属集成。
  • 列表项包含 settings、integration_key、plugin_id、account_id 及旧 ID 别名 data_source_id。settings 中已保存的密钥类值返回 ******,integration_key 按原值返回。

授权

app_key
string
query
必填

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

请求体

application/json

查询集成列表的过滤参数。

p
integer
默认值:1

页码,从 1 开始。

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

每页条数,默认 100,最大 100。

必填范围: 1 <= x <= 100
orderby
enum<string>

排序字段,默认 created_at;plugin_type 按底层插件排序。

可用选项:
created_at,
updated_at,
name,
plugin_type,
status
category
string

按大类过滤,多个值用逗号分隔。取值:event.alert(告警事件)、event.change(变更事件)、im(IM 机器人)、webhook(自定义 Webhook)。未知值不会报错,但匹配不到结果。

type
string

已弃用,等同于 plugin_type(逗号分隔的类型标识,如 prometheus.alert、zabbix.alert)。同时传入 plugin_type 时忽略本字段。

plugin_type
string

按集成类型过滤,多个值用逗号分隔,如 standard.alert,prometheus.alert;取值为 POST /integration/type/list 返回的 plugin_type。

status
string

按状态过滤,多个值用逗号分隔:enabled(接收事件)、disabled(已暂停)。

name
string

按集成名称过滤,名称包含该文本即匹配。

ref_ids
string[]

按来源引用 ID 过滤;每个值必须以 c_(协作空间)、a_(账户)或 w_ 开头。

asc
boolean

true 升序,false 降序。

is_my_team
boolean

仅返回你所在团队拥有的集成。

team_ids
integer<int64>[]

按团队 ID 过滤;与 is_my_team 同时使用时在其结果内进一步收窄。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

集成列表的一页。