查看执行结果¶

读取一条已成功完成的 SQL 查询的结果行。需要下载完整结果时，请使用下载执行结果。

POST https://api.moi.matrixorigin.cn/v5/query/result

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
查看执行状态，确认查询已成功，并记录响应中的结果 ID（statement_id）。

只能读取当前身份创建且已成功完成的查询结果。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $STATEMENT_ID 替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/query/result" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{\"statement_id\": \"$STATEMENT_ID\", \"offset\": 0, \"limit\": 20}"

参数说明

参数	类型	是否必填	说明
`statement_id`	string	是	成功执行查看的结果 ID。
`offset`	integer	否	开始读取的行位置，从 0 开始。
`limit`	integer	否	本次最多返回的行数；未提供或小于等于 0 时，服务端使用 1000。

成功响应¶

每一行结果按列定义的顺序排列。单元格中的 Valid 为 false 时，该值为 NULL。

响应示例

{
  "code": 200,
  "data": {
    "query_id": "query_01",
    "db_name": "sales",
    "statement_id": "statement_01",
    "status": "success",
    "offset": 0,
    "limit": 20,
    "total": 1,
    "columns": [
      {
        "name": "n",
        "type": "INT64"
      }
    ],
    "result": [
      [{"String": "1", "Valid": true}]
    ]
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 200。
data	object	查询结果。

查询结果

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

字段	类型	说明
query_id	string	产生结果的查询 ID。
db_name	string	执行时指定的数据库。
statement_id	string	本次结果的 Statement ID。
status	string	成功读取结果时为 success。
offset	integer	本次开始读取的行位置。
limit	integer	本次请求的最大返回行数。
total	integer	本次实际返回的行数。
columns	array of object	返回列定义，排列顺序与每行结果中的单元格顺序一致。
result	array	查询结果的二维数组。

列定义

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

字段	类型	说明
name	string	列名。
type	string	数据库返回的列类型。

结果单元格

result 中的每项是一行结果；每一行按 columns 的顺序包含单元格。

字段	类型	说明
String	string	单元格的字符串值。
Valid	boolean	是否为非 `NULL` 值。

读取下一段结果¶

首次请求的 offset 设为 0。继续读取时，将 offset 设为上一段的 offset + limit，并保持相同的 limit。

curl -X POST "https://api.moi.matrixorigin.cn/v5/query/result" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"statement_id\": \"$STATEMENT_ID\",
    \"offset\": 20,
    \"limit\": 20
  }"

当实际返回行数（total）小于本次请求的 limit 时，表示已读取到结果末尾。

错误响应¶

响应示例

{"code": 404, "message": "SQL 查询结果不存在"}

字段说明

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

后续操作¶

继续调整 offset 和 limit 读取后续行，或下载执行结果。

最后更新于 2026 年 9 月 9 日