REST Resource: instances

Resource: DatabaseInstance

A Cloud SQL instance resource.

JSON representation 
{
  "kind": string,
  "state": enum (SqlInstanceState),
  "databaseVersion": enum (SqlDatabaseVersion),
  "settings": {
    object (Settings)
  },
  "etag": string,
  "failoverReplica": {
    "name": string,
    "available": boolean
  },
  "masterInstanceName": string,
  "replicaNames": [
    string
  ],
  "maxDiskSize": string,
  "currentDiskSize": string,
  "ipAddresses": [
    {
      object (IpMapping)
    }
  ],
  "serverCaCert": {
    object (SslCert)
  },
  "instanceType": enum (SqlInstanceType),
  "project": string,
  "ipv6Address": string,
  "serviceAccountEmailAddress": string,
  "onPremisesConfiguration": {
    object (OnPremisesConfiguration)
  },
  "replicaConfiguration": {
    object (ReplicaConfiguration)
  },
  "backendType": enum (SqlBackendType),
  "selfLink": string,
  "suspensionReason": [
    enum (SqlSuspensionReason)
  ],
  "connectionName": string,
  "name": string,
  "region": string,
  "gceZone": string,
  "secondaryGceZone": string,
  "diskEncryptionConfiguration": {
    object (DiskEncryptionConfiguration)
  },
  "diskEncryptionStatus": {
    object (DiskEncryptionStatus)
  },
  "rootPassword": string,
  "scheduledMaintenance": {
    object (SqlScheduledMaintenance)
  },
  "satisfiesPzs": boolean,
  "databaseInstalledVersion": string,
  "createTime": string,
  "availableMaintenanceVersions": [
    string
  ],
  "maintenanceVersion": string,
  "upgradableDatabaseVersions": [
    {
      object (AvailableDatabaseVersion)
    }
  ],
  "replicationCluster": {
    object (ReplicationCluster)
  },
  "satisfiesPzi": boolean,
  "outOfDiskReport": {
    object (SqlOutOfDiskReport)
  },
  "sqlNetworkArchitecture": enum (SqlNetworkArchitecture),
  "pscServiceAttachmentLink": string,
  "dnsName": string
  "geminiConfig": {
    object (GeminiInstanceConfig)
  }
}
Fields
kind

string

This is always sql#instance.
state

enum (SqlInstanceState)

The current serving state of the Cloud SQL instance.
databaseVersion

enum (SqlDatabaseVersion)

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

object (Settings)

The user settings.
etag

string

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

object

The name and status of the failover replica.
failoverReplica.name

string

The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.
failoverReplica.available

boolean

The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
masterInstanceName

string

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

string

The replicas of the instance.
maxDiskSize
(deprecated)

string (Int64Value format)

The maximum disk size of the instance in bytes.
currentDiskSize
(deprecated)

string (Int64Value format)

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.
ipAddresses[]

object (IpMapping)

The assigned IP addresses for the instance.
serverCaCert

object (SslCert)

SSL configuration.
instanceType

enum (SqlInstanceType)

The instance type.
project

string

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

string

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

string

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

object (OnPremisesConfiguration)

Configuration specific to on-premises instances.
replicaConfiguration

object (ReplicaConfiguration)

Configuration specific to failover replicas and read replicas.
backendType

enum (SqlBackendType)

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.
suspensionReason[]

enum (SqlSuspensionReason)

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

string

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

string

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

string

The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1.

Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.
gceZone

string

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.
secondaryGceZone

string

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.
diskEncryptionConfiguration

object (DiskEncryptionConfiguration)

Disk encryption configuration specific to an instance.
diskEncryptionStatus

object (DiskEncryptionStatus)

Disk encryption status specific to an instance.
rootPassword

string

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

object (SqlScheduledMaintenance)

The start time of any upcoming scheduled maintenance for this instance.
satisfiesPzs

boolean

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.
databaseInstalledVersion

string

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

string (Timestamp format)

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

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".
availableMaintenanceVersions[]

string

