Method: projects.locations.clusters.get

Gets details of a single Cluster.

HTTP request

GET https://alloydb.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

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

  • alloydb.clusters.get

Query parameters

Parameters
view

enum (ClusterView)

Optional. The view of the cluster to return. Returns all default fields if not set.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ClusterView

View on Cluster. Pass this enum to rpcs that returns a cluster message to control which subsets of fields to get.

Enums
CLUSTER_VIEW_UNSPECIFIED CLUSTER_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
CLUSTER_VIEW_BASIC BASIC server responses include all the relevant cluster details, excluding Cluster.ContinuousBackupInfo.EarliestRestorableTime and other view-specific fields. The default value.
CLUSTER_VIEW_CONTINUOUS_BACKUP CONTINUOUS_BACKUP response returns all the fields from BASIC plus the earliest restorable time if continuous backups are enabled. May increase latency.