Method: projects.locations.clusters.instances.get

Gets details of a single Instance.

HTTP request

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

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 Instance.name field.

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

  • alloydb.instances.get

Query parameters

Parameters
view

enum (InstanceView)

The view of the instance to return.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

InstanceView

View on Instance. Pass this enum to rpcs that returns an Instance message to control which subsets of fields to get.

Enums
INSTANCE_VIEW_UNSPECIFIED INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
INSTANCE_VIEW_BASIC BASIC server responses for a primary or read instance include all the relevant instance details, excluding the details of each node in the instance. The default value.
INSTANCE_VIEW_FULL FULL response is equivalent to BASIC for primary instance (for now). For read pool instance, this includes details of each node in the pool.