跳转到主要内容
ZStack
基础设施相关接口/OTA 升级计划

创建灰度计划

创建灰度计划。

POST/api/v1/lifecycle/upgrade-plans

操作 ID

CreateGraduatedPlan

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • name
    String必填

    资源名称。

    示例： Upgrade agents to v1.3.0

  • fromVersion
    String必填

    版本代理当前运行中。

    示例： 1.2.0

  • toVersion
    String必填

    目标版本号。

    示例： 1.3.0

  • toRelease
    String必填

    目标发布代理已升级。

    示例： 221

  • agentIds
    List必填

    代理ID列表。

    示例： item1,item2

响应状态

200 OK
200 OK

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

  • id
    String

    资源ID。

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

  • name
    String

    资源名称。

    示例： Upgrade agents to v1.3.0

  • fromVersion
    String

    源版本代理已升级。

    示例： 1.2.0

  • toVersion
    String

    目标版本号。

    示例： 1.3.0

  • fromRelease
    String

    源发布代理已升级。

    示例： 215

  • toRelease
    String

    目标发布代理已升级。

    示例： 221

  • batches
    List

    资源。

    示例： (nested array)

    • batchIndex
      Integer

      批次索引。

      示例： 20

    • agentIds
      List

      代理ID列表。

      示例： item1,item2

    • status
      String

      状态信息。

      示例： completed

    • failedCount
      Integer

      失败次数。

      示例： 20

    • tasks
      List

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

      示例： (nested array)

      • componentUuid
        String

        组件UUID。

        示例： abcdef0123456789abcdef0123456789

      • componentInstanceUuid
        String

        组件实例UUID。

        示例： abcdef0123456789abcdef0123456789

      • lifecycleTaskUuid
        String

        生命周期任务UUID。

        示例： task-a1b2c3d4

      • componentName
        String

        组件名称。

        示例： zmetis

      • taskType
        String

        生命周期任务类型。

        示例： update

      • status
        String

        状态信息。

        示例： running

      • nodeUuid
        String

        节点UUID。

        示例： abcdef0123456789abcdef0123456789

      • lcaUuid
        String

        LCA UUID。

        示例： abcdef0123456789abcdef0123456789

      • runtimeStatus
        String

        运行时状态。

        示例： running

      • actualVersion
        String

        实际版本。

        示例： 1.0.0

      • actualRelease
        String

        实际发布。

        示例： 221

  • failureThreshold
    Long

    失败阈值。

    示例： 0.1

  • concurrency
    Integer

    并发数。

    示例： 5

  • status
    String

    状态信息。

    示例： running

  • currentBatch
    Integer

    索引批次当前执行。

    示例： 1

  • createdBy
    String

    创建该记录的用户UUID。

    示例： admin

  • createdAt
    String

    创建时间。

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

  • startedAt
    String

    开始时间。

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

  • pausedAt
    String

    已暂停时间。

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

  • pauseReason
    String

    原因计划已暂停适用。

    示例： Failure threshold exceeded

  • completedAt
    String

    完成时间。

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

  • sourcePlanUuid
    String

    源计划UUID。

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

  • error
    String

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

    示例： "upgrade failed: timeout"

  • observeDuration
    String

    观察时长。

    示例： value