Method: connect.get

Retrieves connect settings about a Cloud SQL instance.

HTTP request

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/{project}/instances/{instance}/connectSettings

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID of the project that contains the instance.

instance

string

Cloud SQL instance ID. This does not include the project ID.

Query parameters

Parameters
readTime

string (Timestamp format)

Optional. Optional snapshot read timestamp to trade freshness for performance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:"2014-10-02T15:01:23Z" and"2014-10-02T15:01:23.045123456Z".

Request body

The request body must be empty.

Response body

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

Connect settings retrieval response.

JSON representation
{"kind":string,"serverCaCert":{object (SslCert)},"ipAddresses":[{object (IpMapping)}],"region":string,"databaseVersion":enum (SqlDatabaseVersion),"backendType":enum (SqlBackendType),"pscEnabled":boolean,"dnsName":string,"nodes":[{object (ConnectPoolNodeConfig)}],"nodeCount":integer}
Fields
kind

string

This is alwayssql#connectSettings.

serverCaCert

object (SslCert)

SSL configuration.

ipAddresses[]

object (IpMapping)

The assigned IP addresses for the instance.

region

string

The cloud region for the instance. e.g.us-central1,europe-west1. The region cannot be changed after instance creation.

databaseVersion

enum (SqlDatabaseVersion)

The database engine type and version. ThedatabaseVersion field cannot be changed after instance creation. MySQL instances:MYSQL_8_0,MYSQL_5_7 (default), orMYSQL_5_6. PostgreSQL instances:POSTGRES_9_6,POSTGRES_10,POSTGRES_11 orPOSTGRES_12 (default),POSTGRES_13, orPOSTGRES_14. SQL Server instances:SQLSERVER_2017_STANDARD (default),SQLSERVER_2017_ENTERPRISE,SQLSERVER_2017_EXPRESS,SQLSERVER_2017_WEB,SQLSERVER_2019_STANDARD,SQLSERVER_2019_ENTERPRISE,SQLSERVER_2019_EXPRESS, orSQLSERVER_2019_WEB.

backendType

enum (SqlBackendType)

SECOND_GEN: Cloud SQL database instance.EXTERNAL: A database server that is not managed by Google. This property is read-only; use thetier property in thesettings object to determine the database type.

pscEnabled

boolean

Whether PSC connectivity is enabled for this instance.

dnsName

string

The dns name of the instance.

nodes[]

object (ConnectPoolNodeConfig)

Output only. Entries containing information about each read pool node of the read pool.

nodeCount

integer

The number of read pool nodes in a read pool.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

ConnectPoolNodeConfig

Details of a single read pool node of a read pool.

JSON representation
{"ipAddresses":[{object (IpMapping)}],"name":string,"dnsName":string}
Fields
ipAddresses[]

object (IpMapping)

Output only. Mappings containing IP addresses that can be used to connect to the read pool node.

name

string

Output only. The name of the read pool node. Doesn't include the project ID.

dnsName

string

Output only. The DNS name of the read pool node.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-30 UTC.