Output only. instances.list all maintenance versions applicable on the instance
maintenanceVersion

string

The current software version on the instance.
upgradableDatabaseVersions[]

object (AvailableDatabaseVersion)

Output only. All database versions that are available for upgrade.
replicationCluster

object (ReplicationCluster)

Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
satisfiesPzi

boolean

Output only. This status indicates whether the instance satisfies PZI.

The status is reserved for future use.
outOfDiskReport

object (SqlOutOfDiskReport)

This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
sqlNetworkArchitecture

enum (SqlNetworkArchitecture)
dnsName

string

Output only. The dns name of the instance.
geminiConfig

object (GeminiInstanceConfig)

Gemini instance configuration.

SqlInstanceState

The current serving state of the database instance.

Enums
SQL_INSTANCE_STATE_UNSPECIFIED The state of the instance is unknown.
RUNNABLE The instance is running, or has been stopped by owner.
SUSPENDED The instance is not available, for example due to problems with billing.
PENDING_DELETE The instance is being deleted.
PENDING_CREATE The instance is being created.
MAINTENANCE The instance is down for maintenance.
FAILED The creation of the instance failed or a fatal error occurred during maintenance.
ONLINE_MAINTENANCE

Deprecated

Settings

Database instance settings.

JSON representation 
{
  "settingsVersion": string,
  "authorizedGaeApplications": [
    string
  ],
  "tier": string,
  "kind": string,
  "userLabels": {
    string: string,
    ...
  },
  "availabilityType": enum (SqlAvailabilityType),
  "pricingPlan": enum (SqlPricingPlan),
  "replicationType": enum (SqlReplicationType),
  "storageAutoResizeLimit": string,
  "activationPolicy": enum (SqlActivationPolicy),
  "ipConfiguration": {
    object (IpConfiguration)
  },
  "storageAutoResize": boolean,
  "locationPreference": {
    object (LocationPreference)
  },
  "databaseFlags": [
    {
      object (DatabaseFlags)
    }
  ],
  "dataDiskType": enum (SqlDataDiskType),
  "maintenanceWindow": {
    object (MaintenanceWindow)
  },
  "backupConfiguration": {
    object (BackupConfiguration)
  },
  "databaseReplicationEnabled": boolean,
  "crashSafeReplicationEnabled": boolean,
  "dataDiskSizeGb": string,
  "activeDirectoryConfig": {
    object (SqlActiveDirectoryConfig)
  },
  "collation": string,
  "denyMaintenancePeriods": [
    {
      object (DenyMaintenancePeriod)
    }
  ],
  "insightsConfig": {
    object (InsightsConfig)
  },
  "passwordValidationPolicy": {
    object (PasswordValidationPolicy)
  },
  "sqlServerAuditConfig": {
    object (SqlServerAuditConfig)
  },
  "edition": enum (Edition),
  "connectorEnforcement": enum (ConnectorEnforcement),
  "deletionProtectionEnabled": boolean,
  "timeZone": string,
  "enableDataplexIntegration": boolean
}
Fields
settingsVersion

string (Int64Value format)

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
authorizedGaeApplications[]
(deprecated)

string

The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
tier

string

The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.
kind

string

This is always sql#settings.
userLabels

map (key: string, value: string)

User-provided labels, represented as a dictionary where each label is a single key value pair.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
availabilityType

enum (SqlAvailabilityType)

Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./

For more information, see Overview of the High Availability Configuration.
pricingPlan

enum (SqlPricingPlan)

The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
replicationType
(deprecated)

enum (SqlReplicationType)

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.
storageAutoResizeLimit

string (Int64Value format)

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
activationPolicy

enum (SqlActivationPolicy)

The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives.
ipConfiguration

object (IpConfiguration)

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
storageAutoResize

boolean

Configuration to increase storage size automatically. The default value is true.
locationPreference

object (LocationPreference)

The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
databaseFlags[]

object (DatabaseFlags)

The database flags passed to the instance at startup.
dataDiskType

enum (SqlDataDiskType)

The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
maintenanceWindow

object (MaintenanceWindow)

