查询表概览¶

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

POST https://api.moi.matrixorigin.cn/v5/catalog/table/overview

调用前准备¶

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

请求体¶

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/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。

成功响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.tables`	object（对象数组）	数据库中的表概览。
`data.tables[].name`	string	表名称。
`data.tables[].columns`	string（字符串数组）	表的列名列表。

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误信息。

最后更新于 2026 年 10 月 19 日