Skip to main content
数据导入

新增连接器

创建新的数据连接器,用于管理数据导入来源。

前提

已获取阿里云百炼 API Key(控制台 API Key 页面)并完成鉴权配置,详见 RAG API 概览与鉴权。数据导入接口与其他 RAG API 使用相同的 Base URL 与鉴权方式,路径前缀为 /api/v1/connector/dash/。

接口

POST /api/v1/connector/dash/addConnector 创建新的数据连接器,用于管理数据导入来源。
当前 connectorType 仅支持 FILE 类型。storeType 为 CUSTOM 时需要额外传入 regionId 和 bucketName。

请求体

字段必填类型说明
connectorType是string连接器类型,当前仅支持 FILE。
connectorName是string连接器名称,长度 1~20 个字符。
description是string连接器描述信息,长度 1~200 个字符。
fileConnectorConfig是object文件连接器配置。子字段 storeType(string,必填,存储类型:PLATFORM(平台托管)或 CUSTOM(自定义 OSS))、regionId(string,OSS 地域 ID,当 storeType 为 CUSTOM 时需要)、bucketName(string,OSS Bucket 名称,当 storeType 为 CUSTOM 时需要)。

请求示例

curl -X POST "$BASE_URL/api/v1/connector/dash/addConnector" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorType": "FILE",
    "connectorName": "产品文档连接器",
    "description": "用于导入产品文档的文件连接器",
    "fileConnectorConfig": {
      "storeType": "PLATFORM"
    }
  }'
其中 BASE_URL 为 https://{workspace_id}.cn-beijing.maas.aliyuncs.com({workspace_id} 为业务空间 ID),BAILIAN_API_KEY 为阿里云百炼 API Key。

响应示例

成功返回 200。
{
  "code": "Success",
  "status_code": 200,
  "data": {
    "connectorId": "conn_abc123"
  },
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

响应字段

字段类型说明
codestring响应码,成功时为 Success。
messagestring错误或提示信息,成功时为空字符串。
requestIdstring请求唯一标识,排查问题时请提供此 ID。
dataobject创建结果。子字段 connectorId(string,新创建的连接器 ID)。
statusinteger业务状态码。成功为 200,参数错误等失败场景为 400。注意失败时 HTTP 状态码仍为 200,需根据本字段与 code 判断结果。

错误码

HTTP 状态码错误码 code说明
400InvalidParameter请求参数无效。message 示例:Required parameter missing or invalid.
401InvalidApiKey鉴权失败,API Key 无效或缺失。message 示例:Invalid API-key provided.
业务失败时 HTTP 状态码仍为 200,需根据响应体中的 status 与 code 判断结果。
Managed Agents
Sandbox
Security
应用调用
长期记忆
ParseX
框架