下载执行结果

将一条已成功完成的 SQL 查询结果下载为 CSV 文件。

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

调用前准备

  1. 准备有目标工作区访问权限的个人访问令牌目标工作区 ID

  2. 查看执行状态,确认查询已成功,并记录响应中的结果 ID(statement_id)。

请求体

$AI_STUDIO_API_KEY$WORKSPACE_ID$STATEMENT_ID 替换为实际值。

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

参数

类型

是否必填

说明

statement_id

string

成功执行查看的结果 ID。

成功响应

成功时返回 CSV 文件,而不是 JSON。请求示例会将文件保存为 result.csv

响应 Header 中包含实际文件名和文件大小:

响应部分

说明

响应体

CSV 文件内容

完整查询结果。

Content-Type

text/csv; charset=utf-8

响应体的媒体类型和字符集。

Content-Disposition

attachment; filename*=UTF-8’’query-result-20260824-175552.csv

建议使用的下载文件名;时间部分由服务端生成。

Content-Length

文件字节数

CSV 文件大小。

错误响应

失败时响应为 JSON。

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

字段

类型

说明

code

integer

错误状态码。

message

string

错误信息。

后续操作

需要按页读取时,使用查看执行结果

最后更新于