查看表数据¶

读取表的抽样数据。未显式指定行数时，服务默认返回 100 行。

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

调用前准备¶

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

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/table/data" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$TABLE_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	否	页码，默认 `1`。
`page_size`	integer	否	每页行数，默认 `100`。
`preview_lines`	integer	否	预览行数。
`include_total`	boolean	否	是否返回总行数；未传时返回。

成功响应¶

成功时返回 200 和抽样结果。无读取权限时返回 403。

响应示例

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

字段说明

通用字段

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

查询结果

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

字段	类型	说明
`data`	array	行数据；每个内层数组按 `columns` 的顺序排列。
`columns`	array of object	列信息。
`total_rows`	integer	表总行数；仅在请求 `include_total` 时返回。
`page`	integer	当前页码。
`page_size`	integer	当前页的行数上限。

列信息

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

字段	类型	说明
`name`	string	列名称。
`type`	string	列的数据类型。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

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

最后更新于 2026 年 9 月 8 日