Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1375137252.2 KB
instances

Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

patch/v1/projects/{project}/instances/{instance}

Path parameters

projectstring required

Project ID of the project that contains the instance.

instancestring required

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

Query parameters

reconcilePscNetworkingboolean

Optional. Set PSC config to the same value as the existing config to reconcile the PSC networking.

reconcilePscNetworkingForceboolean

Optional. Set PSC config to the same value as the existing config and force reconcile the PSC networking.

Request body

kindstring

This is always sql#instance.

includeReplicasForMajorVersionUpgradeboolean

Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.

replicaNamesstring[]

The replicas of the instance.

ipv6Addressstring

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

satisfiesPziboolean

Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.

instanceType'SQL_INSTANCE_TYPE_UNSPECIFIED' | 'CLOUD_SQL_INSTANCE' | 'ON_PREMISES_INSTANCE' | 'READ_REPLICA_INSTANCE' | 'READ_POOL_INSTANCE'

The instance type.

primaryDnsNamestring

Output only. DEPRECATED: please use write_endpoint instead.

masterInstanceNamestring

The name of the instance which will act as primary in the replication setup.

maxDiskSizestring int64

The maximum disk size of the instance in bytes.

tagsobject

Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "" : "". For example, a single resource can have the following tags: "123/environment": "production", "123/costCenter": "marketing", For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.

suspensionReasonstring[]

If the instance state is SUSPENDED, the reason for the suspension.

satisfiesPzsboolean

This status indicates whether the instance satisfies PZS. The status is reserved for future use.

secondaryGceZonestring

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.

sqlNetworkArchitecture'SQL_NETWORK_ARCHITECTURE_UNSPECIFIED' | 'NEW_NETWORK_ARCHITECTURE' | 'OLD_NETWORK_ARCHITECTURE'
serviceAccountEmailAddressstring

The service account email address assigned to the instance.\This property is read-only.

createTimestring google-datetime

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

maintenanceVersionstring

The current software version on the instance.

currentDiskSizestring int64

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

namestring

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

etagstring

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

rootPasswordstring

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

regionstring

The geographical region of the Cloud SQL instance. It can be one of the regions where Cloud SQL operates: For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.

connectionNamestring

Connection name of the Cloud SQL instance used in connection strings.

switchTransactionLogsToCloudStorageEnabledboolean

Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.

databaseVersion'SQL_DATABASE_VERSION_UNSPECIFIED' | 'MYSQL_5_1' | 'MYSQL_5_5' | 'MYSQL_5_6' | 'MYSQL_5_7' | 'MYSQL_8_0' | 'MYSQL_8_0_18' | 'MYSQL_8_0_26' | 'MYSQL_8_0_27' | 'MYSQL_8_0_28' | 'MYSQL_8_0_29' | 'MYSQL_8_0_30' | 'MYSQL_8_0_31' | 'MYSQL_8_0_32' | 'MYSQL_8_0_33' | 'MYSQL_8_0_34' | 'MYSQL_8_0_35' | 'MYSQL_8_0_36' | 'MYSQL_8_0_37' | 'MYSQL_8_0_39' | 'MYSQL_8_0_40' | 'MYSQL_8_0_41' | 'MYSQL_8_0_42' | 'MYSQL_8_0_43' | 'MYSQL_8_0_44' | 'MYSQL_8_0_45' | 'MYSQL_8_0_46' | 'MYSQL_8_4' | 'MYSQL_9_7' | 'SQLSERVER_2017_STANDARD' | 'SQLSERVER_2017_ENTERPRISE' | 'SQLSERVER_2017_EXPRESS' | 'SQLSERVER_2017_WEB' | 'POSTGRES_9_6' | 'POSTGRES_10' | 'POSTGRES_11' | 'POSTGRES_12' | 'POSTGRES_13' | 'POSTGRES_14' | 'POSTGRES_15' | 'POSTGRES_16' | 'POSTGRES_17' | 'POSTGRES_18' | 'POSTGRES_19' | 'POSTGRES_20' | 'SQLSERVER_2019_STANDARD' | 'SQLSERVER_2019_ENTERPRISE' | 'SQLSERVER_2019_EXPRESS' | 'SQLSERVER_2019_WEB' | 'SQLSERVER_2022_STANDARD' | 'SQLSERVER_2022_ENTERPRISE' | 'SQLSERVER_2022_EXPRESS' | 'SQLSERVER_2022_WEB' | 'SQLSERVER_2025_STANDARD' | 'SQLSERVER_2025_ENTERPRISE' | 'SQLSERVER_2025_EXPRESS'

The database engine type and version. The databaseVersion field cannot be changed after instance creation.

gceZonestring

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.

availableMaintenanceVersionsstring[]

Output only. List all maintenance versions applicable on the instance

databaseInstalledVersionstring

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

state'SQL_INSTANCE_STATE_UNSPECIFIED' | 'RUNNABLE' | 'SUSPENDED' | 'PENDING_DELETE' | 'PENDING_CREATE' | 'MAINTENANCE' | 'FAILED' | 'ONLINE_MAINTENANCE' | 'REPAIRING'

The current serving state of the Cloud SQL instance.

nodeCountinteger

The number of read pool nodes in a read pool.

projectstring

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

dnsNamestring

Output only. The dns name of the instance.

selfLinkstring

The URI of this resource.

writeEndpointstring

Output only. The dns name of the primary instance in a replication group.

pscServiceAttachmentLinkstring

Output only. The link to service attachment of PSC instance.

backendType'SQL_BACKEND_TYPE_UNSPECIFIED' | 'FIRST_GEN' | 'SECOND_GEN' | 'EXTERNAL'

The backend type. 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.

Response

Successful response