预览表数据¶

预览表数据，不修改表内容。

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

调用前准备¶

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

下方示例使用：

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

请求体¶

表的定位方式与查询表信息一致：传入 id，或传入 name 和 database_id/database_name。

参数	类型	是否必填	说明
`id`	integer	条件必填	表 ID。提供后可不传名称。
`name`	string	条件必填	表名；未提供 `id` 时必填。
`database_id`	integer	条件必填	非系统数据库 ID；与 `database_name` 互斥。
`database_name`	string	条件必填	系统数据库名称；与 `database_id` 互斥。
`page`	integer	否	页码；未传或小于等于 `0` 时按第 `1` 页处理。
`page_size`	integer	否	每页条数；未传或小于等于 `0` 时使用 `100`。
`preview_lines`	integer	否	预览行数；传入正数时覆盖 `page_size` 并从第 `1` 页开始。
`include_total`	boolean	否	是否返回总行数；未传时返回。

请求示例¶

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

成功响应¶

成功时返回 200 和预览结果。返回字段与查询表数据一致。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "data": [
      ["1", "100.00"]
    ],
    "columns": [
      {
        "name": "id",
        "type": "INT"
      },
      {
        "name": "amount",
        "type": "DECIMAL"
      }
    ],
    "page": 1,
    "page_size": 100
  }
}

响应字段如下。

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.data`	array	行数据；每个内层数组按 `columns` 的顺序排列。
`data.columns`	array	列信息，每项包含 `name` 和 `type`。
`data.total_rows`	integer	表总行数；仅在请求 `include_total` 时返回。
`data.page`	integer	当前页码。
`data.page_size`	integer	每页行数上限。

错误响应¶

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

常见 HTTP 错误¶

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

后续操作¶

完成后查询 Catalog 详情确认结果。

最后更新于 2026 年 8 月 22 日