logo
开发者文档
搜索
回滚 Workflow 版本

回滚 Workflow 版本

支持将指定 Workflow 历史版本回滚保存为一个新版本,并可选择立即发布。

该接口使用目标 Workflow 自身的 API Key 鉴权,只允许开启版本管理权限的 Workflow 调用。

请求方式

POST

调用地址

https://api.${endpoint}/v1/workflow/version/rollback

调用验证

详情参见 API 概述的鉴权方式说明。请使用目标 Workflow 的 API Key 作为 token。

请求

请求示例

curl -X POST 'https://api.${endpoint}/v1/workflow/version/rollback' \ -H 'Authorization: Bearer ${token}' \ -H 'Content-Type: application/json' \ -d '{ "version": "v1", "new_version": "v3", "release": true, "version_desc": "Rollback to stable workflow" }'
                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/rollback' \
  -H 'Authorization: Bearer ${token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "v1",
    "new_version": "v3",
    "release": true,
    "version_desc": "Rollback to stable workflow"
  }'

                    
此代码块在浮窗中显示

请求头

字段 类型 说明
Authorization Bearer ${token} 使用目标 Workflow 的 API Key 进行调用验证。
Content-Type application/json 请求体格式。

请求参数(Body Parameters)

参数 类型 说明 required
version String 要回滚的来源版本号。 true
new_version String 回滚后保存的新版本号;为空时自动生成。 false
release Boolean 回滚保存后是否立即发布。 false
version_desc String 新版本说明。 false

响应

响应体

{ "code": 0, "message": "OK", "data": { "source_version": "v1", "new_version": "v3", "created": true, "released": true, "warnings": [] } }
                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "source_version": "v1",
    "new_version": "v3",
    "created": true,
    "released": true,
    "warnings": []
  }
}

                    
此代码块在浮窗中显示

成功响应

字段 类型 说明
source_version String 回滚来源版本号。
new_version String 保存出的新版本号。
created Boolean 是否创建了新版本。
released Boolean 是否已发布。
warnings String[] 回滚注意事项。

失败响应

字段 类型 说明
code int 错误码。
message string 错误信息。

状态码

状态码 说明
200 成功
400 参数错误
401 未授权
403 权限不足或 API Key 未开启版本管理权限
429 请求过于频繁
500 服务器错误