instances

Creates, updates, deletes, gets or lists a instances resource.

Overview

Name	instances
Type	Resource
Id	google.sqladmin.instances

Fields

Name	Datatype	Description
name	string	Name of the Cloud SQL instance. This does not include the project ID.
availableMaintenanceVersions	array	Output only. List all maintenance versions applicable on the instance
backendType	string	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.
connectionName	string	Connection name of the Cloud SQL instance used in connection strings.
createTime	string	Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
currentDiskSize	string	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.
databaseInstalledVersion	string	Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.
databaseVersion	string	The database engine type and version. The databaseVersion field cannot be changed after instance creation.
diskEncryptionConfiguration	object	Disk encryption configuration for an instance.
diskEncryptionStatus	object	Disk encryption status for an instance.
dnsName	string	Output only. The dns name of the instance.
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.
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.
geminiConfig	object	Gemini instance configuration.
instanceType	string	The instance type.
ipAddresses	array	The assigned IP addresses for the instance.
ipv6Address	string	The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
kind	string	This is always sql#instance.
maintenanceVersion	string	The current software version on the instance.
masterInstanceName	string	The name of the instance which will act as primary in the replication setup.
maxDiskSize	string	The maximum disk size of the instance in bytes.
onPremisesConfiguration	object	On-premises instance configuration.
outOfDiskReport	object	This message wraps up the information written by out-of-disk detection job.
primaryDnsName	string	Output only. DEPRECATED: please use write_endpoint instead.
project	string	The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
pscServiceAttachmentLink	string	Output only. The link to service attachment of PSC instance.
region	string	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.
replicaConfiguration	object	Read-replica configuration for connecting to the primary instance.
replicaNames	array	The replicas of the instance.
replicationCluster	object	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.
rootPassword	string	Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
satisfiesPzi	boolean	Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.
satisfiesPzs	boolean	This status indicates whether the instance satisfies PZS. The status is reserved for future use.
scheduledMaintenance	object	Any scheduled maintenance for this 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.
selfLink	string	The URI of this resource.
serverCaCert	object	SslCerts Resource
serviceAccountEmailAddress	string	The service account email address assigned to the instance.\This property is read-only.
settings	object	Database instance settings.
sqlNetworkArchitecture	string
state	string	The current serving state of the Cloud SQL instance.
suspensionReason	array	If the instance state is SUSPENDED, the reason for the suspension.
switchTransactionLogsToCloudStorageEnabled	boolean	Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
upgradableDatabaseVersions	array	Output only. All database versions that are available for upgrade.
writeEndpoint	string	Output only. The dns name of the primary instance in a replication group.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instance, project	Retrieves a resource containing information about a Cloud SQL instance.
list	SELECT	project	Lists instances under a given project.
insert	INSERT	project	Creates a new Cloud SQL instance.
delete	DELETE	instance, project	Deletes a Cloud SQL instance.
patch	UPDATE	instance, project	Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
update	REPLACE	instance, project	Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.
acquire_ssrs_lease	EXEC	instance, project	Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
clone	EXEC	instance, project	Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
demote	EXEC	instance, project	Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.
demote_master	EXEC	instance, project	Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
export	EXEC	instance, project	Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
failover	EXEC	instance, project	Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
import	EXEC	instance, project	Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.
list_server_certificates	EXEC	instance, project	Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
perform_disk_shrink	EXEC	instance, project	Perform Disk Shrink on primary instance.
promote_replica	EXEC	instance, project	Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
reencrypt	EXEC	instance, project	Reencrypt CMEK instance with latest key version.
release_ssrs_lease	EXEC	instance, project	Release a lease for the setup of SQL Server Reporting Services (SSRS).
reschedule_maintenance	EXEC	instance, project	Reschedules the maintenance on the given instance.
reset_replica_size	EXEC	instance, project	Reset Replica Size to primary instance disk size.
reset_ssl_config	EXEC	instance, project	Deletes all client certificates and generates a new server SSL certificate for the instance.
restart	EXEC	instance, project	Restarts a Cloud SQL instance.
restore_backup	EXEC	instance, project	Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.
rotate_server_ca	EXEC	instance, project	Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
rotate_server_certificate	EXEC	instance, project	Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.
start_external_sync	EXEC	instance, project	Start External primary instance migration.
start_replica	EXEC	instance, project	Starts the replication in the read replica instance.
stop_replica	EXEC	instance, project	Stops the replication in the read replica instance.
switchover	EXEC	instance, project	Switches over from the primary instance to the designated DR replica instance.
truncate_log	EXEC	instance, project	Truncate MySQL general and slow query log tables MySQL only.
verify_external_sync_settings	EXEC	instance, project	Verify External primary instance external sync settings.

