查看数据库列表¶
列出指定连接器可读取的数据库。
POST https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/databases
调用前准备¶
准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。从查看可浏览的连接器列表选择 enabled 和 capabilities.list_databases 均为 true 的记录。
请求体¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$CONNECTOR_ID 和 $SOURCE_TYPE 替换为实际值。
curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/databases" \
-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\"}"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
已选择的连接器 ID。 |
|
string |
是 |
同一连接器记录的来源类型。 |
成功响应¶
{"code": "OK", "msg": "OK", "data": {"databases": [{"name": "appdb", "display_name": "appdb"}], "endpoint_results": []}}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
array of object |
数据库列表。 |
|
string |
数据库名称。 |
|
string |
用于显示的数据库名称。 |
|
array of JSON |
预留结果集。 |
错误响应¶
{"code": "ErrParamInvalid", "msg": "invalid parameter", "data": null}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
|
null |
错误响应中为 |
后续操作¶
使用选中项的 name:支持 Schema 层级时查看 Schema 列表,否则查看表和集合列表。
最后更新于