查看表信息¶

查询表的定义、建表 SQL 和统计等信息。

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

调用前准备¶

先查询数据库中的对象取得目标表 ID，或准备表名与数据库定位参数。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和表定位信息。

请求体¶

请求示例

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

参数说明

请求可按表 ID 查询，或按表名加数据库 ID/系统数据库名称查询。

请求体

字段	类型	必填	说明
`id`	integer条件必填	否	表 ID。提供后可不传名称。
`name`	string条件必填	否	表名；未提供 `id` 时必填。
`database_id`	integer条件必填	否	非系统数据库的数据库 ID；与 `database_name` 互斥。
`database_name`	string条件必填	否	系统数据库名称；与 `database_id` 互斥。
`include_stats`	boolean	否	是否返回列统计信息。

成功响应¶

成功时返回 200 和表信息。无读取权限时返回 403。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "name": "orders",
    "lines": 120,
    "size": 4096,
    "created_at": 1735689600,
    "updated_at": 1735689600,
    "created_by": "user@example.com",
    "description": "订单表",
    "comment": "订单明细",
    "columns": [
      {
        "name": "id",
        "type": "INT",
        "is_pk": true
      }
    ],
    "create_sql": "CREATE TABLE orders (id INT PRIMARY KEY)",
    "stats": [
      {
        "name": "id",
        "type": "INT",
        "max_value": "100",
        "min_value": "1"
      }
    ]
  }
}

字段说明

通用字段

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

表概览

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

字段	类型	说明
`name`	string	表名称。
`lines`	integer	表行数。
`size`	integer	表大小，单位为字节。
`created_at`	integer	创建时间的 Unix 时间戳（秒）。
`updated_at`	integer	更新时间的 Unix 时间戳（秒）。
`created_by`	string	创建者标识。
`description`	string	表描述。
`comment`	string	表注释。
`columns`	array of object	列定义。
`create_sql`	string	建表 SQL。
`stats`	array of object	列统计信息。

字段定义

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

字段	类型	说明
`name`	string	列名称。
`type`	string	列的数据类型。
`is_pk`	boolean	是否为主键列；有值时返回。
`comment`	string	列注释；有值时返回。
`precision`	array of integer	精度；有值时返回。
`default`	string	列默认值；有值时返回。

列统计

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

字段	类型	说明
`name`	string	列名称。
`type`	string	列的数据类型。
`is_pk`	boolean	是否为主键列；有值时返回。
`default`	string	列默认值；有值时返回。
`comment`	string	列注释；有值时返回。
`max_value`	string	列的最大值。
`min_value`	string	列的最小值。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "表定位参数无效",
  "data": null
}

字段说明

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

后续操作¶

需要修改时更新数据库。返回列表时查询文件产物。

最后更新于 2026 年 9 月 11 日