logo
開發者文件
搜尋
回滾 Workflow 版本

回滾 Workflow 版本

支援將指定 Workflow 歷史版本回滾儲存為一個新版本,並可選擇立即發布。

該 API 使用目標 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 伺服器錯誤