メソッド: projects.locations.instances.patch

特定の Redis インスタンスのメタデータと構成を更新します。

完了した longrunning.Operation には、response フィールドに新しいインスタンス オブジェクトが格納されます。返されたオペレーションは数時間後に自動的に削除されるため、operations.delete を呼び出す必要はありません。

HTTP リクエスト

PATCH https://redis.googleapis.com/v1/{instance.name=projects/*/locations/*/instances/*}

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

パスパラメータ

パラメータ
instance.name

string

必須。プロジェクトとロケーションを含むスコープ内で一意のリソース名。projects/{projectId}/locations/{locationId}/instances/{instanceId} という形式を使用します。

注: Redis インスタンスはリージョン レベルで管理され、アドレス指定されるため、locationId の部分は GCP のリージョンを指します。ただし、インスタンスをプロビジョニングするゾーン（複数のゾーンにまたがるインスタンスの場合はゾーンのコレクション）はユーザーが選択できます。詳細については、[locationId] と [alternativeLocationId] フィールドを参照してください。

クエリ パラメータ

パラメータ
updateMask

string（FieldMask 形式）

必須。更新するフィールドのマスク。このフィールドには少なくとも 1 つのパスを指定する必要があります。繰り返しのパスフィールドの要素に含めることができるのは、次に示す [Instance][CloudRedis.Instance] のフィールドだけです。

  • displayName
  • labels
  • memorySizeGb
  • redisConfig

完全修飾された項目名のカンマ区切りリスト。例: "user.displayName,photo"

リクエストの本文

リクエストの本文には Instance のインスタンスが含まれます。

レスポンスの本文

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

承認スコープ

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

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

詳細については、認証の概要をご覧ください。