Blame - docs/dyn/sqladmin_v1.instances.html - platform/external/python/google-api-python-client

filter: string, A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

99

maxResults: integer, The maximum number of results to return per response.

100

pageToken: string, A previously-returned page token representing part of the larger set of results to view.

101

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

108

109

{ # Database instances list response.

110

"items": [ # List of database instance resources.

111

{ # A Cloud SQL instance resource.

112

"backendType": "A String", # *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.

113

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.

114

"currentDiskSize": "A 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.

115

"databaseVersion": "A String", # 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*, or *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.

116

"diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.

117

"kind": "A String", # This is always **sql#diskEncryptionConfiguration**.

118

"kmsKeyName": "A String", # Resource name of KMS key for disk encryption

119

},

120

"diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.

121

"kind": "A String", # This is always **sql#diskEncryptionStatus**.

122

"kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource

123

},

124

"encryptedRootPassword": "A String", # For internal usage only. The encrypted password.

125

"etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.

126

"failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.

127

"available": True or False, # 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.

128

"failoverInstance": { # Reference to another Cloud SQL instance. # A reference to the failover replica. If specified at instance creation, a failover replica is created for the instance. Currently, the failover replica can only be created in the same region as the primary instance.

129

"name": "A String", # The name of the Cloud SQL instance being referenced.

130

"region": "A String", # The region of the Cloud SQL instance being referenced.

131

},

132

"name": "A 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. This property is applicable only to Second Generation instances.

133

},

134

"gceZone": "A 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.

135

"installedVersion": "A String", # installed_version stores the current fully resolved database version including minor version such as MySQL_5.6.50

136

"instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.

137

"instanceUid": "A String", # Uid of the Cloud SQL instance. Used by Pantheon to check instance is created

138

"ipAddresses": [ # The assigned IP addresses for the instance.

139

{ # Database instance IP Mapping.

140

"ipAddress": "A String", # The IP address assigned.

141

"timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.

142

"type": "A String", # 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.

143

},

144

],

145

"ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

146

"kind": "A String", # This is always *sql#instance*.

147

"masterInstance": { # Reference to another Cloud SQL instance. # The reference to the instance which will act as primary in the replication setup.

148

"name": "A String", # The name of the Cloud SQL instance being referenced.

149

"region": "A String", # The region of the Cloud SQL instance being referenced.

150

},

151

"masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.

152

"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.

153

"name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.

154

"onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.

155

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

156

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

157

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

158

"dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.

159

"hostPort": "A String", # The host and port of the on-premises instance in host:port format

160

"kind": "A String", # This is always *sql#onPremisesConfiguration*.

161

"password": "A String", # The password for connecting to on-premises instance.

162

"username": "A String", # The username for connecting to on-premises instance.

163

},

164

"outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 Pantheon frontend -- the proactive database wellness job

165

"sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend

166

"sqlOutOfDiskState": "A String", # 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 Pantheon frontend -- the proactive database wellness job

167

},

168

"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

169

"region": "A 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.

170

"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.

171

"failoverTarget": True or False, # 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.

172

"kind": "A String", # This is always *sql#replicaConfiguration*.

173

"mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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.

174

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.

175

"clientCertificate": "A String", # PEM representation of the replica's x509 certificate.

176

"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.

177

"connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.

178

"dumpFilePath": "A 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.

179

"kind": "A String", # This is always **sql#mysqlReplicaConfiguration**.

180

"masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.

181

"password": "A String", # The password for the replication connection.

182

"sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.

183

"username": "A String", # The username for the replication connection.

184

"verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.

185

},

186

},

187

"replicaInstances": [ # The replicas of the instance.

188

{ # Reference to another Cloud SQL instance.

189

"name": "A String", # The name of the Cloud SQL instance being referenced.

190

"region": "A String", # The region of the Cloud SQL instance being referenced.

191

},

192

],

193

"replicaNames": [ # The replicas of the instance.

194

"A String",

195

],

196

"rootPassword": "A String", # Initial root password. Use only on creation.

197

"satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.

198

"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.

