查看表和集合列表¶

列出指定数据库中的可读取表或集合。

POST https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/objects

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。从查看可浏览的连接器列表选择 capabilities.list_tables 为 true 的记录，并从查看数据库列表取得数据库名称。支持 Schema 层级的来源还需从查看 Schema 列表取得 Schema 名称。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和示例中的来源标识替换为实际值。

输入示例

包含 Schema 的来源

curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/objects" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID" -H 'Content-Type: application/json' -d "{\"connector_id\": \"$CONNECTOR_ID\", \"source_type\": \"$SOURCE_TYPE\", \"database\": \"$DATABASE\", \"schema\": \"$SCHEMA\"}"

不包含 Schema 的来源

curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/objects" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d @- <<EOF
{
  "connector_id": "$CONNECTOR_ID",
  "source_type": "$SOURCE_TYPE",
  "database": "$DATABASE"
}
EOF

参数说明

包含 Schema 的来源

参数	类型	是否必填	说明
`connector_id`	string	是	连接器 ID。
`source_type`	string	是	来源类型。
`database`	string	是	数据库名称。
`schema`	string	否	Schema 名称。

不包含 Schema 的来源

参数	类型	是否必填	说明
`connector_id`	string	是	连接器 ID。
`source_type`	string	是	来源类型。
`database`	string	是	数据库名称。

成功响应¶

响应示例

默认

{"code": "OK", "msg": "OK", "data": {"objects": [{"database": "sales", "schema": "public", "table": "orders", "display_name": "orders", "object_kind": "table"}], "endpoint_results": []}}

集合响应

MongoDB 返回 collection，不返回 table。

{"code": "OK", "msg": "OK", "data": {"objects": [{"database": "sales", "schema": "", "collection": "orders", "display_name": "orders", "object_kind": "collection"}], "endpoint_results": []}}

字段说明

默认

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.objects`	array of object	表对象列表。
`data.objects.database`	string	对象所属数据库。
`data.objects.schema`	string	对象所属 Schema。
`data.objects.table`	string	表名称。
`data.objects.display_name`	string	用于显示的对象名称。
`data.objects.object_kind`	string	对象类型；本示例为 `table`。
`data.endpoint_results`	array of JSON	预留结果集。

集合响应

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.objects`	array of object	集合对象列表。
`data.objects.database`	string	对象所属数据库。
`data.objects.schema`	string	对象所属 Schema。
`data.objects.collection`	string	集合名称。
`data.objects.display_name`	string	用于显示的对象名称。
`data.objects.object_kind`	string	对象类型；本示例为 `collection`。
`data.endpoint_results`	array of JSON	预留结果集。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

选择一个对象，使用同一项的 database、可选 schema 和 table 或 collection 查看字段结构。

最后更新于 2026 年 9 月 28 日