跳转到主要内容
API Explorer|API Explorer
基础设施相关接口/OTA 升级计划
POSTOTA起始版本 1.0同步需要认证

创建回滚计划

创建回滚计划。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • sourcePlanUuidString必填

    源计划UUID。

    示例： a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • observeDurationString必填

    观察时长。

    示例： value

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • planObject

    计划。

    • idString

      资源ID。

      示例： plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • nameString

      资源名称。

      示例： Upgrade agents to v1.3.0

    • fromVersionString

      源版本代理已升级。

      示例： 1.2.0

    • toVersionString

      目标版本号。

      示例： 1.3.0

    • fromReleaseString

      源发布代理已升级。

      示例： 215

    • toReleaseString

      目标发布代理已升级。

      示例： 221

    • batchesList

      资源。

      示例： (nested array)

      • batchIndexInteger

        批次索引。

        示例： 20

      • agentIdsList

        代理ID列表。

        示例： item1,item2

      • statusString

        状态信息。

        示例： completed

      • failedCountInteger

        失败次数。

        示例： 20

      • tasksList

        运行时目标定向任务批次。

        示例： (nested array)

        • componentUuidString

          组件UUID。

          示例： abcdef0123456789abcdef0123456789

        • componentInstanceUuidString

          组件实例UUID。

          示例： abcdef0123456789abcdef0123456789

        • lifecycleTaskUuidString

          生命周期任务UUID。

          示例： task-a1b2c3d4

        • componentNameString

          组件名称。

          示例： zmetis

        • taskTypeString

          生命周期任务类型。

          示例： update

        • statusString

          状态信息。

          示例： running

        • nodeUuidString

          节点UUID。

          示例： abcdef0123456789abcdef0123456789

        • lcaUuidString

          LCA UUID。

          示例： abcdef0123456789abcdef0123456789

        • runtimeStatusString

          运行时状态。

          示例： running

        • actualVersionString

          实际版本。

          示例： 1.0.0

        • actualReleaseString

          实际发布。

          示例： 221

    • failureThresholdLong

      失败阈值。

      示例： 0.1

    • concurrencyInteger

      并发数。

      示例： 5

    • statusString

      状态信息。

      示例： running

    • currentBatchInteger

      索引批次当前执行。

      示例： 1

    • createdByString

      创建该记录的用户UUID。

      示例： admin

    • createdAtString

      创建时间。

      示例： 2026-01-15T08:00:00Z

    • startedAtString

      开始时间。

      示例： 2026-01-15T08:00:00Z

    • pausedAtString

      已暂停时间。

      示例： 2026-01-15T08:00:00Z

    • pauseReasonString

      原因计划已暂停适用。

      示例： Failure threshold exceeded

    • completedAtString

      完成时间。

      示例： 2026-01-15T08:00:00Z

    • sourcePlanUuidString

      源计划UUID。

      示例： a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • errorString

      错误码。操作成功时为 null，失败时返回具体错误信息。

      示例： "upgrade failed: timeout"

    • observeDurationString

      观察时长。

      示例： value

  • warningsList

    告警信息列表。

    示例： "check agent connectivity before proceeding"

请求地址

POST/api/v1/lifecycle/plans/rollback

/api/v1/lifecycle/plans/rollback

操作 ID

CreateRollbackPlan

永久链接

请求示例

curl -X POST '{host}/api/v1/lifecycle/plans/rollback' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"sourcePlanUuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","observeDuration":"value"}'

响应示例

200
{"plan": {"id": "plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Upgrade agents to v1.3.0", "fromVersion": "1.2.0", "toVersion": "1.3.0", "fromRelease": "215", "toRelease": "221", "batches": [{"batchIndex": 20, "agentIds": ["value"], "status": "completed", "failedCount": 20, "tasks": [{"componentUuid": "abcdef0123456789abcdef0123456789", "componentInstanceUuid": "abcdef0123456789abcdef0123456789", "lifecycleTaskUuid": "task-a1b2c3d4", "componentName": "zmetis", "taskType": "update", "status": "running", "nodeUuid": "abcdef0123456789abcdef0123456789", "lcaUuid": "abcdef0123456789abcdef0123456789"}]}], "failureThreshold": 0.1}, "warnings": ["value"]}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史