199

"canDefer": True or False,

200

"canReschedule": True or False, # If the scheduled maintenance can be rescheduled.

201

"scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.

202

"startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.

203

},

204

"secondaryGceZone": "A 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. Reserved for future use.

205

"selfLink": "A String", # The URI of this resource.

206

"serverCaCert": { # SslCerts Resource # SSL configuration.

207

"cert": "A String", # PEM representation.

208

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

209

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

210

"createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**

211

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

212

"instance": "A String", # Name of the database instance.

213

"kind": "A String", # This is always sql#sslCert.

214

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

215

},

216

"serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.

217

"settings": { # Database instance settings. # The user settings.

218

"activationPolicy": "A String", # 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.

219

"activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.

220

"domain": "A String", # The name of the domain (e.g., mydomain.com).

221

"kind": "A String", # This is always sql#activeDirectoryConfig.

222

},

223

"availabilityType": "A String", # 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](/sql/docs/postgres/high-availability).

224

"backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.

225

"backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.

226

"retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

227

"retentionUnit": "A String", # The unit that 'retained_backups' represents.

228

},

229

"binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

230

"enabled": True or False, # Whether this configuration is enabled.

231

"kind": "A String", # This is always **sql#backupConfiguration**.

232

"location": "A String", # Location of the backup

233

"pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.

234

"replicationLogArchivingEnabled": True or False, # Reserved for future use.

235

"startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**.

236

"transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.

237

},

238

"collation": "A String", # The name of server Instance collation.

239

"crashSafeReplicationEnabled": True or False, # 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.

240

"dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.

241

"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.

242

"databaseFlags": [ # The database flags passed to the instance at startup.

243

{ # Database flags for Cloud SQL instances.

244

"name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](/sql/docs/mysql/flags) in the Cloud SQL documentation.

245

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.

246

},

247

],

248

"databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.

249

"denyMaintenancePeriods": [ # Deny maintenance periods

250

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

251

"endDate": "A 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

252

"startDate": "A 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 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

253

"time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

254

},

255

],

256

"insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.

257

"queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.

258

"queryPlansPerMinute": 42, # Number of query plans generated by Insights per minute. Default is 5. Changing this will restart the database.

259

"queryStringLength": 42, # 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.

260

"recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.

261

"recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.

262

},

263

"ipConfiguration": { # IP Management configuration. # 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.

264

"authorizedNetworks": [ # 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: **192.168.100.0/24**).

265

{ # An entry for an Access Control list.

266

"expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

267

"kind": "A String", # This is always **sql#aclEntry**.

268

"name": "A String", # Optional. A label to identify this entry.

269

"value": "A String", # The allowlisted value for the access control list.

270

},

271

],

272

"ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.

273

"privateNetwork": "A 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.

274

"requireSsl": True or False, # Whether SSL connections over IP are enforced or not.

275

},

276

"kind": "A String", # This is always **sql#settings**.

277

"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. # The location preference settings. This allows the instance to be located as near as possible to Compute Engine zone for better performance.

278

"kind": "A String", # This is always **sql#locationPreference**.

279

"secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.

280

"zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).

281

},

282

"maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

283

"day": 42, # day of week (1-7), starting on Monday.

284

"hour": 42, # hour of day - 0 to 23.

285

"kind": "A String", # This is always **sql#maintenanceWindow**.

286

"updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/instance-settings#maintenance-timing-2ndgen).

287

},

288

"pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances.

289

"replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances.

290

"settingsVersion": "A String", # 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.

291

"storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.

292

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

293

"tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.

294

"userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.

"a_key": "A String",

},

},

"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *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 instance creation failed.

299

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.

"A String",

],

},

],

"kind": "A String", # This is always *sql#instancesList*.

305

"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

306

"warnings": [ # List of warnings that occurred while handling the request.

307

{ # An Admin API warning message.

308

"code": "A String", # Code to uniquely identify the warning type.

309

"message": "A String", # The warning message.

310

"region": "A String", # The region name for REGION_UNREACHABLE warning.

311

},