查看连接器详情

根据连接器 ID 读取一个已保存连接器。用此接口确认当前名称、状态、用途和关联任务；更新或删除前也应先读取详情。

POST https://api.moi.matrixorigin.cn/v5/connectors/get

调用前准备

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID，以及列表或创建接口返回的连接器 ID。

请求体

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $CONNECTOR_ID 替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/get" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "'"$CONNECTOR_ID"'"
  }'

参数说明

参数	类型	是否必填	说明
id	string	是	连接器 ID。

成功响应

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": "conn_01",
    "name": "s3-orders-import",
    "source_type": 5,
    "created_at": 1735632000,
    "updated_at": 1735718400,
    "status": "active",
    "username": "user_01",
    "related_task_ids": [],
    "usage_type": [1],
    "config": {"s3": {"endpoint": "https://s3.example.com", "bucket_name": "orders", "region": "us-east-1"}}
  }
}

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data	object	已保存的连接器。
data.id	string	连接器 ID。
data.name	string	连接器名称。
data.source_type	integer	数据源类型代码。参见选择数据源和连接配置。
data.created_at	integer	创建时间的 Unix 时间戳。
data.updated_at	integer	更新时间的 Unix 时间戳。
data.status	string	连接器当前状态。
data.username	string	创建该连接器的用户名称。
data.related_task_ids	array of string	此接口当前返回空数组。关联导入任务 ID 请通过查看连接器列表获取。
data.usage_type	array of integer	已保存的连接器用途。参见指定用途。
data.config	object	已保存的连接信息。参见按数据源填写连接信息。

错误响应

响应示例

{
  "code": "ErrParam",
  "msg": "invalid parameter",
  "data": null
}

字段说明

字段	类型	说明
code	string	错误代码。
msg	string	可读错误信息。
data	null	错误响应中为 null。

后续操作

需要改配置时更新连接器。用途含导入且连接器支持文件列举时，可查看文件列表。

最后更新于 2026 年 9 月 6 日