修改 SQL 草稿版本

修改草稿版本中保存的 SQL 内容,不会执行 SQL。已定稿的版本不能修改。

POST https://moi.matrixorigin.cn/newmoi/workbook/version/update

调用前准备

准备有更新权限的个人访问令牌、工作区 ID、SQL 保存记录 ID 和草稿版本 ID。$AI_STUDIO_API_KEY 是个人访问令牌,用作 X-API-Key 请求头的值;$WORKSPACE_ID 是目标工作区 ID,用作 X-Workspace-ID 请求头的值。可先查看已保存 SQL 的版本确认版本状态。

下方示例中的 $WORKBOOK_ID 是 SQL 保存记录的 ID,$VERSION_ID 是状态为 draft 的版本 ID。

请求体

字段

类型

是否必填

说明

workbook_id

string

SQL 保存记录的 ID。

version_id

string

SQL 保存记录中状态为 draft 的版本 ID。

sql_content

string

要保存的 SQL 内容。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/workbook/version/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\",
    \"version_id\": \"$VERSION_ID\",
    \"sql_content\": \"SELECT 1\"
  }"

成功响应

成功时 data 为空。随后可查看已保存 SQL 的版本内容确认保存的 SQL 内容。

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

响应字段如下。

字段

类型

说明

data

null

更新成功时固定为 null

错误响应

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

常见 HTTP 错误

HTTP 状态码

常见原因

建议操作

400

字段缺失或请求无效。

检查保存记录 ID、版本 ID 和请求体。

401

个人访问令牌缺失或无效。

检查个人访问令牌和工作区 ID。

403

当前访问凭据没有更新版本的权限。

使用有权限的访问凭据,或联系管理员授权。

404

SQL 保存记录或版本不存在,或者目标版本已经定稿。

检查保存记录 ID 和版本 ID;版本已定稿时,创建新的草稿版本。

500

服务无法更新草稿。

记录请求时间和错误信息后重试。

后续操作

用同一资源标识查看已保存 SQL 的版本内容确认更新结果。

最后更新于