Method: projects.locations.deliveryPipelines.rollbackTarget

指定したターゲットをロールバックする Rollout を作成します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

Rollback ロールアウトの構成。

JSON 表現 
{
  "rollout": {
    object (Rollout)
  },
  "startingPhaseId": string
}
フィールド
rollout

object (Rollout)

省略可。作成するロールバック Rollout。
startingPhaseId

string

省略可。Rollout の開始フェーズ ID。指定しない場合、Rollout は安定フェーズで開始されます。