instances_connection_info

Creates, updates, deletes, gets or lists an instances_connection_info resource.

Overview

Name	instances_connection_info
Type	Resource
Id	google.alloydb.instances_connection_info

Fields

The following fields are returned by SELECT queries:

get_connection_info

Successful response

Name	Datatype	Description
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.
instanceUid	string	Output only. The unique ID of the Instance.
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 enable_public_ip 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 enable_public_ip is set. This is the connection endpoint for an end-user application.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connection_info	select	projectsId, locationsId, clustersId, instancesId	requestId	Get instance metadata used for a connection.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clustersId	string
instancesId	string
locationsId	string
projectsId	string
requestId	string

SELECT examples

get_connection_info

Get instance metadata used for a connection.

SELECT
name,
instanceUid,
ipAddress,
publicIpAddress
FROM google.alloydb.instances_connection_info
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND requestId = '{{ requestId }}';