Method: projects.locations.deliveryPipelines.rollbackTarget

创建 Rollout 以回滚指定目标。

HTTP 请求

POST https://clouddeploy.googleapis.com/v1/{name=projects/*/locations/*/deliveryPipelines/*}:rollbackTarget

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。应为其创建回滚 Rollout 的 DeliveryPipeline。格式应为 projects/{projectId}/locations/{location_name}/deliveryPipelines/{pipeline_name}。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "targetId": string,
  "rolloutId": string,
  "releaseId": string,
  "rolloutToRollBack": string,
  "rollbackConfig": {
    object (RollbackTargetConfig)
  },
  "validateOnly": boolean
}
字段
targetId

string

必需。要回滚的 Target 的 ID。
rolloutId

string

必需。要创建的回滚 Rollout 的 ID。
releaseId

string

可选。要回滚到的 Release 的 ID。如果未指定，系统将使用之前成功发送到指定目标的 Rollout 来确定 Release。
rolloutToRollBack

string

可选。如果提供，则必须是 Target 上的最新 Rollout。
rollbackConfig

object (RollbackTargetConfig)

可选。回滚 Rollout 的配置。
validateOnly

boolean

可选。如果设置为 true，则对请求进行验证，并向用户提供 RollbackTargetResponse。

响应正文

来自 deliveryPipelines.rollbackTarget 的响应对象。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "rollbackConfig": {
    object (RollbackTargetConfig)
  }
}
字段
rollbackConfig

object (RollbackTargetConfig)

已创建或即将创建回滚 Rollout 的配置。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

  • clouddeploy.rollouts.rollback

如需了解详情，请参阅 IAM 文档。

RollbackTargetConfig

回滚发布的配置。

JSON 表示法 
{
  "rollout": {
    object (Rollout)
  },
  "startingPhaseId": string
}
字段
rollout

object (Rollout)

可选。要创建的回滚 Rollout。
startingPhaseId

string

可选。Rollout 的起始阶段 ID。如果未指定，Rollout 将以稳定阶段启动。