UpdateServiceRollout - 更新服务更新计划

更新时间:
复制为 MD 格式

更新服务发布计划

接口说明

请求说明

  • 至少提供一个参数:必须在请求中指定PartitionBatchPaused中的至少一个参数。

  • 互斥策略:不能同时提供PartitionBatch配置。

  • 实时生效:更新将立即生效,影响正在进行的服务发布过程。

  • 回退操作:通过增加Partition值可以实现版本回退,但不会自动触发,需要手动更新服务镜像。

  • 暂停不影响参数:暂停发布不会改变已设置的PartitionBatch参数,仅暂停执行当前策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

PUT /api/v2/services/{ClusterId}/{ServiceName}/rollout HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

ClusterId

string

ClusterId

  • 类型: string

  • 必填: 是

  • 说明: 地域 ID。服务所在的地域标识。

  • 示例值: cn-shanghai

cn-shanghai

ServiceName

string

ServiceName

  • 类型: string

  • 必填: 是

  • 说明: 服务名称。要更新发布策略的服务名称。

  • 示例值: my-service

my-service

请求参数

名称

类型

必填

描述

示例值

body

object

请求 Body。

Partition

object

Partition

  • 类型: object

  • 必填: 否

  • 说明: 分区发布配置。用于调整分区策略参数。与 Batch 互斥。

Partition

string

Partition

  • 类型: string

  • 必填: 是

  • 说明: 分区值。支持两种格式:
    1. 整数格式:如 "5",表示保留 5 个旧副本

    2. 百分比格式:如 "50%",表示保留 50%的旧副本 调整策略:

    • 调大值:回退到旧版本,增加旧副本比例

    • 调小值:推进到新版本,减少旧副本比例

    • 设置为"0%":完成全部更新,所有副本切换到新版本

  • 示例值: 30%

30%

Batch

object

Batch

  • 类型: object

  • 必填: 否

  • 说明: 批量发布配置。用于调整批量策略参数。与 Partition 互斥。

BatchSize

string

批次大小。每批次更新的副本数量。支持整数或百分比格式。默认值:"25%"

25%

Interval

string

批次间隔。两次发布之间的等待时间。支持单位:s(秒)、m(分钟)、h(小时)

60s

Paused

boolean

是否暂停发布。true表示暂停,false表示恢复。

true

返回参数

名称

类型

描述

示例值

object

响应 Body。

RequestId

string

请求 ID。每次请求返回的唯一标识,用于问题排查和追踪。

40325405-579C-4D82****

Message

string

返回信息。描述请求处理结果。可能值:

  • "Rollout updated successfully":更新策略成功

  • "Rollout paused successfully":暂停发布成功

  • "Rollout resumed successfully":恢复发布成功

Rollout updated successfully

示例

正常返回示例

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Rollout updated successfully"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情