查看 Schema 列表

列出指定数据库中的 Schema。

POST https://moi.matrixorigin.cn/newmoi/connectors/structured/v1/source/schemas

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。从查看可浏览的连接器列表选择 capabilities.list_schemas 为 true 的记录,再从查看数据库列表取得数据库名称。

请求体

将示例变量替换为实际值。

curl -X POST "https://moi.matrixorigin.cn/newmoi/connectors/structured/v1/source/schemas" -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\"}"

参数

类型

是否必填

说明

connector_id

string

连接器 ID。

source_type

string

来源类型。

database

string

数据库名称。

成功响应

{"code": "OK", "msg": "OK", "data": {"schemas": [{"name": "public", "display_name": "public"}], "endpoint_results": []}}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.schemas

array of object

Schema 列表。

data.schemas.name

string

Schema 名称。

data.schemas.display_name

string

用于显示的 Schema 名称。

data.endpoint_results

array of JSON

预留结果集。

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

错误响应中为 null

后续操作

使用选中项的 name 查看表和集合列表

最后更新于