查看 SQL 工作簿版本列表¶

列出一个 SQL 工作簿的所有版本。选择版本后，可以查看内容、修改草稿或定稿版本。

POST https://api.moi.matrixorigin.cn/v5/workbook/version/list

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
查看 SQL 工作簿列表，选择并记录工作簿 ID。

请求体¶

将示例中的调用者专属值替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/workbook/version/list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"workbook_id\": \"$WORKBOOK_ID\",
    \"page_size\": 20
  }"

参数说明

参数	类型	是否必填	说明
`workbook_id`	string	是	SQL 工作簿的 ID。
`page_size`	integer	否	每页数量，范围 1 至 100；不传时为 20。
`page_token`	string	否	下一页标记。

成功响应¶

响应返回版本列表。状态为 draft 的版本可以修改或定稿；状态为 finalize 的版本只读。

响应示例

{
  "code": 200,
  "data": {
    "total": 21,
    "result": [
      {
        "id": "version-123",
        "name": "v1",
        "status": "draft"
      }
    ],
    "next_page_token": "eyJvZmZzZXQiOjIwfQ"
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 200。
data	object	SQL 工作簿版本列表。

版本列表

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

字段	类型	说明
total	integer	当前 SQL 工作簿的版本总数。
result	array of object	版本列表。
next_page_token	string	下一页标记；为空时没有下一页。

版本信息

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

字段	类型	说明
id	string	版本 ID。
name	string	版本名称。
status	string	版本状态：draft 表示可编辑草稿；finalize 表示已定稿、只读。

读取下一页¶

每页最多返回 100 个版本；未传 page_size 时返回 20 个。读取下一页时，将响应中的 next_page_token 原样写入下一次请求的 page_token。该值为空时，表示没有下一页。

错误响应¶

响应示例

{
  "code": 404,
  "message": "SQL 工作簿不存在"
}

字段说明

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

后续操作¶

选择版本后，查看 SQL 工作簿版本内容。草稿版本还可以更新 SQL 草稿版本或定稿 SQL 版本。

最后更新于 2026 年 9 月 28 日