查看表信息¶

查看表的字段定义和行数，不返回表中的数据行。

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

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
查看数据库，选择数据库名称。
查看数据库中的表和视图列表，选择表名称。

请求体¶

将示例中的调用者专属值替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/meta/table/info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"db_name\": \"$DATABASE\",
    \"table_name\": \"$TABLE\"
  }"

参数说明

参数	类型	是否必填	说明
`db_name`	string	是	表所在的数据库名称。
`table_name`	string	是	要查看的表名称。

成功响应¶

响应示例

{
  "code": 200,
  "data": {
    "columns": [{"name": "id", "data_type": "INT", "nullable": "NO", "default_value": "", "key_type": "PRI", "comment": ""}],
    "total": 1,
    "rows": 42
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 200。
data	object	表信息。

表信息

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

字段	类型	说明
columns	array of object	表的列定义列表。
total	integer	列数量。
rows	integer	表的行数，不返回数据行本身。

列信息

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

字段	类型	说明
name	string	列名称。
data_type	string	数据类型。
nullable	string	是否允许空值；YES 表示允许，NO 表示不允许。
default_value	string	默认值；未设置时为空字符串。
key_type	string	键类型。
comment	string	列备注。

需要只查看字段时，使用查看表字段列表；需要查看创建语句时，使用查看表或视图的创建语句。

错误响应¶

响应示例

{
  "code": 404,
  "message": "对象不存在"
}

字段说明

字段	类型	说明
`code`	integer 或 string	错误代码或状态码。
`message`	string	错误信息。

后续操作¶

查看表字段列表或查看表或视图的创建语句。

最后更新于 2026 年 9 月 11 日