The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
backupConfiguration

object (BackupConfiguration)

The daily backup configuration for the instance.
databaseReplicationEnabled

boolean

Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
crashSafeReplicationEnabled
(deprecated)

boolean

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
dataDiskSizeGb

string (Int64Value format)

The size of data disk, in GB. The data disk size minimum is 10GB.
activeDirectoryConfig

object (SqlActiveDirectoryConfig)

Active Directory configuration, relevant only for Cloud SQL for SQL Server.
collation

string

The name of server Instance collation.
denyMaintenancePeriods[]

object (DenyMaintenancePeriod)

Deny maintenance periods
insightsConfig

object (InsightsConfig)

Insights configuration, for now relevant only for Postgres.
passwordValidationPolicy

object (PasswordValidationPolicy)

The local user password validation policy of the instance.
sqlServerAuditConfig

object (SqlServerAuditConfig)

SQL Server specific audit configuration.
edition

enum (Edition)

Optional. The edition of the instance.
connectorEnforcement

enum (ConnectorEnforcement)

Specifies if connections must use Cloud SQL connectors. Option values include the following: NOT_REQUIRED (Cloud SQL instances can be connected without Cloud SQL Connectors) and REQUIRED (Only allow connections that use Cloud SQL Connectors).

Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
deletionProtectionEnabled

boolean

Configuration to protect against accidental instance deletion.
timeZone

string

Server timezone, relevant only for Cloud SQL for SQL Server.
enableGoogleMlIntegration

boolean

Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.
enableDataplexIntegration

boolean

Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated.

SqlAvailabilityType

The availability type of the given Cloud SQL instance.

Enums
SQL_AVAILABILITY_TYPE_UNSPECIFIED This is an unknown Availability type.
ZONAL Zonal available instance.
REGIONAL Regional available instance.

SqlPricingPlan

The pricing plan for this instance.

Enums
SQL_PRICING_PLAN_UNSPECIFIED This is an unknown pricing plan for this instance.
PACKAGE The instance is billed at a monthly flat rate.
PER_USE The instance is billed per usage.

SqlReplicationType

Enums
SQL_REPLICATION_TYPE_UNSPECIFIED This is an unknown replication type for a Cloud SQL instance.
SYNCHRONOUS The synchronous replication mode for First Generation instances. It is the default value.
ASYNCHRONOUS The asynchronous replication mode for First Generation instances. It provides a slight performance gain, but if an outage occurs while this option is set to asynchronous, you can lose up to a few seconds of updates to your data.

SqlActivationPolicy

Specifies when the instance is activated.

Enums
SQL_ACTIVATION_POLICY_UNSPECIFIED Unknown activation plan.
ALWAYS The instance is always up and running.
NEVER The instance never starts.
ON_DEMAND

The instance starts upon receiving requests.

IpConfiguration

IP Management configuration.

JSON representation 
{
  "ipv4Enabled": boolean,
  "privateNetwork": string,
  "requireSsl": boolean,
  "authorizedNetworks": [
    {
      object (AclEntry)
    }
  ],
  "sslMode": enum (SslMode),
  "pscConfig": {
    object (PscConfig)
  },
  "serverCaMode": enum (CaMode)
}
Fields
ipv4Enabled

boolean

Whether the instance is assigned a public IP address or not.
privateNetwork

string

The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
requireSsl

boolean

Use sslMode instead.

Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the sslMode flag instead of the requireSsl flag.
authorizedNetworks[]

object (AclEntry)

The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: 157.197.200.0/24).
allocatedIpRange

string

The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
sslMode

enum (SslMode)

Specify how SSL/TLS is enforced in database connections. If you must use the requireSsl flag for backward compatibility, then only the following value pairs are valid:

For PostgreSQL and MySQL:

  • sslMode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and requireSsl=false
  • sslMode=ENCRYPTED_ONLY and requireSsl=false
  • sslMode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED and requireSsl=true

For SQL Server:

  • sslMode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and requireSsl=false
  • sslMode=ENCRYPTED_ONLY and requireSsl=true

