1. 接口描述
接口请求域名: workbuddyenterprise.tencentcloudapi.com 。
查询指定企业下的连接器列表(PageNumber/PageSize 分页,支持名称模糊与状态、来源过滤)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeConnectorList。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-09。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Filters.N | 否 | Array of Filter | 过滤条件数组,多个 Filter 之间为 AND 关系。支持 Name:Name(名称模糊匹配)/ Status(ACTIVE / DISABLED)/ Source(ENTERPRISE_AGENT / ASSISTANT) |
| PageNumber | 否 | Integer | 已废弃:服务端不再读取,请使用 Offset/Limit。字段保留仅为过渡兼容,后续下线 示例值:1 |
| PageSize | 否 | Integer | 已废弃:服务端不再读取,请使用 Offset/Limit。字段保留仅为过渡兼容,后续下线 示例值:20 |
| Offset | 否 | Integer | 偏移量,0 基准,缺省 0(标准 CAPI 分页参数) 示例值:0 |
| Limit | 否 | Integer | 每页数量,取值 1-100,缺省 20(标准 CAPI 分页参数) 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的连接器总数 示例值:1 |
| ConnectorSet | Array of ConnectorInfo | 连接器列表(分页后);连接器挂调用方主账号 UIN 下,不挂 OneID 企业 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询连接器列表
按名称模糊过滤并分页查询连接器列表,Offset/Limit 为标准分页参数
输入示例
POST / HTTP/1.1
Host: workbuddyenterprise.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConnectorList
<公共请求参数>
{
"Offset": 0,
"Limit": 20,
"Filters": [
{
"Name": "Name",
"Values": [
"notion"
]
}
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"ConnectorSet": [
{
"ConnectorId": "2087791755109965900",
"ConnectorSlug": "notion-k3x9m2",
"ConnectorKey": "notion-k3x9m2-v2",
"Name": "notion",
"Description": "接入企业 Notion",
"AvatarUrl": "https://example.com/icon.png",
"Source": "ENTERPRISE_AGENT",
"EnterpriseId": "100012345678",
"Type": "MCP_SERVER",
"ServiceUrl": "https://mcp.notion.internal/v2",
"AuthModes": [
"ONEID"
],
"LatestVersionNo": 2,
"Status": "ACTIVE",
"CreatorId": "100012345678",
"CreatedTime": "2026-08-26T09:10:03Z",
"ModifiedTime": "2026-08-26T11:20:44Z"
}
],
"RequestId": "3c6d138e-1234-5678-9abc-def012345678"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.IdentityNotFound | AuthFailure.IdentityNotFound |
| AuthFailure.IdentityResolutionFailed | AuthFailure.IdentityResolutionFailed |
| FailedOperation.EntitlementNotFound | FailedOperation.EntitlementNotFound |
| FailedOperation.IdentityServiceError | FailedOperation.IdentityServiceError |
| InternalError.EntitlementCheckFailed | InternalError.EntitlementCheckFailed |
| InternalError.MarshalFailed | InternalError.MarshalFailed |
| InternalError.NoResolver | InternalError.NoResolver |
| InternalError.Panic | InternalError.Panic |
| InternalError.ReadBodyFailed | InternalError.ReadBodyFailed |
| InternalError.ResolveEnterpriseFailed | InternalError.ResolveEnterpriseFailed |
| InternalError.TenantResolveFailed | InternalError.TenantResolveFailed |
| InternalError.Unknown | InternalError.Unknown |
| InvalidParameter.ActionNotFound | InvalidParameter.ActionNotFound |
| InvalidParameter.ActionRequired | InvalidParameter.ActionRequired |
| InvalidParameter.ConnectorRequest | InvalidParameter.ConnectorRequest |
| InvalidParameter.EmptyBody | InvalidParameter.EmptyBody |
| InvalidParameter.InvalidJSON | InvalidParameter.InvalidJSON |
| InvalidParameter.InvalidRequestBody | InvalidParameter.InvalidRequestBody |
| InvalidParameter.OneIDAccountRequired | InvalidParameter.OneIDAccountRequired |
| InvalidParameterValue.InvalidConnectorSource | InvalidParameterValue.InvalidConnectorSource |
| InvalidParameterValue.InvalidConnectorStatus | InvalidParameterValue.InvalidConnectorStatus |
| MissingParameter.UinRequired | MissingParameter.UinRequired |
| ResourceUnavailable.IdentityNotConfigured | ResourceUnavailable.IdentityNotConfigured |
| UnauthorizedOperation.NotConnectorOwner | UnauthorizedOperation.NotConnectorOwner |