创建 SQL 草稿版本

为一条 SQL 保存记录创建可编辑的草稿版本,并保存初始 SQL 内容。

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

调用前准备

准备有更新权限的个人访问令牌、工作区 ID 和 SQL 保存记录 ID。$AI_STUDIO_API_KEY 是个人访问令牌,用作 X-API-Key 请求头的值;$WORKSPACE_ID 是目标工作区 ID,用作 X-Workspace-ID 请求头的值。可先创建 SQL 保存记录取得 workbook_id

下方示例中的 $WORKBOOK_ID 是 SQL 保存记录的 ID。sql_content 仅保存 SQL 内容,不会执行 SQL。

请求体

字段

类型

是否必填

说明

workbook_id

string

SQL 保存记录的 ID。

sql_content

string

草稿 SQL 内容。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/workbook/version/create" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"workbook_id\": \"$WORKBOOK_ID\",
    \"sql_content\": \"SELECT 1\"
  }"

成功响应

data.id 是新草稿版本 ID。保存该 ID 后,可更新草稿版本定稿版本

{
  "code": 200,
  "data": {
    "id": "version-123",
    "version": "v1",
    "status": "draft"
  }
}

响应字段如下。

字段

类型

说明

data.id

string

新建草稿版本 ID。

data.version

string

版本名称。

data.status

string

新建版本状态,为 draft

错误响应

{
  "code": 500,
  "message": "Internal server error"
}

常见 HTTP 错误

HTTP 状态码

常见原因

建议操作

400

workbook_id 缺失或请求无效。

传入有效的 SQL 保存记录 ID。

401

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

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

403

当前访问凭据没有创建版本的权限。

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

404

SQL 保存记录不存在。

检查 workbook_id

500

服务无法创建草稿版本。

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

后续操作

记录 data.id。用该 ID 查看已保存 SQL 的版本内容确认保存结果。

最后更新于