帮你快速理解、总结文档立即下载

列出连接器

最近更新时间:2026-10-29 18:19:30
我的收藏

接口描述

查询控制台连接器目录(官方 / 企业 / 个人三种范围)。
GET /v2/enterprises/{enterpriseId}/managedagent/connectors

输入参数

路径参数

参数
类型
说明
enterpriseId
string
WorkBuddy 企业 ID

查询参数

参数
类型
说明
page
integer
页码,从 1 开始,缺省 1
pageSize
integer
每页条数,缺省 20,上限 100
name
string
按名称过滤(模糊匹配)
status
string
按状态过滤
source
string
按来源过滤

请求体

无(GET / DELETE 不带请求体,条件走路径与查询参数)

输出参数

(200,业务出参包装在 code / data / msg / requestId 中)
DescribeConsoleConnectorListResponse console 老连接器目录响应。
字段
类型
说明
totalCount
integer
TotalCount 符合条件的连接器总数(过滤后、分页前)。
connectorSet
ConnectorSet 当前页的连接器列表。

示例

输入示例

GET /v2/enterprises/{enterpriseId}/managedagent/connectors?page=1&pageSize=20
Authorization: Bearer pt_<YOUR_APP_KEY>

输出示例

{
"code": 0,
"data": {
"connectorSet": [
{
"authHeaderName": "数据分析助手",
"authInjectType": "string",
"authModes": [
"NONE"
],
"authValuePrefix": "string",
"avatarUrl": "https://example.com/avatar/agent-001.png",
"bindable": false,
"connectorId": "1200345678901234567",
"connectorKey": "string",
"connectorSlug": "string",
"createdTime": "2026-10-20T09:30:00Z",
"creatorId": "<REDACTED_USER>",
"description": "负责每日数据汇总",
"displayName": "数据分析助手",
"enterpriseId": "1200345678901234567",
"headerMappings": [
{
"sourceKey": "string",
"targetHeader": "string"
}
],
"latestVersionNo": 1,
"mirrorExists": false,
"modifiedTime": "2026-10-20T09:30:00Z",
"name": "数据分析助手",
"serviceUrl": "https://example.com/download/pkg-001.zip",
"source": "ENTERPRISE_AGENT",
"status": "ACTIVE",
"type": "MCP_SERVER",
"unbindableReason": "string",
"vpcConfigId": "1200345678901234567"
}
],
"totalCount": 1
},
"msg": "OK",
"requestId": "3c6d138e-1234-5678-9abc-def012345678"
}

错误码

说明:
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见错误响应与公共错误码。
错误码
说明
FailedOperation.ConsoleConnectorQuery
查询控制台连接器目录失败
InvalidParameter.InvalidRequestBody
请求体不合法
InvalidParameterValue.InvalidConnectorStatus
Status 只能是 ACTIVE / DISABLED
InvalidParameterValue.InvalidConsoleConnectorScope
Scope 只能是 official / enterprise / personal
InvalidParameterValue.OffsetNotMultipleOfLimit
Offset 必须是 Limit 的整数倍(如 Limit=20 时取 0 / 20 / 40 …)
MissingParameter.UinRequired
公共参数中缺少 Uin
ResourceUnavailable.AgentServerNotConfigured
未配置 agentserver registry 客户端