The value of sslMode has priority over the value of requireSsl.

For example, for the pair sslMode=ENCRYPTED_ONLY and requireSsl=false, sslMode=ENCRYPTED_ONLY means accept only SSL connections, while requireSsl=false means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect sslMode and accepts only SSL connections.
pscConfig

object (PscConfig)

PSC settings for this instance.
serverCaMode

enum (CaMode)

Specify what type of CA is used for the server certificate.

AclEntry

An entry for an Access Control list.

JSON representation 
{
  "value": string,
  "expirationTime": string,
  "name": string,
  "kind": string
}
Fields
value

string

The allowlisted value for the access control list.
expirationTime

string (Timestamp format)

The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

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".
name

string

Optional. A label to identify this entry.
kind

string

This is always sql#aclEntry.

SslMode

The SSL options for database connections.

Enums
SSL_MODE_UNSPECIFIED The SSL mode is unknown.
ALLOW_UNENCRYPTED_AND_ENCRYPTED

Allow non-SSL/non-TLS and SSL/TLS connections. For SSL connections to MySQL and PostgreSQL, the client certificate isn't verified.

When this value is used, the legacy requireSsl flag must be false or cleared to avoid a conflict between the values of the two flags.
ENCRYPTED_ONLY

Only allow connections encrypted with SSL/TLS. For SSL connections to MySQL and PostgreSQL, the client certificate isn't verified.

When this value is used, the legacy requireSsl flag must be false or cleared to avoid a conflict between the values of the two flags.
TRUSTED_CLIENT_CERTIFICATE_REQUIRED

Only allow connections encrypted with SSL/TLS and with valid client certificates.

When this value is used, the legacy requireSsl flag must be true or cleared to avoid the conflict between values of two flags. PostgreSQL clients or users that connect using IAM database authentication must use either the Cloud SQL Auth Proxy or Cloud SQL Connectors to enforce client identity verification.

Only applicable to MySQL and PostgreSQL. Not applicable to SQL Server.

PscConfig

PSC settings for a Cloud SQL instance.

JSON representation 
{
  "allowedConsumerProjects": [
    string
  ],
  "pscEnabled": boolean
}
Fields
allowedConsumerProjects[]

string

The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects.

Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
pscEnabled

boolean

Whether PSC connectivity is enabled for this instance.

CaMode

Various Certificate Authority (CA) modes for certificate signing.

Enums
CA_MODE_UNSPECIFIED CA mode is unspecified. It is effectively the same as GOOGLE_MANAGED_INTERNAL_CA.
GOOGLE_MANAGED_INTERNAL_CA Google-managed self-signed internal CA.
GOOGLE_MANAGED_CAS_CA Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS).

LocationPreference

Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.

JSON representation 
{
  "followGaeApplication": string,
  "zone": string,
  "secondaryZone": string,
  "kind": string
}
Fields
followGaeApplication
(deprecated)

string

The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance.
zone

string

The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance.
secondaryZone

string

The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.).
kind

string

This is always sql#locationPreference.

DatabaseFlags

Database flags for Cloud SQL instances.

JSON representation 
{
  "name": string,
  "value": string
}
Fields
name

string

The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
value

string

The value of the flag. Boolean flags are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

SqlDataDiskType

The type of disk that is used for a v2 instance to use.

Enums
SQL_DATA_DISK_TYPE_UNSPECIFIED This is an unknown data disk type.
PD_SSD An SSD data disk.
PD_HDD An HDD data disk.
OBSOLETE_LOCAL_SSD

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

MaintenanceWindow

Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.

JSON representation 
{
  "hour": integer,
  "day": integer,
  "updateTrack": enum (SqlUpdateTrack),
  "kind": string
}
Fields
hour

integer

Hour of day - 0 to 23. Specify in the UTC time zone.
day

integer

Day of week - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY. Specify in the UTC time zone. Returned in output as an integer, 1 to 7, where 1 equals Monday.
updateTrack

enum (SqlUpdateTrack)

