Method: projects.locations.clusters.instances.getConnectionInfo

Get instance metadata used for a connection.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}

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

  • alloydb.instances.connect

Query parameters

Parameters
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).

Request body

The request body must be empty.

Response body

ConnectionInfo singleton resource. https://google.aip.dev/156

If successful, the response body contains data with the following structure:

JSON representation 
{
  "name": string,
  "ipAddress": string,
  "publicIpAddress": string,
  "instanceUid": string
}
Fields
name

string

The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning.
ipAddress

string

Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enablePublicIp is set). This is the connection endpoint for an end-user application.
publicIpAddress

string

Output only. The public IP addresses for the Instance. This is available ONLY when enablePublicIp is set. This is the connection endpoint for an end-user application.
instanceUid

string

Output only. The unique ID of the Instance.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.