Method: projects.locations.clusters.backup

Redis クラスタをバックアップします。バックアップが初めて作成される場合は、バックエンドでバックアップ コレクションが作成され、このバックアップはこのコレクションに属します。コレクションとバックアップの両方にリソース名が付けられます。バックアップはシャードごとに実行されます。実行を行うレプリカ（非 HA の場合はプライマリ）が選択されます。バックアップまたは更新オペレーションが進行中の場合、バックアップ呼び出しは拒否されます。プレビュー期間中、クラスタの内部ソフトウェア バージョンが古すぎる場合は、実際のバックアップの前に重要な更新が実行されます。内部ソフトウェアのバージョンがバックアップ機能に必要な最小バージョンに更新されると、以降のバックアップでは重要な更新は必要なくなります。プレビュー後は、バックアップに重要な更新は必要ありません。

HTTP リクエスト

POST https://redis.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}:backup

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

パスパラメータ

パラメータ
name

string

必須。projects/{projectId}/locations/{locationId}/clusters/{clusterId} という形式を使用した Redis クラスタのリソース名。locationId は Google Cloud リージョンを表します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "ttl": string,
  "backupId": string
}
フィールド
ttl

string (Duration format)

省略可。バックアップの TTL が期限切れになるまでの時間。値の範囲は 1 日～ 100 年です。指定しない場合、デフォルト値は 100 年です。

s で終わる小数点以下 9 桁までの秒単位の期間。例: "3.5s"。
backupId

string

省略可。作成するバックアップの ID。指定しない場合、デフォルト値（[YYYYMMDDHHMMSS]_[短縮されたクラスタ UID]）が使用されます。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。