Maintenance timing settings: canary, stable, or week5. For more information, see About maintenance on Cloud SQL instances.
kind

string

This is always sql#maintenanceWindow.

SqlUpdateTrack

Enums
SQL_UPDATE_TRACK_UNSPECIFIED This is an unknown maintenance timing preference.
canary For an instance with a scheduled maintenance window, this maintenance timing indicates that the maintenance update is scheduled 7 to 14 days after the notification is sent out. Also referred to as Week 1 (Console) and preview (gcloud CLI).
stable For an instance with a scheduled maintenance window, this maintenance timing indicates that the maintenance update is scheduled 15 to 21 days after the notification is sent out. Also referred to as Week 2 (Console) and production (gcloud CLI).
week5 For instance with a scheduled maintenance window, this maintenance timing indicates that the maintenance update is scheduled 35 to 42 days after the notification is sent out.

BackupConfiguration

Database instance backup configuration.

JSON representation 
{
  "startTime": string,
  "enabled": boolean,
  "kind": string,
  "binaryLogEnabled": boolean,
  "replicationLogArchivingEnabled": boolean,
  "location": string,
  "pointInTimeRecoveryEnabled": boolean,
  "backupRetentionSettings": {
    object (BackupRetentionSettings)
  },
  "transactionLogRetentionDays": integer,
  "transactionalLogStorageState": enum (TransactionalLogStorageState)
}
Fields
startTime

string

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
enabled

boolean

Whether this configuration is enabled.
kind

string

This is always sql#backupConfiguration.
binaryLogEnabled

boolean

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
replicationLogArchivingEnabled

boolean

Reserved for future use.
location

string

Location of the backup
pointInTimeRecoveryEnabled

boolean

Whether point in time recovery is enabled.
backupRetentionSettings

object (BackupRetentionSettings)

Backup retention settings.
transactionLogRetentionDays

integer

The number of days of transaction logs we retain for point in time restore, from 1-7.
transactionalLogStorageState

enum (TransactionalLogStorageState)

Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.

BackupRetentionSettings

We currently only support backup retention by specifying the number of backups we will retain.

JSON representation 
{
  "retentionUnit": enum (RetentionUnit),
  "retainedBackups": integer
}
Fields
retentionUnit

enum (RetentionUnit)

The unit that 'retainedBackups' represents.
retainedBackups

integer

Depending on the value of retentionUnit, this is used to determine if a backup needs to be deleted. If retentionUnit is 'COUNT', we will retain this many backups.

RetentionUnit

The units that retainedBackups specifies, we only support COUNT.

Enums
RETENTION_UNIT_UNSPECIFIED Backup retention unit is unspecified, will be treated as COUNT.
COUNT Retention will be by count, eg. "retain the most recent 7 backups".

TransactionalLogStorageState

This value contains the storage location of the transactional logs used to perform point-in-time recovery (PITR) for the database.

Enums
TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED Unspecified.
DISK The transaction logs used for PITR for the instance are stored on a data disk.
SWITCHING_TO_CLOUD_STORAGE The transaction logs used for PITR for the instance are switching from being stored on a data disk to being stored in Cloud Storage. Only applicable to MySQL.
SWITCHED_TO_CLOUD_STORAGE The transaction logs used for PITR for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk. Only applicable to MySQL.
CLOUD_STORAGE The transaction logs used for PITR for the instance are stored in Cloud Storage. Only applicable to MySQL and PostgreSQL.

SqlActiveDirectoryConfig

Active Directory configuration, relevant only for Cloud SQL for SQL Server.

JSON representation 
{
  "kind": string,
  "domain": string
}
Fields
kind

string

This is always sql#activeDirectoryConfig.
domain

string

The name of the domain (e.g., mydomain.com).

DenyMaintenancePeriod

Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

JSON representation 
{
  "startDate": string,
  "endDate": string,
  "time": string
}
Fields
startDate

string

"deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
endDate

string

"deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
time

string

Time in UTC when the "deny maintenance period" starts on startDate and ends on endDate. The time is in format: HH:mm:SS, i.e., 00:00:00

