更新连接器接口

修改连接器的展示名称、说明、图标、客户端范围、状态或市场分类。当前请求模型不接受服务 URL、启动命令或认证凭据;资源和市场条目分别使用对应的预期修订号。

所需权限

所需权限资源Scope资源服务
连接器管理(管理)connectorsadmin.v1.connectors.manageqwenwork-biz-service

PATCH /api/openapi/v1/connectors/{resourceId}

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
resourceIdpathstring · uuid必填需要操作的资源标识。"<uuid>"
category_idbodystring资源所属分类的标识。"<string>"
clear_categorybodyboolean是否清除资源当前的分类归属。false
clientsbodyarray | null可使用此资源的客户端类型列表。["<string>"]
descriptionbodystring此对象的说明,用于补充名称之外的信息。"<string>"
description_cnbodystring资源的中文说明。"<string>"
display_namebodystring资源对外展示的名称。"<string>"
display_name_cnbodystring资源对外展示的中文名称。"<string>"
expected_market_item_revisionbodyinteger · int64企业市场条目的预期修订号,用于校验分类等市场信息的并发修改。0
expected_revisionbodyinteger · int64上次读取该对象时取得的修订号,用于防止覆盖其他调用方的修改。0
icon_upload_idbodystring已上传图标文件的标识。"<string>"
icon_urlbodystring资源图标的访问地址。"<string>"
statusbodystring此记录当前所处的状态。"<string>"

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request PATCH --url '<BASE_URL>/api/openapi/v1/connectors/<resourceId>' --header 'Authorization: Bearer <API_KEY>' --header 'Content-Type: application/json' --data '{  "category_id": "<string>",  "clear_category": false,  "clients": ["<string>"  ],  "description": "<string>",  "description_cn": "<string>",  "display_name": "<string>",  "display_name_cn": "<string>",  "expected_market_item_revision": 0,  "expected_revision": 0,  "icon_upload_id": "<string>",  "icon_url": "<string>",  "status": "<string>"}'

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
api_keyOpenapifacadeConnectorAPIKeyConfig连接器 API Key 的传递格式配置,不包含密钥本身。{"header_name":"<string>","value_prefix":"<string>"}
api_key.header_namestring发送连接器 API Key 时使用的请求头名称。 最少字符数:1。 最多字符数:128。"<string>"
api_key.value_prefixstring放在连接器 API Key 前的请求头值前缀。 最多字符数:128。"<string>"
auth_typestring连接器使用的认证方式。"<string>"
clientsarray | null可使用此资源的客户端类型列表。["<string>"]
commandstring启动连接器服务的命令。"<string>"
created_atstring · date-time此记录的创建时间。"2026-08-27T10:00:00Z"
descriptionstring此对象的说明,用于补充名称之外的信息。"<string>"
description_cnstring资源的中文说明。"<string>"
display_namestring资源对外展示的名称。"<string>"
display_name_cnstring资源对外展示的中文名称。"<string>"
icon_urlstring资源图标的访问地址。"<string>"
idstring此记录的唯一标识,查询、更新或删除对应记录时使用。"<string>"
oauth_client_registrationstring连接器 OAuth 客户端的注册方式。"<string>"
oauth_scopesstring连接器 OAuth 认证申请的权限范围。"<string>"
originstring资源的来源类型,用于区分资源归属。"<string>"
revisioninteger · int64当前记录的修订号,后续更新时用于校验并发修改。0
server_keystring用于识别连接器服务的键。"<string>"
source_typestring资源来源的具体类型。 可选值:official。"official"
statusstring此记录当前所处的状态。"<string>"
transportstring连接器使用的传输方式。"<string>"
updated_atstring · date-time此记录最后一次更新的时间。"2026-08-27T10:00:00Z"
urlstring连接器服务的访问地址。"<string>"
versionstring资源包的版本标识。"<string>"
{
  "api_key": {
    "header_name": "<string>",
    "value_prefix": "<string>"
  },
  "auth_type": "<string>",
  "clients": [
    "<string>"
  ],
  "command": "<string>",
  "created_at": "2026-08-27T10:00:00Z",
  "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",
  "url": "<string>",
  "version": "<string>"
}

default 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}