Method: projects.locations.clusters.upgrade

Upgrades a single Cluster. Imperative only.

HTTP request

PATCH https://alloydb.googleapis.com/v1beta/{name=projects/*/locations/*/clusters/*}:upgrade

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the cluster.

Authorization requires the following IAM permission on the specified resource name:

  • alloydb.clusters.upgrade

Request body

The request body contains data with the following structure:

JSON representation 
{
  "version": enum (DatabaseVersion),
  "requestId": string,
  "validateOnly": boolean,
  "etag": string
}
Fields
version

enum (DatabaseVersion)

Required. The version the cluster is going to be upgraded to.
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly

boolean

Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
etag

string

Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.