InsightsConfig

Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.

JSON representation 
{
  "queryInsightsEnabled": boolean,
  "recordClientAddress": boolean,
  "recordApplicationTags": boolean,
  "queryStringLength": integer,
  "queryPlansPerMinute": integer
}
Fields
queryInsightsEnabled

boolean

Whether Query Insights feature is enabled.
recordClientAddress

boolean

Whether Query Insights will record client address when enabled.
recordApplicationTags

boolean

Whether Query Insights will record application tags from query when enabled.
queryStringLength

integer

Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
queryPlansPerMinute

integer

Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.

PasswordValidationPolicy

Database instance local user password validation policy

JSON representation 
{
  "minLength": integer,
  "complexity": enum (Complexity),
  "reuseInterval": integer,
  "disallowUsernameSubstring": boolean,
  "passwordChangeInterval": string,
  "enablePasswordPolicy": boolean
}
Fields
minLength

integer

Minimum number of characters allowed.
complexity

enum (Complexity)

The complexity of the password.
reuseInterval

integer

Number of previous passwords that cannot be reused.
disallowUsernameSubstring

boolean

Disallow username as a part of the password.
passwordChangeInterval

string (Duration format)

Minimum interval after which the password can be changed. This flag is only supported for PostgreSQL.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
enablePasswordPolicy

boolean

Whether the password policy is enabled or not.

Complexity

The complexity choices of the password.

Enums
COMPLEXITY_UNSPECIFIED Complexity check is not specified.
COMPLEXITY_DEFAULT A combination of lowercase, uppercase, numeric, and non-alphanumeric characters.

SqlServerAuditConfig

SQL Server specific audit configuration.

JSON representation 
{
  "kind": string,
  "bucket": string,
  "retentionInterval": string,
  "uploadInterval": string
}
Fields
kind

string

This is always sql#sqlServerAuditConfig
bucket

string

