查看数据库列表

列出你可以访问的数据库。使用响应中的数据库名称查看其中的表和视图。

POST https://api.moi.matrixorigin.cn/v5/meta/db/info

调用前准备

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

调用示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/meta/db/info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

此调用没有请求体、路径参数或查询参数。

成功响应

{"code": 200, "data": {"result": [{"db_name": "sales", "display_name": "销售数据"}], "total": 1}}

字段

类型

说明

code

integer

成功时为 200

data

object

数据库列表。

下面表格展开响应示例中的 data 对象;每一行是该对象的一个字段。

字段

类型

说明

result

array of object

当前身份可读取的数据库列表。

total

integer

返回的数据库数量。

下面表格展开响应示例中 data 下的 result 列表;每一行是列表中一个数据库对象的字段。

字段

类型

说明

db_name

string

数据库名称。

display_name

string

显示名称。

响应只包含当前身份可访问的数据库。选择 result 列表中数据库的 db_name 后,使用查看数据库中的表和视图列表继续查看对象。

错误响应

{"code": 503, "message": "服务暂不可用"}

字段

类型

说明

code

integer

错误状态码。

message

string

错误信息。

后续操作

查看数据库中的表和视图列表

最后更新于