SELECT examples

Lists instances under a given project.

SELECT
name,
availableMaintenanceVersions,
backendType,
connectionName,
createTime,
currentDiskSize,
databaseInstalledVersion,
databaseVersion,
diskEncryptionConfiguration,
diskEncryptionStatus,
dnsName,
etag,
failoverReplica,
gceZone,
geminiConfig,
instanceType,
ipAddresses,
ipv6Address,
kind,
maintenanceVersion,
masterInstanceName,
maxDiskSize,
onPremisesConfiguration,
outOfDiskReport,
primaryDnsName,
project,
pscServiceAttachmentLink,
region,
replicaConfiguration,
replicaNames,
replicationCluster,
rootPassword,
satisfiesPzi,
satisfiesPzs,
scheduledMaintenance,
secondaryGceZone,
selfLink,
serverCaCert,
serviceAccountEmailAddress,
settings,
sqlNetworkArchitecture,
state,
suspensionReason,
switchTransactionLogsToCloudStorageEnabled,
upgradableDatabaseVersions,
writeEndpoint
FROM google.sqladmin.instances
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new instances resource.

All Properties

/*+ create */
INSERT INTO google.sqladmin.instances (
project,
state,
databaseVersion,
settings,
etag,
failoverReplica,
masterInstanceName,
replicaNames,
maxDiskSize,
currentDiskSize,
ipAddresses,
serverCaCert,
instanceType,
project,
ipv6Address,
serviceAccountEmailAddress,
onPremisesConfiguration,
replicaConfiguration,
backendType,
suspensionReason,
connectionName,
name,
region,
gceZone,
secondaryGceZone,
diskEncryptionConfiguration,
diskEncryptionStatus,
rootPassword,
scheduledMaintenance,
satisfiesPzs,
outOfDiskReport,
maintenanceVersion,
sqlNetworkArchitecture,
replicationCluster,
geminiConfig,
switchTransactionLogsToCloudStorageEnabled
)
SELECT 
'{{ project }}',
'{{ state }}',
'{{ databaseVersion }}',
'{{ settings }}',
'{{ etag }}',
'{{ failoverReplica }}',
'{{ masterInstanceName }}',
'{{ replicaNames }}',
'{{ maxDiskSize }}',
'{{ currentDiskSize }}',
'{{ ipAddresses }}',
'{{ serverCaCert }}',
'{{ instanceType }}',
'{{ project }}',
'{{ ipv6Address }}',
'{{ serviceAccountEmailAddress }}',
'{{ onPremisesConfiguration }}',
'{{ replicaConfiguration }}',
'{{ backendType }}',
'{{ suspensionReason }}',
'{{ connectionName }}',
'{{ name }}',
'{{ region }}',
'{{ gceZone }}',
'{{ secondaryGceZone }}',
'{{ diskEncryptionConfiguration }}',
'{{ diskEncryptionStatus }}',
'{{ rootPassword }}',
'{{ scheduledMaintenance }}',
{{ satisfiesPzs }},
'{{ outOfDiskReport }}',
'{{ maintenanceVersion }}',
'{{ sqlNetworkArchitecture }}',
'{{ replicationCluster }}',
'{{ geminiConfig }}',
{{ switchTransactionLogsToCloudStorageEnabled }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: state
      value: string
    - name: databaseVersion
      value: string
    - name: settings
      value:
        - name: settingsVersion
          value: string
        - name: authorizedGaeApplications
          value:
            - string
        - name: tier
          value: string
        - name: kind
          value: string
        - name: userLabels
          value: object
        - name: availabilityType
          value: string
        - name: pricingPlan
          value: string
        - name: replicationType
          value: string
        - name: storageAutoResizeLimit
          value: string
        - name: activationPolicy
          value: string
        - name: ipConfiguration
          value:
            - name: ipv4Enabled
              value: boolean
            - name: privateNetwork
              value: string
            - name: requireSsl
              value: boolean
            - name: authorizedNetworks
              value:
                - - name: value
                    value: string
                  - name: expirationTime
                    value: string
                  - name: name
                    value: string
                  - name: kind
                    value: string
            - name: allocatedIpRange
              value: string
            - name: enablePrivatePathForGoogleCloudServices
              value: boolean
            - name: sslMode
              value: string
            - name: pscConfig
              value:
                - name: pscEnabled
                  value: boolean
                - name: allowedConsumerProjects
                  value:
                    - string
            - name: serverCaMode
              value: string
        - name: storageAutoResize
          value: boolean
        - name: locationPreference
          value:
            - name: followGaeApplication
              value: string
            - name: zone
              value: string
            - name: secondaryZone
              value: string
            - name: kind
              value: string
        - name: databaseFlags
          value:
            - - name: name
                value: string
              - name: value
                value: string
        - name: dataDiskType
          value: string
        - name: maintenanceWindow
          value:
            - name: hour
              value: integer
            - name: day
              value: integer
            - name: updateTrack
              value: string
            - name: kind
              value: string
        - name: backupConfiguration
          value:
            - name: startTime
              value: string
            - name: enabled
              value: boolean
            - name: kind
              value: string
            - name: binaryLogEnabled
              value: boolean
            - name: replicationLogArchivingEnabled
              value: boolean
            - name: location
              value: string
            - name: pointInTimeRecoveryEnabled
              value: boolean
            - name: backupRetentionSettings
              value:
                - name: retentionUnit
                  value: string
                - name: retainedBackups
                  value: integer
            - name: transactionLogRetentionDays
              value: integer
            - name: transactionalLogStorageState
              value: string
        - name: databaseReplicationEnabled
          value: boolean
        - name: crashSafeReplicationEnabled
          value: boolean
        - name: dataDiskSizeGb
          value: string
        - name: activeDirectoryConfig
          value:
            - name: kind
              value: string
            - name: domain
              value: string
        - name: collation
          value: string
        - name: denyMaintenancePeriods
          value:
            - - name: startDate
                value: string
              - name: endDate
                value: string
              - name: time
                value: string
        - name: insightsConfig
          value:
            - name: queryInsightsEnabled
              value: boolean
            - name: recordClientAddress
              value: boolean
            - name: recordApplicationTags
              value: boolean
            - name: queryStringLength
              value: integer
            - name: queryPlansPerMinute
              value: integer
        - name: passwordValidationPolicy
          value:
            - name: minLength
              value: integer
            - name: complexity
              value: string
            - name: reuseInterval
              value: integer
            - name: disallowUsernameSubstring
              value: boolean
            - name: passwordChangeInterval
              value: string
            - name: enablePasswordPolicy
              value: boolean
            - name: disallowCompromisedCredentials
              value: boolean
        - name: sqlServerAuditConfig
          value:
            - name: kind
              value: string
            - name: bucket
              value: string
            - name: retentionInterval
              value: string
            - name: uploadInterval
              value: string
        - name: edition
          value: string
        - name: connectorEnforcement
          value: string
        - name: deletionProtectionEnabled
          value: boolean
        - name: timeZone
          value: string
        - name: advancedMachineFeatures
          value:
            - name: threadsPerCore
              value: integer
        - name: dataCacheConfig
          value:
            - name: dataCacheEnabled
              value: boolean
        - name: enableGoogleMlIntegration
          value: boolean
        - name: enableDataplexIntegration
          value: boolean
    - name: etag
      value: string
    - name: failoverReplica
      value:
        - name: name
          value: string
        - name: available
          value: boolean
    - name: masterInstanceName
      value: string
    - name: replicaNames
      value:
        - string
    - name: maxDiskSize
      value: string
    - name: currentDiskSize
      value: string
    - name: ipAddresses
      value:
        - - name: type
            value: string
          - name: ipAddress
            value: string
          - name: timeToRetire
            value: string
    - name: serverCaCert
      value:
        - name: kind
          value: string
        - name: certSerialNumber
          value: string
        - name: cert
          value: string
        - name: createTime
          value: string
        - name: commonName
          value: string
        - name: expirationTime
          value: string
        - name: sha1Fingerprint
          value: string
        - name: instance
          value: string
        - name: selfLink
          value: string
    - name: instanceType
      value: string
    - name: project
      value: string
    - name: ipv6Address
      value: string
    - name: serviceAccountEmailAddress
      value: string
    - name: onPremisesConfiguration
      value:
        - name: hostPort
          value: string
        - name: kind
          value: string
        - name: username
          value: string
        - name: password
          value: string
        - name: caCertificate
          value: string
        - name: clientCertificate
          value: string
        - name: clientKey
          value: string
        - name: dumpFilePath
          value: string
        - name: sourceInstance
          value:
            - name: name
              value: string
            - name: region
              value: string
            - name: project
              value: string
    - name: replicaConfiguration
      value:
        - name: kind
          value: string
        - name: mysqlReplicaConfiguration
          value:
            - name: dumpFilePath
              value: string
            - name: username
              value: string
            - name: password
              value: string
            - name: connectRetryInterval
              value: integer
            - name: masterHeartbeatPeriod
              value: string
            - name: caCertificate
              value: string
            - name: clientCertificate
              value: string
            - name: clientKey
              value: string
            - name: sslCipher
              value: string
            - name: verifyServerCertificate
              value: boolean
            - name: kind
              value: string
        - name: failoverTarget
          value: boolean
        - name: cascadableReplica
          value: boolean
    - name: backendType
      value: string
    - name: selfLink
      value: string
    - name: suspensionReason
      value:
        - string
    - name: connectionName
      value: string
    - name: name
      value: string
    - name: region
      value: string
    - name: gceZone
      value: string
    - name: secondaryGceZone
      value: string
    - name: diskEncryptionConfiguration
      value:
        - name: kmsKeyName
          value: string
        - name: kind
          value: string
    - name: diskEncryptionStatus
      value:
        - name: kmsKeyVersionName
          value: string
        - name: kind
          value: string
    - name: rootPassword
      value: string
    - name: scheduledMaintenance
      value:
        - name: startTime
          value: string
        - name: canDefer
          value: boolean
        - name: canReschedule
          value: boolean
        - name: scheduleDeadlineTime
          value: string
    - name: satisfiesPzs
      value: boolean
    - name: databaseInstalledVersion
      value: string
    - name: outOfDiskReport
      value:
        - name: sqlOutOfDiskState
          value: string
        - name: sqlMinRecommendedIncreaseSizeGb
          value: integer
    - name: createTime
      value: string
    - name: availableMaintenanceVersions
      value:
        - string
    - name: maintenanceVersion
      value: string
    - name: upgradableDatabaseVersions
      value:
        - - name: majorVersion
            value: string
          - name: name
            value: string
          - name: displayName
            value: string
    - name: sqlNetworkArchitecture
      value: string
    - name: pscServiceAttachmentLink
      value: string
    - name: dnsName
      value: string
    - name: primaryDnsName
      value: string
    - name: writeEndpoint
      value: string
    - name: replicationCluster
      value:
        - name: psaWriteEndpoint
          value: string
        - name: failoverDrReplicaName
          value: string
        - name: drReplica
          value: boolean
    - name: geminiConfig
      value:
        - name: entitled
          value: boolean
        - name: googleVacuumMgmtEnabled
          value: boolean
        - name: oomSessionCancelEnabled
          value: boolean
        - name: activeQueryEnabled
          value: boolean
        - name: indexAdvisorEnabled
          value: boolean
        - name: flagRecommenderEnabled
          value: boolean
    - name: satisfiesPzi
      value: boolean
    - name: switchTransactionLogsToCloudStorageEnabled
      value: boolean

UPDATE example

Updates a instances resource.

/*+ update */
UPDATE google.sqladmin.instances
SET 
state = '{{ state }}',
databaseVersion = '{{ databaseVersion }}',
settings = '{{ settings }}',
etag = '{{ etag }}',
failoverReplica = '{{ failoverReplica }}',
masterInstanceName = '{{ masterInstanceName }}',
replicaNames = '{{ replicaNames }}',
maxDiskSize = '{{ maxDiskSize }}',
currentDiskSize = '{{ currentDiskSize }}',
ipAddresses = '{{ ipAddresses }}',
serverCaCert = '{{ serverCaCert }}',
instanceType = '{{ instanceType }}',
project = '{{ project }}',
ipv6Address = '{{ ipv6Address }}',
serviceAccountEmailAddress = '{{ serviceAccountEmailAddress }}',
onPremisesConfiguration = '{{ onPremisesConfiguration }}',
replicaConfiguration = '{{ replicaConfiguration }}',
backendType = '{{ backendType }}',
suspensionReason = '{{ suspensionReason }}',
connectionName = '{{ connectionName }}',
name = '{{ name }}',
region = '{{ region }}',
gceZone = '{{ gceZone }}',
secondaryGceZone = '{{ secondaryGceZone }}',
diskEncryptionConfiguration = '{{ diskEncryptionConfiguration }}',
diskEncryptionStatus = '{{ diskEncryptionStatus }}',
rootPassword = '{{ rootPassword }}',
scheduledMaintenance = '{{ scheduledMaintenance }}',
satisfiesPzs = true|false,
outOfDiskReport = '{{ outOfDiskReport }}',
maintenanceVersion = '{{ maintenanceVersion }}',
sqlNetworkArchitecture = '{{ sqlNetworkArchitecture }}',
replicationCluster = '{{ replicationCluster }}',
geminiConfig = '{{ geminiConfig }}',
switchTransactionLogsToCloudStorageEnabled = true|false
WHERE 
instance = '{{ instance }}'
AND project = '{{ project }}';

REPLACE example

Replaces all fields in the specified instances resource.

/*+ update */
REPLACE google.sqladmin.instances
SET 
state = '{{ state }}',
databaseVersion = '{{ databaseVersion }}',
settings = '{{ settings }}',
etag = '{{ etag }}',
failoverReplica = '{{ failoverReplica }}',
masterInstanceName = '{{ masterInstanceName }}',
replicaNames = '{{ replicaNames }}',
maxDiskSize = '{{ maxDiskSize }}',
currentDiskSize = '{{ currentDiskSize }}',
ipAddresses = '{{ ipAddresses }}',
serverCaCert = '{{ serverCaCert }}',
instanceType = '{{ instanceType }}',
project = '{{ project }}',
ipv6Address = '{{ ipv6Address }}',
serviceAccountEmailAddress = '{{ serviceAccountEmailAddress }}',
onPremisesConfiguration = '{{ onPremisesConfiguration }}',
replicaConfiguration = '{{ replicaConfiguration }}',
backendType = '{{ backendType }}',
suspensionReason = '{{ suspensionReason }}',
connectionName = '{{ connectionName }}',
name = '{{ name }}',
region = '{{ region }}',
gceZone = '{{ gceZone }}',
secondaryGceZone = '{{ secondaryGceZone }}',
diskEncryptionConfiguration = '{{ diskEncryptionConfiguration }}',
diskEncryptionStatus = '{{ diskEncryptionStatus }}',
rootPassword = '{{ rootPassword }}',
scheduledMaintenance = '{{ scheduledMaintenance }}',
satisfiesPzs = true|false,
outOfDiskReport = '{{ outOfDiskReport }}',
maintenanceVersion = '{{ maintenanceVersion }}',
sqlNetworkArchitecture = '{{ sqlNetworkArchitecture }}',
replicationCluster = '{{ replicationCluster }}',
geminiConfig = '{{ geminiConfig }}',
switchTransactionLogsToCloudStorageEnabled = true|false
WHERE 
instance = '{{ instance }}'
AND project = '{{ project }}';

DELETE example

Deletes the specified instances resource.

/*+ delete */
DELETE FROM google.sqladmin.instances
WHERE instance = '{{ instance }}'
AND project = '{{ project }}';