# 查询连接器服务目录

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

读取智能体资源中心的连接器服务及当前配置标志。该目录包含搜索、监控、集群和邮箱服务，不是数据连接器实例列表。

```text
GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/connector-catalog
```

## 调用前准备

按[AI Studio](../../../../../developer/api/ai-studio/index.md)取得当前环境的个人访问令牌和工作区ID。当前有效角色须获准执行相应操作。

## 查询参数

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl --get "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/connector-catalog" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

:::::
:::::{tab-item} 参数说明

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 当前环境的目标工作区ID，与请求头一致。 |
| `X-Workspace-ID` | string | 是 | 当前环境的工作区ID。 |
| `X-API-Key` | string | 是 | 当前环境的个人访问令牌。 |

无分页、名称或provider筛选参数。示例的八个configured均为false，仅表示示例工作区尚无启用配置。

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": 0,
  "data": {
    "items": [
      {
        "provider": "bocha",
        "name": "博查 Web Search",
        "description": "配置博查 API Key 后使用网页搜索。",
        "configured": false
      },
      {
        "provider": "tavily",
        "name": "Tavily Web Search",
        "description": "配置 Tavily API Key 后使用网页搜索。",
        "configured": false
      },
      {
        "provider": "brave",
        "name": "Brave Search",
        "description": "配置 Brave Search Subscription Token 后使用网页搜索。",
        "configured": false
      },
      {
        "provider": "deepseek",
        "name": "DeepSeek",
        "description": "配置工作区 DeepSeek Search/Fetch 服务后搜索和获取公开网页。",
        "configured": false
      },
      {
        "provider": "grafana",
        "name": "Grafana",
        "description": "Grafana 健康状态、数据源、Prometheus 和 Loki 查询能力。",
        "configured": false
      },
      {
        "provider": "kubernetes",
        "name": "Kubernetes",
        "description": "Kubernetes Namespace、Node、Pod、Deployment、Service 和 Event 读取能力。",
        "configured": false
      },
      {
        "provider": "mail",
        "name": "标准邮箱",
        "description": "通过标准 IMAP/SMTP 收取和发送邮件。",
        "configured": false
      },
      {
        "provider": "qq_mail",
        "name": "QQ 邮箱",
        "description": "通过 IMAP/SMTP 连接 QQ 邮箱，读取、搜索邮件并查看附件。",
        "configured": false
      }
    ]
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功为0。 |
| `data.items` | object（对象数组） | 当前目录条目；接口不分页。 |
| `data.items[].provider` | string | 服务提供方标识，用于后续选择连接器。 |
| `data.items[].name` | string | 按当前语言返回的服务名称。 |
| `data.items[].description` | string | 按当前语言返回的服务说明。 |
| `data.items[].configured` | boolean | 当前工作区存在该provider的active/channel配置时为true；不是连通测试结果。 |

:::::
::::::
:::::::

## 错误响应

| HTTP / code | 条件与处理 |
| --- | --- |
| 400 / 2 | 工作区标识无效等参数错误。 |
| 403 / 5 | 当前授权拒绝。 |
| 503 / 15 | 连接器或授权依赖不可用。 |

认证阶段还可返回字符串code/msg；具体说明见[错误与环境](errors-environments.md)。
