跳转到主要内容
POST
查询集成类型列表

限制说明

使用说明

  • 公共集成和专属集成共用此类型目录,不返回已配置的集成实例、配置或 Key。
  • App Key 的 api_scopes 须允许 integration.api:read:typeList;channel.integration 范围不包含此接口。
  • 不传 orderby 时按控制台排序返回,此时 p/limit 依然生效。
  • supports_api_create 表示该类型能否通过 POST /integration/create 创建。
  • category 取值不做校验,未知值会返回空列表。

授权

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
默认值:20

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

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

排序字段;不传时按控制台排序返回。

可用选项:
id,
created_at,
updated_at,
name,
type
category
string

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

asc
boolean | null
默认值:true

true(默认)升序,false 降序。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

集成类型列表的一页。