Skip to main content
数据导入

查询连接器

查询指定连接器的详细信息。可通过连接器 ID 或名称查询,至少传入其中一个参数。

前提

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

接口

POST /api/v1/connector/dash/getConnector 查询指定连接器的详细信息。可通过连接器 ID 或名称查询,至少传入其中一个参数。
connectorId 和 connectorName 至少需要传入一个。两者都传入时,以 connectorId 为准。

请求体

字段必填类型说明
connectorId否string连接器 ID,与 connectorName 至少传入一个。
connectorName否string连接器名称,与 connectorId 至少传入一个,最长 20 个字符。

请求示例

curl -X POST "$BASE_URL/api/v1/connector/dash/getConnector" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorId": "conn_abc123"
  }'
其中 BASE_URL 为 https://{workspace_id}.cn-beijing.maas.aliyuncs.com({workspace_id} 为业务空间 ID),BAILIAN_API_KEY 为阿里云百炼 API Key。

响应示例

成功返回 200。
{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "connectorId": "conn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
    "connectorName": "默认文件连接器",
    "connectorType": "FILE",
    "connectorSubType": "UNSTRUCTURED",
    "description": "默认文件类型连接器",
    "gmtCreate": "2026-03-16 16:13:26",
    "gmtModified": "2026-03-16 16:13:26"
  },
  "status": 200
}

响应字段

字段类型说明
codestring响应码,成功时为 Success。
messagestring错误或提示信息,成功时为空字符串。
requestIdstring请求唯一标识,排查问题时请提供此 ID。
dataobject连接器详情。子字段 connectorId(string,连接器 ID)、connectorType(string,连接器类型,当前仅支持 FILE)、connectorName(string,连接器名称)、description(string,连接器描述)、connectorSubType(string,连接器子类型,如 UNSTRUCTURED)、gmtCreate(string,创建时间,格式 YYYY-MM-DD HH:mm:ss)、gmtModified(string,最后修改时间,格式 YYYY-MM-DD HH:mm:ss)。
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
框架