Skip to main content

查询连接器接口

查询企业市场中的连接器资源，按关键词、状态、来源和分类筛选。返回资源标识、展示信息和修订号，可用于定位需要维护的连接器。

  • Scope：admin.v1.connectors.read
  • 权限项：连接器读取（connectors）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/connectors

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
keywordquerystring否搜索关键词"<string>"
statusquerystring否启用状态"draft"
originquerystring否归属"all"
category_idquerystring · uuid否分类（分类 ID）"<uuid>"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/connectors?keyword=<keyword>&status=<status>&origin=all&category_id=<category_id>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是连接器列表-
next_cursorstring否下一页游标"<string>"
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
total_pagesinteger · int64是总页数0
total_rowsinteger · int64是总条数0

items[] 字段

字段对应关系：server_key 是创建连接器时填写的唯一标识，编辑接口不支持修改；display_name、display_name_cn 分别对应创建、编辑接口的英文名称和中文名称。编辑时将 id 作为路径参数 resourceId，将 revision 作为请求字段 expected_revision。
字段类型必填说明
api_keyobject否API Key 配置
auth_typestring否授权方式
clientsarray<string> ｜ null是适用客户端
commandstring否启动命令
created_atstring · date-time否创建时间
created_bystring否创建人 ID
created_by_emailstring否创建人邮箱
created_by_namestring否创建人姓名
descriptionstring否描述（英文）
description_cnstring否描述
display_namestring否连接器名称（英文）
display_name_cnstring否连接器名称
icon_urlstring否资源图标（URL）
idstring是连接器 ID
oauth_client_registrationstring否OAuth 客户端注册配置
oauth_scopesstring否OAuth Scopes
originstring是归属
revisioninteger · int64是版本号，用于并发更新校验
server_keystring是唯一标识
source_typestring否来源类型；可选值：official
statusstring是启用状态
transportstring否传输协议
updated_atstring · date-time否更新时间
updated_bystring否更新人 ID
updated_by_emailstring否更新人邮箱
updated_by_namestring否更新人姓名
urlstring否服务地址
versionstring否版本

items[].api_key 字段

字段类型必填说明
header_namestring是传递 API Key 的请求头名称
value_prefixstring否API Key 值的前缀
{
  "items": [
    {
      "api_key": {
        "header_name": "<string>",
        "value_prefix": "<string>"
      },
      "auth_type": "<string>",
      "clients": [
        "<string>"
      ],
      "command": "<string>",
      "created_at": "2026-08-27T10:00:00Z",
      "created_by": "<string>",
      "created_by_email": "<string>",
      "created_by_name": "<string>",
      "description": "<string>",
      "description_cn": "<string>",
      "display_name": "<string>",
      "display_name_cn": "<string>",
      "icon_url": "<string>",
      "id": "<string>",
      "oauth_client_registration": "<string>",
      "oauth_scopes": "<string>",
      "origin": "<string>",
      "revision": 0,
      "server_key": "<string>",
      "source_type": "official",
      "status": "<string>",
      "transport": "<string>",
      "updated_at": "2026-08-27T10:00:00Z",
      "updated_by": "<string>",
      "updated_by_email": "<string>",
      "updated_by_name": "<string>",
      "url": "<string>",
      "version": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "page": 0,
  "page_size": 0,
  "total_pages": 0,
  "total_rows": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}