Stay organized with collections Save and categorize content based on your preferences.
Retrieves connect settings about a Cloud SQL instance.
HTTP requestGET https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/connectSettings
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
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 ParametersreadTime
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".
The request body must be empty.
Response bodyIf successful, the response body contains data with the following structure:
Connect settings retrieval response.
Fieldskind
string
This is always sql#connectSettings.
serverCaCert
object (SslCert)
SSL configuration.
ipAddresses[]
object (IpMapping)
The assigned IP addresses for the instance.
region
string
The cloud region for the instance. For example, us-central1, europe-west1. The region cannot be changed after instance creation.
databaseVersion
enum (SqlDatabaseVersion)
The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12 (default), POSTGRES_13, or POSTGRES_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, or SQLSERVER_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 the tier property in the settings 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.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.adminFor more information, see the Authentication Overview.
ConnectPoolNodeConfigDetails 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 the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-30 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4