The name of the destination bucket (e.g., gs://mybucket).
retentionInterval

string (Duration format)

How long to keep generated audit files.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
uploadInterval

string (Duration format)

How often to upload generated audit files.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

Edition

The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.

Enums
EDITION_UNSPECIFIED The instance did not specify the edition.
ENTERPRISE The instance is an enterprise edition.
ENTERPRISE_PLUS The instance is an Enterprise Plus edition.

ConnectorEnforcement

The options for enforcing Cloud SQL connectors in the instance.

Enums
CONNECTOR_ENFORCEMENT_UNSPECIFIED The requirement for Cloud SQL connectors is unknown.
NOT_REQUIRED Do not require Cloud SQL connectors.
REQUIRED Require all connections to use Cloud SQL connectors, including the Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors. Note: This disables all existing authorized networks.

IpMapping

Database instance IP mapping

JSON representation 
{
  "type": enum (SqlIpAddressType),
  "ipAddress": string,
  "timeToRetire": string
}
Fields
type

enum (SqlIpAddressType)

The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.
ipAddress

string

The IP address assigned.
timeToRetire

string (Timestamp format)

The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.

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".

SqlIpAddressType

Enums
SQL_IP_ADDRESS_TYPE_UNSPECIFIED This is an unknown IP address type.
PRIMARY IP address the customer is supposed to connect to. Usually this is the load balancer's IP address
OUTGOING Source IP address of the connection a read replica establishes to its external primary instance. This IP address can be allowlisted by the customer in case it has a firewall that filters incoming connection to its on premises primary instance.
PRIVATE Private IP used when using private IPs and network peering.
MIGRATED_1ST_GEN V1 IP of a migrated instance. We want the user to decommission this IP as soon as the migration is complete. Note: V1 instances with V1 ip addresses will be counted as PRIMARY.

SqlInstanceType

Enums
SQL_INSTANCE_TYPE_UNSPECIFIED This is an unknown Cloud SQL instance type.
CLOUD_SQL_INSTANCE A regular Cloud SQL instance that is not replicating from a primary instance.
ON_PREMISES_INSTANCE An instance running on the customer's premises that is not managed by Cloud SQL.
READ_REPLICA_INSTANCE A Cloud SQL instance acting as a read-replica.

OnPremisesConfiguration

On-premises instance configuration.

JSON representation 
{
  "hostPort": string,
  "kind": string,
  "username": string,
  "password": string,
  "caCertificate": string,
  "clientCertificate": string,
  "clientKey": string,
  "dumpFilePath": string,
  "sourceInstance": {
    object (InstanceReference)
  }
}
Fields
hostPort

string

The host and port of the on-premises instance in host:port format
kind

string

This is always sql#onPremisesConfiguration.
username

string

The username for connecting to on-premises instance.
password

string

The password for connecting to on-premises instance.
caCertificate

string

PEM representation of the trusted CA's x509 certificate.
clientCertificate

string

PEM representation of the replica's x509 certificate.
clientKey

string

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
dumpFilePath

string

The dump file to create the Cloud SQL replica.
sourceInstance

object (InstanceReference)

The reference to Cloud SQL instance if the source is Cloud SQL.

InstanceReference

Reference to another Cloud SQL instance.

JSON representation 
{
  "name": string,
  "region": string,
  "project": string
}
Fields
name

string

The name of the Cloud SQL instance being referenced. This does not include the project ID.
region

string

The region of the Cloud SQL instance being referenced.
project

string

The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.

ReplicaConfiguration

Read-replica configuration for connecting to the primary instance.

JSON representation 
{
  "kind": string,
  "mysqlReplicaConfiguration": {
    object (MySqlReplicaConfiguration)
  },
  "failoverTarget": boolean
}
Fields
kind

string

This is always sql#replicaConfiguration.
mysqlReplicaConfiguration

object (MySqlReplicaConfiguration)

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
failoverTarget

boolean

Specifies if the replica is the failover target. If the field is set to true, the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

MySqlReplicaConfiguration

Read-replica configuration specific to MySQL databases.

JSON representation 
{
  "dumpFilePath": string,
  "username": string,
  "password": string,
  "connectRetryInterval": integer,
  "masterHeartbeatPeriod": string,
  "caCertificate": string,
  "clientCertificate": string,
  "clientKey": string,
  "sslCipher": string,
  "verifyServerCertificate": boolean,
  "kind": string
}
Fields
dumpFilePath

string

Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.
username

string

The username for the replication connection.
password

string

The password for the replication connection.
connectRetryInterval

integer

Seconds to wait between connect retries. MySQL's default is 60 seconds.
masterHeartbeatPeriod

string (Int64Value format)

Interval in milliseconds between replication heartbeats.
caCertificate

string

PEM representation of the trusted CA's x509 certificate.
clientCertificate

string

PEM representation of the replica's x509 certificate.
clientKey

string

PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
sslCipher

string

A list of permissible ciphers to use for SSL encryption.
verifyServerCertificate

boolean

Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
kind

string

This is always sql#mysqlReplicaConfiguration.

SqlBackendType

Enums
SQL_BACKEND_TYPE_UNSPECIFIED This is an unknown backend type for instance.
FIRST_GEN

V1 speckle instance.
SECOND_GEN V2 speckle instance.
EXTERNAL On premises instance.

SqlSuspensionReason

The suspension reason of the database instance if the state is SUSPENDED.

Enums
SQL_SUSPENSION_REASON_UNSPECIFIED This is an unknown suspension reason.
BILLING_ISSUE The instance is suspended due to billing issues (for example:, GCP account issue)
LEGAL_ISSUE The instance is suspended due to illegal content (for example:, child pornography, copyrighted material, etc.).
OPERATIONAL_ISSUE The instance is causing operational issues (for example:, causing the database to crash).
KMS_KEY_ISSUE The KMS key used by the instance is either revoked or denied access to

SqlScheduledMaintenance

Any scheduled maintenance for this instance.

JSON representation 
{
  "startTime": string,
  "canDefer": boolean,
  "canReschedule": boolean,
  "scheduleDeadlineTime": string
}
Fields
startTime

string (Timestamp format)

The start time of any upcoming scheduled maintenance for this instance.

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".
canDefer
(deprecated)

boolean
canReschedule

boolean

If the scheduled maintenance can be rescheduled.
scheduleDeadlineTime

string (Timestamp format)

Maintenance cannot be rescheduled to start beyond this deadline.

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".

SqlOutOfDiskReport

This message wraps up the information written by out-of-disk detection job.

JSON representation 
{
  "sqlOutOfDiskState": enum (SqlOutOfDiskState),
  "sqlMinRecommendedIncreaseSizeGb": integer
}
Fields
sqlOutOfDiskState

enum (SqlOutOfDiskState)

This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job

SqlOutOfDiskState

This enum lists all possible states regarding out-of-disk issues.

Enums
SQL_OUT_OF_DISK_STATE_UNSPECIFIED Unspecified state
NORMAL The instance has plenty space on data disk
SOFT_SHUTDOWN Data disk is almost used up. It is shutdown to prevent data corruption.

AvailableDatabaseVersion

An available database version. It can be a major or a minor version.

JSON representation 
{
  "majorVersion": string,
  "name": string,
  "displayName": string
}
Fields
majorVersion

string

The version's major version name.
name

string

The database version name. For MySQL 8.0, this string provides the database major and minor version.
displayName

string

The database version's display name.

SqlNetworkArchitecture

The SQL network architecture for the instance.

Enums
SQL_NETWORK_ARCHITECTURE_UNSPECIFIED
NEW_NETWORK_ARCHITECTURE The instance uses the new network architecture.
OLD_NETWORK_ARCHITECTURE The instance uses the old network architecture.

ReplicationCluster

A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.

JSON representation 
{
  "psaWriteEndpoint": string,
}
Fields
psaWriteEndpoint

string

Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After instances.switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.

GeminiInstanceConfig

Gemini instance configuration.

JSON representation 
{
  "entitled": boolean,
  "googleVacuumMgmtEnabled": boolean,
  "oomSessionCancelEnabled": boolean,
  "activeQueryEnabled": boolean,
  "indexAdvisorEnabled": boolean,
}
Fields
entitled

boolean

Output only. Whether Gemini is enabled.
googleVacuumMgmtEnabled

boolean

Output only. Whether the vacuum management is enabled.
oomSessionCancelEnabled

boolean

Output only. Whether canceling the out-of-memory (OOM) session is enabled.
activeQueryEnabled

boolean

Output only. Whether the active query is enabled.
indexAdvisorEnabled

boolean

Output only. Whether the index advisor is enabled.

Methods

ListServerCertificates

 Lists all versions of server certificates and certificate authorities (CAs) for the specified instance.

RotateServerCertificate

 Rotates the server certificate version to one previously added with the addServerCertificate method.

addServerCa

 Adds a new trusted Certificate Authority (CA) version for the specified instance.

addServerCertificate

 Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA.

clone

 Creates a Cloud SQL instance as a clone of the source instance.

delete

 Deletes a Cloud SQL instance.

demoteMaster

 Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

export

 Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

failover

 Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance.

get

 Retrieves a resource containing information about a Cloud SQL instance.

import

 Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

insert

 Creates a new Cloud SQL instance.

list

 Lists instances under a given project.

listServerCas

 Lists all of the trusted Certificate Authorities (CAs) for the specified instance.

patch

 Partially updates settings of a Cloud SQL instance by merging the request with the current configuration.

promoteReplica

 Promotes the read replica instance to be a stand-alone Cloud SQL instance.

reencrypt

 Reencrypt CMEK instance with latest key version.

resetSslConfig

 Deletes all client certificates and generates a new server SSL certificate for the instance.

restart

 Restarts a Cloud SQL instance.

restoreBackup

 Restores a backup of a Cloud SQL instance.

rotateServerCa

 Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

startReplica

 Starts the replication in the read replica instance.

stopReplica

 Stops the replication in the read replica instance.

truncateLog

 Truncate MySQL general and slow query log tables MySQL only.

update

 Updates settings of a Cloud SQL instance.