更新 SQL 工作簿名称¶

更新 SQL 工作簿名称，不会修改其中保存的 SQL 内容或版本。

POST https://api.moi.matrixorigin.cn/v5/workbook/update

调用前准备¶

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

请求体¶

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

输入示例

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

参数说明

参数	类型	是否必填	说明
`workbook_id`	string	是	SQL 工作簿的 ID。
`name`	string	是	新名称。

成功响应¶

成功时不返回结果对象。随后可查看 SQL 工作簿列表确认新名称。

响应示例

{
  "code": 200,
  "data": null
}

字段说明

字段	类型	说明
code	integer	成功时为 200。
data	null	更新成功时固定为 null。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

查看 SQL 工作簿列表，确认新名称。

最后更新于 2026 年 9 月 9 日