查询表信息¶

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

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

调用前准备¶

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

下方示例使用：

$AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。
$WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。
$TABLE_ID：要查询的表 ID。

请求体¶

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

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

请求示例¶

curl -X POST "https://moi.matrixorigin.cn/newmoi/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"'
  }'

成功响应¶

成功时返回 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	表名称。
`data.lines`	integer	表行数。
`data.size`	integer	表大小，单位为字节。
`data.created_at`	integer	创建时间的 Unix 时间戳（秒）。
`data.updated_at`	integer	更新时间的 Unix 时间戳（秒）。
`data.created_by`	string	创建者标识。
`data.description`	string	表描述。
`data.comment`	string	表注释。
`data.columns`	array	列定义。每项包含 `name`、`type`，并可能包含 `is_pk`、`comment`、`precision`、`default`。
`data.create_sql`	string	建表 SQL。
`data.stats`	array	列统计信息；每项包含列名、类型、主键标识、默认值、注释以及最大、最小值。

错误响应¶

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

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
`400`	`ErrParamInvalid`	未提供有效的表定位方式，或同时传入 `database_id` 与 `database_name`。	使用表 ID，或仅使用一种名称定位方式。
`403`	`ErrForbidden`	当前身份没有表读取权限。	检查工作区和表授权。
`409`	`ErrReadonlySystemDatabase`	系统数据库不支持当前读取路径。	改用支持的表定位方式。
`500`	`ErrServer`	服务无法读取表信息。	记录请求时间和错误信息后重试；持续失败时联系支持人员。

后续操作¶

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

最后更新于 2026 年 8 月 22 日