查看连接器列表

列出当前工作区中你有读取权限的连接器。先通过此接口找到连接器 ID，再查看详情、更新、删除或创建数据任务。

GET https://moi.matrixorigin.cn/newmoi/connectors/list

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

查询参数

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和查询参数替换为实际值。

调用示例

分页

curl "https://moi.matrixorigin.cn/newmoi/connectors/list?page=1&page_size=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

按单个条件筛选

将筛选条件替换为实际值。

curl 'https://moi.matrixorigin.cn/newmoi/connectors/list?keyword=orders&source_type=5&status=active&usage_type=1&order_by=name&is_desc=false' \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

按多个类型或状态筛选

需要匹配多个数据源类型或状态时，使用对应的列表参数。

curl 'https://moi.matrixorigin.cn/newmoi/connectors/list?source_type_list=5&source_type_list=7&status_list=active&status_list=failed' \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

读取下一页

curl "https://moi.matrixorigin.cn/newmoi/connectors/list?page=2&page_size=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

分页

参数	类型	是否必填	说明
page	integer	否	要读取第几页。从 1 开始；省略时读取第 1 页。
page_size	integer	否	每页返回多少条连接器；省略时每页返回 20 条。

按单个条件筛选

参数	类型	是否必填	说明
keyword	string	否	只返回名称或创建者名称中包含该文本的连接器。
source_type	integer	否	单个数据源类型筛选条件；标准 S3 为 5。
status	string	否	单个连接器状态筛选条件。
usage_type	array of integer	否	连接器用途筛选条件；同一参数可重复传入。1 仅导入，2 仅导出。
order_by	string	否	排序依据：name、source_type、status、created_at 或 updated_at。省略或其他值时，按创建时间从新到旧返回。
is_desc	boolean	否	true 时按降序排列；false 时按升序排列。

按多个类型或状态筛选

参数	类型	是否必填	说明
source_type_list	array of integer	否	多个数据源类型的筛选条件。
status_list	array of string	否	多个连接器状态的筛选条件。

读取下一页

参数	类型	是否必填	说明
page	integer	否	下一页页码。首次请求用 1，之后每次加 1，直到已读数量达到 data.total。
page_size	integer	否	每页返回多少条连接器。

成功响应

响应示例

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

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.connectors	array of object	当前筛选条件下的连接器。
data.connectors.id	string	连接器 ID。
data.connectors.name	string	连接器名称。
data.connectors.source_type	integer	数据源类型代码。
data.connectors.created_at	integer	创建时间的 Unix 时间戳。
data.connectors.updated_at	integer	更新时间的 Unix 时间戳。
data.connectors.status	string	连接器当前状态。
data.connectors.username	string	创建该连接器的用户名称。
data.connectors.related_task_ids	array of string	关联导入任务 ID 列表。
data.connectors.usage_type	array of integer	已保存的连接器用途。参见指定用途。
data.connectors.config	object	已保存的连接信息。参见按数据源填写连接信息。
data.total	integer	匹配条件的连接器总数。

错误响应

响应示例

{
  "code": "ErrForbidden",
  "msg": "permission denied",
  "data": null
}

字段说明

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

后续操作

保存目标连接器的 id，再查看连接器详情。要浏览文件时查看文件列表。

最后更新于 2026 年 9 月 3 日