instances

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.
pscServiceAttachmentLink	string	Output only. The link to service attachment of PSC instance.
createTime	string	Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
databaseInstalledVersion	string	Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.
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.
diskEncryptionStatus	object	Disk encryption status for an instance.
rootPassword	string	Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
diskEncryptionConfiguration	object	Disk encryption configuration for an instance.
dnsName	string	Output only. The dns name of the instance.
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.
selfLink	string	The URI of this resource.
scheduledMaintenance	object	Any scheduled maintenance for this instance.
maintenanceVersion	string	The current software version on the instance.
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.
maxDiskSize	string	The maximum disk size of the instance in bytes.
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.
etag	string	This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
availableMaintenanceVersions	array	Output only. List all maintenance versions applicable on the instance
databaseVersion	string	The database engine type and version. The databaseVersion field cannot be changed after instance creation.
serviceAccountEmailAddress	string	The service account email address assigned to the instance.\This property is read-only.
project	string	The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
settings	object	Database instance settings.
state	string	The current serving state of the Cloud SQL instance.
suspensionReason	array	If the instance state is SUSPENDED, the reason for the suspension.
replicaConfiguration	object	Read-replica configuration for connecting to the primary instance.
failoverReplica	object	The name and status of the failover replica.
connectionName	string	Connection name of the Cloud SQL instance used in connection strings.
onPremisesConfiguration	object	On-premises instance configuration.
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.
replicaNames	array	The replicas of the instance.
serverCaCert	object	SslCerts Resource
masterInstanceName	string	The name of the instance which will act as primary in the replication setup.
ipAddresses	array	The assigned IP addresses for 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.
outOfDiskReport	object	This message wraps up the information written by out-of-disk detection job.
satisfiesPzs	boolean	The status indicating if instance satisfiesPzs. Reserved for future use.
instanceType	string	The instance type.

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.
_list	EXEC	project	Lists instances under a given project.
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_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.
patch	EXEC	instance, project	Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
perform_disk_shrink	EXEC	instance, project	Perform Disk Shrink on primary instance.
promote_replica	EXEC	instance, project	Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.
reencrypt	EXEC	instance, project	Reencrypt CMEK instance with latest key version.
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.
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.
truncate_log	EXEC	instance, project	Truncate MySQL general and slow query log tables MySQL only.
update	EXEC	instance, project	Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.
verify_external_sync_settings	EXEC	instance, project	Verify External primary instance external sync settings.