查看表概览¶

列出指定数据库中的表及各表列名。

POST https://moi.matrixorigin.cn/newmoi/catalog/table/overview

调用前准备¶

先查询数据库列表取得数据库 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和数据库 ID。

请求体¶

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/table/overview" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "id": '"$DATABASE_ID"'
  }'

参数说明

请求体

字段	类型	必填	说明
`id`	integer	是	数据库 ID。

成功响应¶

成功时返回 200 和表概览。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "tables": [
      {
        "name": "orders",
        "columns": ["id", "amount"]
      }
    ]
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。

表概览

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

字段	类型	说明
`tables`	object（对象数组）	数据库中的表概览。

表

下面表格展开响应示例中 data.tables 数组的每一项；每一行是该数组项的一个字段。

字段	类型	说明
`name`	string	表名称。
`columns`	string（字符串数组）	表的列名列表。

错误响应¶

响应示例

{
  "code": "ErrServer",
  "msg": "服务器内部错误",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误信息。
`data`	null	错误响应中的附加数据；本示例为 `null`。

最后更新于 2026 年 9 月 1 日