{ "batchPath": "batch", "canonicalName": "SQL Admin", "name": "sqladmin", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "endpoints": [ { "endpointUrl": "https://sqladmin.us-east7.rep.googleapis.com/", "location": "us-east7", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" }, { "location": "europe-north1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.europe-north1.rep.googleapis.com/" }, { "location": "us-west2", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.us-west2.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.asia-east2.rep.googleapis.com/", "location": "asia-east2", "description": "Regional Endpoint" }, { "location": "europe-west3", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.europe-west3.rep.googleapis.com/" }, { "location": "us-east1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.us-east1.rep.googleapis.com/" }, { "location": "asia-east1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.asia-east1.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2", "description": "Regional Endpoint" }, { "location": "me-central1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.me-central1.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.europe-central2.rep.googleapis.com/", "location": "europe-central2", "description": "Regional Endpoint" }, { "location": "northamerica-south1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.northamerica-south1.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.us-west8.rep.googleapis.com/", "location": "us-west8", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.me-west1.rep.googleapis.com/", "location": "me-west1", "description": "Regional Endpoint" }, { "location": "asia-northeast3", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.asia-northeast3.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.us-west1.rep.googleapis.com/", "location": "us-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.europe-west9.rep.googleapis.com/", "location": "europe-west9", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.asia-southeast3.rep.googleapis.com/", "location": "asia-southeast3", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.europe-west1.rep.googleapis.com/", "location": "europe-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.asia-southeast1.rep.googleapis.com/", "location": "asia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.us-west4.rep.googleapis.com/", "location": "us-west4", "description": "Regional Endpoint" }, { "location": "europe-west12", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.europe-west12.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "location": "australia-southeast1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.australia-southeast1.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.europe-west6.rep.googleapis.com/", "location": "europe-west6", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.us-east4.rep.googleapis.com/", "location": "us-east4", "description": "Regional Endpoint" }, { "location": "asia-southeast2", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.asia-southeast2.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1", "description": "Regional Endpoint" }, { "location": "europe-west8", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.europe-west8.rep.googleapis.com/" }, { "location": "africa-south1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.africa-south1.rep.googleapis.com/" }, { "location": "me-central2", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.me-central2.rep.googleapis.com/" }, { "location": "us-central1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.us-central1.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.us-central2.rep.googleapis.com/", "location": "us-central2", "description": "Regional Endpoint" }, { "location": "europe-north2", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.europe-north2.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.europe-west2.rep.googleapis.com/", "location": "europe-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://sqladmin.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1", "description": "Regional Endpoint" }, { "location": "us-east5", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.us-east5.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.asia-south1.rep.googleapis.com/", "location": "asia-south1", "description": "Regional Endpoint" }, { "location": "europe-west4", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.europe-west4.rep.googleapis.com/" }, { "location": "us-west3", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.us-west3.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "location": "southamerica-west1", "description": "Regional Endpoint", "endpointUrl": "https://sqladmin.southamerica-west1.rep.googleapis.com/" }, { "endpointUrl": "https://sqladmin.europe-west10.rep.googleapis.com/", "location": "europe-west10", "description": "Regional Endpoint" } ], "servicePath": "", "basePath": "", "ownerDomain": "google.com", "schemas": { "DnsNameMapping": { "description": "DNS metadata.", "type": "object", "id": "DnsNameMapping", "properties": { "name": { "description": "Output only. The DNS name.", "type": "string", "readOnly": true }, "recordManager": { "description": "Output only. The manager for this DNS record.", "enum": [ "RECORD_MANAGER_UNSPECIFIED", "CUSTOMER", "CLOUD_SQL_AUTOMATION" ], "type": "string", "readOnly": true, "enumDescriptions": [ "Record manager not set. This value should not be used.", "The record may be managed by the customer. It is not automatically managed by Cloud SQL automation.", "The record is managed by Cloud SQL, which will create, update, and delete the DNS records for the zone automatically when the Cloud SQL database instance is created or updated." ] }, "connectionType": { "description": "Output only. The connection type of the DNS name.", "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "PUBLIC", "PRIVATE_SERVICES_ACCESS", "PRIVATE_SERVICE_CONNECT" ], "readOnly": true, "enumDescriptions": [ "Unknown connection type.", "Public IP.", "Private services access (private IP).", "Private Service Connect." ], "type": "string" }, "dnsScope": { "readOnly": true, "enumDescriptions": [ "DNS scope not set. This value should not be used.", "Indicates an instance-level DNS name.", "Indicates a cluster-level DNS name." ], "type": "string", "description": "Output only. The scope that the DNS name applies to.", "enum": [ "DNS_SCOPE_UNSPECIFIED", "INSTANCE", "CLUSTER" ] } } }, "DemoteMasterContext": { "description": "Database instance demote primary instance context.", "type": "object", "id": "DemoteMasterContext", "properties": { "replicaConfiguration": { "description": "Configuration specific to read-replicas replicating from the on-premises primary instance.", "$ref": "DemoteMasterConfiguration" }, "skipReplicationSetup": { "description": "Flag to skip replication setup on the instance.", "type": "boolean" }, "kind": { "description": "This is always `sql#demoteMasterContext`.", "type": "string" }, "verifyGtidConsistency": { "description": "Verify the GTID consistency for demote operation. Default value: `True`. Setting this flag to `false` enables you to bypass the GTID consistency check between on-premises primary instance and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.", "type": "boolean" }, "masterInstanceName": { "description": "The name of the instance which will act as on-premises primary instance in the replication setup.", "type": "string" } } }, "ConnectPoolNodeConfig": { "description": "Details of a single read pool node of a read pool.", "type": "object", "id": "ConnectPoolNodeConfig", "properties": { "name": { "readOnly": true, "description": "Output only. The name of the read pool node. Doesn't include the project ID.", "type": "string" }, "dnsName": { "readOnly": true, "description": "Output only. The DNS name of the read pool node.", "type": "string" }, "ipAddresses": { "description": "Output only. Mappings containing IP addresses that can be used to connect to the read pool node.", "type": "array", "items": { "$ref": "IpMapping" }, "readOnly": true }, "dnsNames": { "items": { "$ref": "DnsNameMapping" }, "description": "Output only. The list of DNS names used by this read pool node.", "type": "array", "readOnly": true } } }, "InstancesRotateServerCaRequest": { "id": "InstancesRotateServerCaRequest", "properties": { "rotateServerCaContext": { "description": "Contains details about the rotate server CA operation.", "$ref": "RotateServerCaContext" } }, "description": "Rotate server CA request.", "type": "object" }, "SqlInstancesResetReplicaSizeRequest": { "description": "Instance reset replica size request.", "type": "object", "id": "SqlInstancesResetReplicaSizeRequest", "properties": {} }, "ConnectSettings": { "id": "ConnectSettings", "properties": { "backendType": { "enumDescriptions": [ "This is an unknown backend type for instance.", "V1 speckle instance.", "V2 speckle instance.", "On premises instance." ], "type": "string", "description": "`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.", "enumDeprecated": [ false, true, false, false ], "enum": [ "SQL_BACKEND_TYPE_UNSPECIFIED", "FIRST_GEN", "SECOND_GEN", "EXTERNAL" ] }, "nodeCount": { "format": "int32", "description": "The number of read pool nodes in a read pool.", "type": "integer" }, "mdxProtocolSupport": { "readOnly": true, "description": "Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty.", "type": "array", "items": { "enumDescriptions": [ "Not specified.", "Client should send the client protocol type in the MDX request." ], "type": "string", "enum": [ "MDX_PROTOCOL_SUPPORT_UNSPECIFIED", "CLIENT_PROTOCOL_TYPE" ] } }, "databaseVersion": { "type": "string", "enumDescriptions": [ "This is an unknown database version.", "The database version is MySQL 5.1.", "The database version is MySQL 5.5.", "The database version is MySQL 5.6.", "The database version is MySQL 5.7.", "The database version is MySQL 8.", "The database major version is MySQL 8.0 and the minor version is 18.", "The database major version is MySQL 8.0 and the minor version is 26.", "The database major version is MySQL 8.0 and the minor version is 27.", "The database major version is MySQL 8.0 and the minor version is 28.", "The database major version is MySQL 8.0 and the minor version is 29.", "The database major version is MySQL 8.0 and the minor version is 30.", "The database major version is MySQL 8.0 and the minor version is 31.", "The database major version is MySQL 8.0 and the minor version is 32.", "The database major version is MySQL 8.0 and the minor version is 33.", "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", "The database major version is MySQL 8.0 and the minor version is 37.", "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", "The database major version is MySQL 8.0 and the minor version is 43.", "The database major version is MySQL 8.0 and the minor version is 44.", "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", "The database version is SQL Server 2017 Web.", "The database version is PostgreSQL 9.6.", "The database version is PostgreSQL 10.", "The database version is PostgreSQL 11.", "The database version is PostgreSQL 12.", "The database version is PostgreSQL 13.", "The database version is PostgreSQL 14.", "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", "The database version is PostgreSQL 18.", "The database version is PostgreSQL 19.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", "The database version is SQL Server 2019 Web.", "The database version is SQL Server 2022 Standard.", "The database version is SQL Server 2022 Enterprise.", "The database version is SQL Server 2022 Express.", "The database version is SQL Server 2022 Web.", "The database version is SQL Server 2025 Standard.", "The database version is SQL Server 2025 Enterprise.", "The database version is SQL Server 2025 Express." ], "description": "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` (default), `POSTGRES_13`, or `POSTGRES_14`. SQL Server instances: `SQLSERVER_2017_STANDARD` (default), `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`.", "enumDeprecated": [ false, true, true, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "MYSQL_8_0_18", "MYSQL_8_0_26", "MYSQL_8_0_27", "MYSQL_8_0_28", "MYSQL_8_0_29", "MYSQL_8_0_30", "MYSQL_8_0_31", "MYSQL_8_0_32", "MYSQL_8_0_33", "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", "MYSQL_8_0_37", "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", "MYSQL_8_0_43", "MYSQL_8_0_44", "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", "MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", "SQLSERVER_2017_WEB", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", "POSTGRES_18", "POSTGRES_19", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", "SQLSERVER_2019_WEB", "SQLSERVER_2022_STANDARD", "SQLSERVER_2022_ENTERPRISE", "SQLSERVER_2022_EXPRESS", "SQLSERVER_2022_WEB", "SQLSERVER_2025_STANDARD", "SQLSERVER_2025_ENTERPRISE", "SQLSERVER_2025_EXPRESS" ] }, "pscEnabled": { "description": "Whether PSC connectivity is enabled for this instance.", "type": "boolean" }, "customSubjectAlternativeNames": { "description": "Custom subject alternative names for the server certificate.", "type": "array", "items": { "type": "string" } }, "dnsNames": { "items": { "$ref": "DnsNameMapping" }, "description": "Output only. The list of DNS names used by this instance.", "type": "array", "readOnly": true }, "serverCaCert": { "description": "SSL configuration.", "$ref": "SslCert" }, "nodes": { "description": "Output only. Entries containing information about each read pool node of the read pool.", "type": "array", "items": { "$ref": "ConnectPoolNodeConfig" }, "readOnly": true }, "kind": { "description": "This is always `sql#connectSettings`.", "type": "string" }, "dnsName": { "description": "The dns name of the instance.", "type": "string" }, "region": { "description": "The cloud region for the instance. For example, `us-central1`, `europe-west1`. The region cannot be changed after instance creation.", "type": "string" }, "ipAddresses": { "description": "The assigned IP addresses for the instance.", "type": "array", "items": { "$ref": "IpMapping" } }, "serverCaMode": { "enumDescriptions": [ "CA mode is unknown.", "Google-managed self-signed internal CA.", "Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS).", "Customer-managed CA hosted on Google Cloud's Certificate Authority Service (CAS)." ], "description": "Specify what type of CA is used for the server certificate.", "type": "string", "enum": [ "CA_MODE_UNSPECIFIED", "GOOGLE_MANAGED_INTERNAL_CA", "GOOGLE_MANAGED_CAS_CA", "CUSTOMER_MANAGED_CAS_CA" ] } }, "description": "Connect settings retrieval response.", "type": "object" }, "MySqlSyncConfig": { "id": "MySqlSyncConfig", "properties": { "initialSyncFlags": { "description": "Flags to use for the initial dump.", "type": "array", "items": { "$ref": "SyncFlags" } } }, "description": "MySQL-specific external server sync settings.", "type": "object" }, "SqlInstancesGetDiskShrinkConfigResponse": { "id": "SqlInstancesGetDiskShrinkConfigResponse", "properties": { "kind": { "description": "This is always `sql#getDiskShrinkConfig`.", "type": "string" }, "message": { "description": "Additional message to customers.", "type": "string" }, "minimalTargetSizeGb": { "description": "The minimum size to which a disk can be shrunk in GigaBytes.", "type": "string", "format": "int64" } }, "description": "Instance get disk shrink config response.", "type": "object" }, "InstancesExportRequest": { "description": "Database instance export request.", "type": "object", "id": "InstancesExportRequest", "properties": { "exportContext": { "description": "Contains details about the export operation.", "$ref": "ExportContext" } } }, "BackupRun": { "id": "BackupRun", "properties": { "startTime": { "description": "The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string", "format": "google-datetime" }, "windowStartTime": { "format": "google-datetime", "description": "The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string" }, "location": { "description": "Location of the backups.", "type": "string" }, "diskEncryptionStatus": { "description": "Encryption status specific to a backup.", "$ref": "DiskEncryptionStatus" }, "kind": { "description": "This is always `sql#backupRun`.", "type": "string" }, "selfLink": { "description": "The URI of this resource.", "type": "string" }, "instance": { "description": "Name of the database instance.", "type": "string" }, "diskEncryptionConfiguration": { "description": "Encryption configuration specific to a backup.", "$ref": "DiskEncryptionConfiguration" }, "endTime": { "format": "google-datetime", "description": "The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string" }, "error": { "description": "Information about why the backup operation failed. This is only present if the run has the FAILED status.", "$ref": "OperationError" }, "description": { "description": "The description of this run, only applicable to on-demand backups.", "type": "string" }, "backupKind": { "description": "Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.", "type": "string", "enum": [ "SQL_BACKUP_KIND_UNSPECIFIED", "SNAPSHOT", "PHYSICAL" ], "enumDescriptions": [ "This is an unknown BackupKind.", "Snapshot-based backups.", "Physical backups." ] }, "status": { "enumDescriptions": [ "The status of the run is unknown.", "The backup operation was enqueued.", "The backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.", "The backup is in progress.", "The backup failed.", "The backup was successful.", "The backup was skipped (without problems) for a given backup window. Example: Instance was idle.", "The backup is about to be deleted.", "The backup deletion failed.", "The backup has been deleted." ], "description": "The status of this run.", "type": "string", "enum": [ "SQL_BACKUP_RUN_STATUS_UNSPECIFIED", "ENQUEUED", "OVERDUE", "RUNNING", "FAILED", "SUCCESSFUL", "SKIPPED", "DELETION_PENDING", "DELETION_FAILED", "DELETED" ] }, "databaseVersion": { "readOnly": true, "enumDescriptions": [ "This is an unknown database version.", "The database version is MySQL 5.1.", "The database version is MySQL 5.5.", "The database version is MySQL 5.6.", "The database version is MySQL 5.7.", "The database version is MySQL 8.", "The database major version is MySQL 8.0 and the minor version is 18.", "The database major version is MySQL 8.0 and the minor version is 26.", "The database major version is MySQL 8.0 and the minor version is 27.", "The database major version is MySQL 8.0 and the minor version is 28.", "The database major version is MySQL 8.0 and the minor version is 29.", "The database major version is MySQL 8.0 and the minor version is 30.", "The database major version is MySQL 8.0 and the minor version is 31.", "The database major version is MySQL 8.0 and the minor version is 32.", "The database major version is MySQL 8.0 and the minor version is 33.", "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", "The database major version is MySQL 8.0 and the minor version is 37.", "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", "The database major version is MySQL 8.0 and the minor version is 43.", "The database major version is MySQL 8.0 and the minor version is 44.", "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", "The database version is SQL Server 2017 Web.", "The database version is PostgreSQL 9.6.", "The database version is PostgreSQL 10.", "The database version is PostgreSQL 11.", "The database version is PostgreSQL 12.", "The database version is PostgreSQL 13.", "The database version is PostgreSQL 14.", "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", "The database version is PostgreSQL 18.", "The database version is PostgreSQL 19.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", "The database version is SQL Server 2019 Web.", "The database version is SQL Server 2022 Standard.", "The database version is SQL Server 2022 Enterprise.", "The database version is SQL Server 2022 Express.", "The database version is SQL Server 2022 Web.", "The database version is SQL Server 2025 Standard.", "The database version is SQL Server 2025 Enterprise.", "The database version is SQL Server 2025 Express." ], "type": "string", "description": "Output only. The instance database version at the time this backup was made.", "enumDeprecated": [ false, true, true, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "MYSQL_8_0_18", "MYSQL_8_0_26", "MYSQL_8_0_27", "MYSQL_8_0_28", "MYSQL_8_0_29", "MYSQL_8_0_30", "MYSQL_8_0_31", "MYSQL_8_0_32", "MYSQL_8_0_33", "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", "MYSQL_8_0_37", "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", "MYSQL_8_0_43", "MYSQL_8_0_44", "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", "MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", "SQLSERVER_2017_WEB", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", "POSTGRES_18", "POSTGRES_19", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", "SQLSERVER_2019_WEB", "SQLSERVER_2022_STANDARD", "SQLSERVER_2022_ENTERPRISE", "SQLSERVER_2022_EXPRESS", "SQLSERVER_2022_WEB", "SQLSERVER_2025_STANDARD", "SQLSERVER_2025_ENTERPRISE", "SQLSERVER_2025_EXPRESS" ] }, "enqueuedTime": { "format": "google-datetime", "description": "The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string" }, "timeZone": { "description": "Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.", "type": "string" }, "id": { "format": "int64", "description": "The identifier for this backup run. Unique only for a specific Cloud SQL instance.", "type": "string" }, "maxChargeableBytes": { "format": "int64", "readOnly": true, "description": "Output only. The maximum chargeable bytes for the backup.", "type": "string" }, "type": { "description": "The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\" or \"FINAL\". This field defaults to \"ON_DEMAND\" and is ignored, when specified for insert requests.", "type": "string", "enum": [ "SQL_BACKUP_RUN_TYPE_UNSPECIFIED", "AUTOMATED", "ON_DEMAND" ], "enumDescriptions": [ "This is an unknown BackupRun type.", "The backup schedule automatically triggers a backup.", "The user manually triggers a backup." ] } }, "description": "A BackupRun resource.", "type": "object" }, "ReplicationCluster": { "description": "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. Applicable to MySQL and PostgreSQL.", "type": "object", "id": "ReplicationCluster", "properties": { "failoverDrReplicaName": { "description": "Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.", "type": "string" }, "psaWriteEndpoint": { "readOnly": true, "description": "Output only. If set, this field 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, then the DNS endpoint points to this instance. After a switchover or replica failover operation, 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 doesn't have a DR replica yet or the DR replica is deleted.", "type": "string" }, "drReplica": { "readOnly": true, "description": "Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.", "type": "boolean" } } }, "Database": { "description": "Represents a SQL database on the Cloud SQL instance.", "type": "object", "id": "Database", "properties": { "charset": { "description": "The Cloud SQL charset value.", "type": "string" }, "project": { "description": "The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.", "type": "string" }, "etag": { "description": "This field is deprecated and will be removed from a future version of the API.", "type": "string" }, "name": { "description": "The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.", "type": "string" }, "instance": { "description": "The name of the Cloud SQL instance. This does not include the project ID.", "type": "string" }, "collation": { "description": "The Cloud SQL collation value.", "type": "string" }, "kind": { "description": "This is always `sql#database`.", "type": "string" }, "sqlserverDatabaseDetails": { "$ref": "SqlServerDatabaseDetails" }, "selfLink": { "description": "The URI of this resource.", "type": "string" } } }, "SyncFlags": { "id": "SyncFlags", "properties": { "name": { "description": "The name of the flag.", "type": "string" }, "value": { "description": "The value of the flag. This field must be omitted if the flag doesn't take a value.", "type": "string" } }, "description": "Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.", "type": "object" }, "InstancesDemoteMasterRequest": { "id": "InstancesDemoteMasterRequest", "properties": { "demoteMasterContext": { "description": "Contains details about the demoteMaster operation.", "$ref": "DemoteMasterContext" } }, "description": "Database demote primary instance request.", "type": "object" }, "LocationPreference": { "description": "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.", "type": "object", "id": "LocationPreference", "properties": { "zone": { "description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance.", "type": "string" }, "followGaeApplication": { "description": "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.", "type": "string", "deprecated": true }, "secondaryZone": { "description": "The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). To disable this field, set it to 'no_secondary_zone'.", "type": "string" }, "kind": { "description": "This is always `sql#locationPreference`.", "type": "string" } } }, "SqlInstancesVerifyExternalSyncSettingsResponse": { "description": "Instance verify external sync settings response.", "type": "object", "id": "SqlInstancesVerifyExternalSyncSettingsResponse", "properties": { "errors": { "description": "List of migration violations.", "type": "array", "items": { "$ref": "SqlExternalSyncSettingError" } }, "warnings": { "items": { "$ref": "SqlExternalSyncSettingError" }, "description": "List of migration warnings.", "type": "array" }, "kind": { "description": "This is always `sql#migrationSettingErrorList`.", "type": "string" } } }, "Flag": { "id": "Flag", "properties": { "name": { "description": "This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`", "type": "string" }, "type": { "description": "The type of the flag. Flags are typed to being `BOOLEAN`, `STRING`, `INTEGER` or `NONE`. `NONE` is used for flags that do not take a value, such as `skip_grant_tables`.", "type": "string", "enum": [ "SQL_FLAG_TYPE_UNSPECIFIED", "BOOLEAN", "STRING", "INTEGER", "NONE", "MYSQL_TIMEZONE_OFFSET", "FLOAT", "REPEATED_STRING" ], "enumDescriptions": [ "This is an unknown flag type.", "Boolean type flag.", "String type flag.", "Integer type flag.", "Flag type used for a server startup option.", "Type introduced specially for MySQL TimeZone offset. Accept a string value with the format [-12:59, 13:00].", "Float type flag.", "Comma-separated list of the strings in a SqlFlagType enum." ] }, "appliesTo": { "items": { "type": "string", "enumDeprecated": [ false, true, true, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "MYSQL_8_0_18", "MYSQL_8_0_26", "MYSQL_8_0_27", "MYSQL_8_0_28", "MYSQL_8_0_29", "MYSQL_8_0_30", "MYSQL_8_0_31", "MYSQL_8_0_32", "MYSQL_8_0_33", "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", "MYSQL_8_0_37", "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", "MYSQL_8_0_43", "MYSQL_8_0_44", "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", "MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", "SQLSERVER_2017_WEB", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", "POSTGRES_18", "POSTGRES_19", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", "SQLSERVER_2019_WEB", "SQLSERVER_2022_STANDARD", "SQLSERVER_2022_ENTERPRISE", "SQLSERVER_2022_EXPRESS", "SQLSERVER_2022_WEB", "SQLSERVER_2025_STANDARD", "SQLSERVER_2025_ENTERPRISE", "SQLSERVER_2025_EXPRESS" ], "enumDescriptions": [ "This is an unknown database version.", "The database version is MySQL 5.1.", "The database version is MySQL 5.5.", "The database version is MySQL 5.6.", "The database version is MySQL 5.7.", "The database version is MySQL 8.", "The database major version is MySQL 8.0 and the minor version is 18.", "The database major version is MySQL 8.0 and the minor version is 26.", "The database major version is MySQL 8.0 and the minor version is 27.", "The database major version is MySQL 8.0 and the minor version is 28.", "The database major version is MySQL 8.0 and the minor version is 29.", "The database major version is MySQL 8.0 and the minor version is 30.", "The database major version is MySQL 8.0 and the minor version is 31.", "The database major version is MySQL 8.0 and the minor version is 32.", "The database major version is MySQL 8.0 and the minor version is 33.", "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", "The database major version is MySQL 8.0 and the minor version is 37.", "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", "The database major version is MySQL 8.0 and the minor version is 43.", "The database major version is MySQL 8.0 and the minor version is 44.", "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", "The database version is SQL Server 2017 Web.", "The database version is PostgreSQL 9.6.", "The database version is PostgreSQL 10.", "The database version is PostgreSQL 11.", "The database version is PostgreSQL 12.", "The database version is PostgreSQL 13.", "The database version is PostgreSQL 14.", "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", "The database version is PostgreSQL 18.", "The database version is PostgreSQL 19.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", "The database version is SQL Server 2019 Web.", "The database version is SQL Server 2022 Standard.", "The database version is SQL Server 2022 Enterprise.", "The database version is SQL Server 2022 Express.", "The database version is SQL Server 2022 Web.", "The database version is SQL Server 2025 Standard.", "The database version is SQL Server 2025 Enterprise.", "The database version is SQL Server 2025 Express." ] }, "description": "The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", "type": "array" }, "recommendedIntValue": { "description": "Recommended int value in integer format for UI display.", "type": "string", "format": "int64" }, "inBeta": { "description": "Whether or not the flag is considered in beta.", "type": "boolean" }, "recommendedStringValue": { "description": "Recommended string value in string format for UI display.", "type": "string" }, "allowedStringValues": { "description": "For `STRING` flags, a list of strings that the value can be set to.", "type": "array", "items": { "type": "string" } }, "allowedIntValues": { "items": { "type": "string", "format": "int64" }, "description": "Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.", "type": "array" }, "maxValue": { "format": "int64", "description": "For `INTEGER` flags, the maximum allowed value.", "type": "string" }, "requiresRestart": { "description": "Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.", "type": "boolean" }, "kind": { "description": "This is always `sql#flag`.", "type": "string" }, "minValue": { "format": "int64", "description": "For `INTEGER` flags, the minimum allowed value.", "type": "string" }, "flagScope": { "description": "Scope of flag.", "type": "string", "enum": [ "SQL_FLAG_SCOPE_UNSPECIFIED", "SQL_FLAG_SCOPE_DATABASE", "SQL_FLAG_SCOPE_CONNECTION_POOL" ], "enumDescriptions": [ "Assume database flags if unspecified", "database flags", "connection pool configuration flags" ] } }, "description": "A flag resource.", "type": "object" }, "Operation": { "id": "Operation", "properties": { "status": { "description": "The status of an operation.", "type": "string", "enum": [ "SQL_OPERATION_STATUS_UNSPECIFIED", "PENDING", "RUNNING", "DONE" ], "enumDescriptions": [ "The state of the operation is unknown.", "The operation has been queued, but has not started yet.", "The operation is running.", "The operation completed." ] }, "insertTime": { "description": "The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string", "format": "google-datetime" }, "error": { "description": "If errors occurred during processing of this operation, this field will be populated.", "$ref": "OperationErrors" }, "subOperationType": { "description": "Optional. The sub operation based on the operation type.", "$ref": "SqlSubOperationType" }, "importContext": { "description": "The context for import operation, if applicable.", "$ref": "ImportContext" }, "user": { "description": "The email address of the user who initiated this operation.", "type": "string" }, "name": { "description": "An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.", "type": "string" }, "targetProject": { "description": "The project ID of the target instance related to this operation.", "type": "string" }, "apiWarning": { "description": "An Admin API warning message.", "$ref": "ApiWarning" }, "targetId": { "description": "Name of the resource on which this operation runs.", "type": "string" }, "startTime": { "format": "google-datetime", "description": "The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string" }, "operationType": { "description": "The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`", "enumDeprecated": [ false, false, false, false, false, false, false, true, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, true, true, false, false, false, false, false, false, false, false, false, false, true, true, false, false, true, false, false, false, false, false ], "enum": [ "SQL_OPERATION_TYPE_UNSPECIFIED", "IMPORT", "EXPORT", "CREATE", "UPDATE", "DELETE", "RESTART", "BACKUP", "SNAPSHOT", "BACKUP_VOLUME", "DELETE_VOLUME", "RESTORE_VOLUME", "INJECT_USER", "CLONE", "STOP_REPLICA", "START_REPLICA", "PROMOTE_REPLICA", "CREATE_REPLICA", "CREATE_USER", "DELETE_USER", "UPDATE_USER", "CREATE_DATABASE", "DELETE_DATABASE", "UPDATE_DATABASE", "FAILOVER", "DELETE_BACKUP", "RECREATE_REPLICA", "TRUNCATE_LOG", "DEMOTE_MASTER", "MAINTENANCE", "ENABLE_PRIVATE_IP", "DEFER_MAINTENANCE", "CREATE_CLONE", "RESCHEDULE_MAINTENANCE", "START_EXTERNAL_SYNC", "LOG_CLEANUP", "AUTO_RESTART", "REENCRYPT", "SWITCHOVER", "UPDATE_BACKUP", "ACQUIRE_SSRS_LEASE", "RELEASE_SSRS_LEASE", "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", "SWITCHOVER_TO_REPLICA", "MAJOR_VERSION_UPGRADE", "ADVANCED_BACKUP", "MANAGE_BACKUP", "ENHANCED_BACKUP", "REPAIR_READ_POOL", "CREATE_READ_POOL", "PRE_CHECK_MAJOR_VERSION_UPGRADE" ], "enumDescriptions": [ "Unknown operation type.", "Imports data into a Cloud SQL instance.", "Exports data from a Cloud SQL instance to a Cloud Storage bucket.", "Creates a new Cloud SQL instance.", "Updates the settings of a Cloud SQL instance.", "Deletes a Cloud SQL instance.", "Restarts the Cloud SQL instance.", "", "", "Performs instance backup.", "Deletes an instance backup.", "Restores an instance backup.", "Injects a privileged user in mysql for MOB instances.", "Clones a Cloud SQL instance.", "Stops replication on a Cloud SQL read replica instance.", "Starts replication on a Cloud SQL read replica instance.", "Promotes a Cloud SQL replica instance.", "Creates a Cloud SQL replica instance.", "Creates a new user in a Cloud SQL instance.", "Deletes a user from a Cloud SQL instance.", "Updates an existing user in a Cloud SQL instance. If a user with the specified username doesn't exist, a new user is created.", "Creates a database in the Cloud SQL instance.", "Deletes a database in the Cloud SQL instance.", "Updates a database in the Cloud SQL instance.", "Performs failover of an HA-enabled Cloud SQL failover replica.", "Deletes the backup taken by a backup run.", "", "Truncates a general or slow log table in MySQL.", "Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.", "Indicates that the instance is currently in maintenance. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", "This field is deprecated, and will be removed in future version of API.", "", "Creates clone instance.", "Reschedule maintenance to another time.", "Starts external sync of a Cloud SQL EM replica to an external primary instance.", "Recovers logs from an instance's old data disk.", "Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.", "Re-encrypts CMEK instances with latest key version.", "Switches the roles of the primary and replica pair. The target instance should be the replica.", "Update a backup.", "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "Release a lease for the setup of SQL Server Reporting Services (SSRS).", "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", "Updates the major version of a Cloud SQL instance.", "Deprecated: ADVANCED_BACKUP is deprecated. Use ENHANCED_BACKUP instead.", "Changes the BackupTier of a Cloud SQL instance.", "Creates a backup for an Enhanced BackupTier Cloud SQL instance.", "Repairs entire read pool or specified read pool nodes in the read pool.", "Creates a Cloud SQL read pool instance.", "Pre-checks the major version upgrade operation." ], "type": "string" }, "acquireSsrsLeaseContext": { "description": "The context for acquire SSRS lease operation, if applicable.", "$ref": "AcquireSsrsLeaseContext" }, "endTime": { "description": "The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string", "format": "google-datetime" }, "preCheckMajorVersionUpgradeContext": { "description": "This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).", "$ref": "PreCheckMajorVersionUpgradeContext" }, "backupContext": { "description": "The context for backup operation, if applicable.", "$ref": "BackupContext" }, "exportContext": { "description": "The context for export operation, if applicable.", "$ref": "ExportContext" }, "selfLink": { "description": "The URI of this resource.", "type": "string" }, "kind": { "description": "This is always `sql#operation`.", "type": "string" }, "targetLink": { "type": "string" } }, "description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.", "type": "object" }, "QueryResult": { "id": "QueryResult", "properties": { "columns": { "items": { "$ref": "Column" }, "description": "List of columns included in the result. This also includes the data type of the column.", "type": "array" }, "rows": { "description": "Rows returned by the SQL statement.", "type": "array", "items": { "$ref": "Row" } }, "message": { "description": "Message related to the SQL execution result.", "type": "string" }, "status": { "description": "If results were truncated due to an error, details of that error.", "$ref": "Status" }, "partialResult": { "description": "Set to true if the SQL execution's result is truncated due to size limits or an error retrieving results.", "type": "boolean" } }, "description": "QueryResult contains the result of executing a single SQL statement.", "type": "object" }, "Column": { "description": "Contains the name and datatype of a column.", "type": "object", "id": "Column", "properties": { "name": { "description": "Name of the column.", "type": "string" }, "type": { "description": "Datatype of the column.", "type": "string" } } }, "TruncateLogContext": { "description": "Database Instance truncate log context.", "type": "object", "id": "TruncateLogContext", "properties": { "kind": { "description": "This is always `sql#truncateLogContext`.", "type": "string" }, "logType": { "description": "The type of log to truncate. Valid values are `MYSQL_GENERAL_TABLE` and `MYSQL_SLOW_TABLE`.", "type": "string" } } }, "SqlOutOfDiskReport": { "id": "SqlOutOfDiskReport", "properties": { "sqlOutOfDiskState": { "description": "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", "type": "string", "enum": [ "SQL_OUT_OF_DISK_STATE_UNSPECIFIED", "NORMAL", "SOFT_SHUTDOWN" ], "enumDescriptions": [ "Unspecified state", "The instance has plenty space on data disk", "Data disk is almost used up. It is shutdown to prevent data corruption." ] }, "sqlMinRecommendedIncreaseSizeGb": { "description": "The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers:", "type": "integer", "format": "int32" } }, "description": "This message wraps up the information written by out-of-disk detection job.", "type": "object" }, "InstancesRestoreBackupRequest": { "description": "Database instance restore backup request.", "type": "object", "id": "InstancesRestoreBackupRequest", "properties": { "restoreInstanceSettings": { "description": "Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances.", "$ref": "DatabaseInstance" }, "restoreInstanceClearOverridesFieldNames": { "items": { "type": "string" }, "description": "Optional. This field has the same purpose as restore_instance_settings, changes any instance settings stored in the backup you are restoring from. With the difference that these fields are cleared in the settings.", "type": "array" }, "restoreBackupContext": { "description": "Parameters required to perform the restore backup operation.", "$ref": "RestoreBackupContext" }, "backup": { "description": "The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.", "type": "string" }, "backupdrBackup": { "description": "The name of the backup that's used to restore a Cloud SQL instance: Format: \"projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}\". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.", "type": "string" } } }, "Backup": { "description": "A backup resource.", "type": "object", "id": "Backup", "properties": { "timeZone": { "readOnly": true, "description": "Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.", "type": "string" }, "instanceDeletionTime": { "readOnly": true, "format": "google-datetime", "description": "Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.", "type": "string" }, "databaseVersion": { "type": "string", "readOnly": true, "enumDescriptions": [ "This is an unknown database version.", "The database version is MySQL 5.1.", "The database version is MySQL 5.5.", "The database version is MySQL 5.6.", "The database version is MySQL 5.7.", "The database version is MySQL 8.", "The database major version is MySQL 8.0 and the minor version is 18.", "The database major version is MySQL 8.0 and the minor version is 26.", "The database major version is MySQL 8.0 and the minor version is 27.", "The database major version is MySQL 8.0 and the minor version is 28.", "The database major version is MySQL 8.0 and the minor version is 29.", "The database major version is MySQL 8.0 and the minor version is 30.", "The database major version is MySQL 8.0 and the minor version is 31.", "The database major version is MySQL 8.0 and the minor version is 32.", "The database major version is MySQL 8.0 and the minor version is 33.", "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", "The database major version is MySQL 8.0 and the minor version is 37.", "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", "The database major version is MySQL 8.0 and the minor version is 43.", "The database major version is MySQL 8.0 and the minor version is 44.", "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", "The database version is SQL Server 2017 Web.", "The database version is PostgreSQL 9.6.", "The database version is PostgreSQL 10.", "The database version is PostgreSQL 11.", "The database version is PostgreSQL 12.", "The database version is PostgreSQL 13.", "The database version is PostgreSQL 14.", "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", "The database version is PostgreSQL 18.", "The database version is PostgreSQL 19.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", "The database version is SQL Server 2019 Web.", "The database version is SQL Server 2022 Standard.", "The database version is SQL Server 2022 Enterprise.", "The database version is SQL Server 2022 Express.", "The database version is SQL Server 2022 Web.", "The database version is SQL Server 2025 Standard.", "The database version is SQL Server 2025 Enterprise.", "The database version is SQL Server 2025 Express." ], "description": "Output only. The database version of the instance of at the time this backup was made.", "enumDeprecated": [ false, true, true, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "MYSQL_8_0_18", "MYSQL_8_0_26", "MYSQL_8_0_27", "MYSQL_8_0_28", "MYSQL_8_0_29", "MYSQL_8_0_30", "MYSQL_8_0_31", "MYSQL_8_0_32", "MYSQL_8_0_33", "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", "MYSQL_8_0_37", "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", "MYSQL_8_0_43", "MYSQL_8_0_44", "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", "MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", "SQLSERVER_2017_WEB", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", "POSTGRES_18", "POSTGRES_19", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", "SQLSERVER_2019_WEB", "SQLSERVER_2022_STANDARD", "SQLSERVER_2022_ENTERPRISE", "SQLSERVER_2022_EXPRESS", "SQLSERVER_2022_WEB", "SQLSERVER_2025_STANDARD", "SQLSERVER_2025_ENTERPRISE", "SQLSERVER_2025_EXPRESS" ] }, "backupKind": { "type": "string", "readOnly": true, "enumDescriptions": [ "This is an unknown BackupKind.", "Snapshot-based backups.", "Physical backups." ], "description": "Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.", "enum": [ "SQL_BACKUP_KIND_UNSPECIFIED", "SNAPSHOT", "PHYSICAL" ] }, "error": { "description": "Output only. Information about why the backup operation fails (for example, when the backup state fails).", "$ref": "OperationError", "readOnly": true }, "ttlDays": { "format": "int64", "description": "Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.", "type": "string" }, "description": { "description": "The description of this backup.", "type": "string" }, "backupRun": { "description": "Output only. The mapping to backup run resource used for IAM validations.", "type": "string", "readOnly": true }, "name": { "readOnly": true, "description": "Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.", "type": "string" }, "type": { "type": "string", "readOnly": true, "enumDescriptions": [ "This is an unknown backup type.", "The backup schedule triggers a backup automatically.", "The user triggers a backup manually.", "The backup created when instance is deleted." ], "description": "Output only. The type of this backup. The type can be \"AUTOMATED\", \"ON_DEMAND\" or “FINAL”.", "enum": [ "SQL_BACKUP_TYPE_UNSPECIFIED", "AUTOMATED", "ON_DEMAND", "FINAL" ] }, "instanceSettings": { "description": "Optional. Output only. The instance setting of the source instance that's associated with this backup.", "$ref": "DatabaseInstance", "readOnly": true }, "maxChargeableBytes": { "description": "Output only. The maximum chargeable bytes for the backup.", "type": "string", "format": "int64", "readOnly": true }, "satisfiesPzi": { "description": "Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.", "type": "boolean", "readOnly": true }, "state": { "readOnly": true, "enumDescriptions": [ "The state of the backup is unknown.", "The backup that's added to a queue.", "The backup is in progress.", "The backup failed.", "The backup is successful.", "The backup is being deleted.", "Deletion of the backup failed." ], "type": "string", "description": "Output only. The status of this backup.", "enum": [ "SQL_BACKUP_STATE_UNSPECIFIED", "ENQUEUED", "RUNNING", "FAILED", "SUCCESSFUL", "DELETING", "DELETION_FAILED" ] }, "location": { "description": "The storage location of the backups. The location can be multi-regional.", "type": "string" }, "kmsKey": { "description": "Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.", "type": "string", "readOnly": true }, "satisfiesPzs": { "description": "Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.", "type": "boolean", "readOnly": true }, "instance": { "description": "The name of the source database instance.", "type": "string" }, "selfLink": { "readOnly": true, "description": "Output only. The URI of this resource.", "type": "string" }, "kmsKeyVersion": { "description": "Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.", "type": "string", "readOnly": true }, "backupInterval": { "description": "Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.", "$ref": "Interval", "readOnly": true }, "kind": { "description": "Output only. This is always `sql#backup`.", "type": "string", "readOnly": true }, "expiryTime": { "description": "Backup expiration time. A UTC timestamp of when this backup expired.", "type": "string", "format": "google-datetime" } } }, "AcquireSsrsLeaseContext": { "id": "AcquireSsrsLeaseContext", "properties": { "reportDatabase": { "description": "The report database to be used for SSRS setup.", "type": "string" }, "serviceLogin": { "description": "The username to be used as the service login to connect to the report database for SSRS setup.", "type": "string" }, "duration": { "format": "google-duration", "description": "Lease duration needed for SSRS setup.", "type": "string" }, "setupLogin": { "description": "The username to be used as the setup login to connect to the database server for SSRS setup.", "type": "string" } }, "description": "Acquire SSRS lease context.", "type": "object" }, "FailoverContext": { "id": "FailoverContext", "properties": { "settingsVersion": { "format": "int64", "description": "The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.", "type": "string" }, "kind": { "description": "This is always `sql#failoverContext`.", "type": "string" } }, "description": "Database instance failover context.", "type": "object" }, "MySqlReplicaConfiguration": { "description": "Read-replica configuration specific to MySQL databases.", "type": "object", "id": "MySqlReplicaConfiguration", "properties": { "password": { "description": "The password for the replication connection.", "type": "string" }, "caCertificate": { "description": "PEM representation of the trusted CA's x509 certificate.", "type": "string" }, "kind": { "description": "This is always `sql#mysqlReplicaConfiguration`.", "type": "string" }, "clientCertificate": { "description": "PEM representation of the replica's x509 certificate.", "type": "string" }, "sslCipher": { "description": "A list of permissible ciphers to use for SSL encryption.", "type": "string" }, "masterHeartbeatPeriod": { "description": "Interval in milliseconds between replication heartbeats.", "type": "string", "format": "int64" }, "verifyServerCertificate": { "description": "Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.", "type": "boolean" }, "dumpFilePath": { "description": "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.", "type": "string" }, "username": { "description": "The username for the replication connection.", "type": "string" }, "connectRetryInterval": { "description": "Seconds to wait between connect retries. MySQL's default is 60 seconds.", "type": "integer", "format": "int32" }, "clientKey": { "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" } } }, "UserPasswordValidationPolicy": { "id": "UserPasswordValidationPolicy", "properties": { "allowedFailedAttempts": { "description": "Number of failed login attempts allowed before user get locked.", "type": "integer", "format": "int32" }, "passwordExpirationDuration": { "format": "google-duration", "description": "Expiration duration after password is updated.", "type": "string" }, "status": { "readOnly": true, "description": "Output only. Read-only password status.", "$ref": "PasswordStatus" }, "enablePasswordVerification": { "description": "If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.", "type": "boolean" }, "enableFailedAttemptsCheck": { "description": "If true, failed login attempts check will be enabled.", "type": "boolean" } }, "description": "User level password validation policy.", "type": "object" }, "SqlSubOperationType": { "description": "The sub operation type based on the operation type.", "type": "object", "id": "SqlSubOperationType", "properties": { "maintenanceType": { "description": "The type of maintenance to be performed on the instance.", "type": "string", "enum": [ "SQL_MAINTENANCE_TYPE_UNSPECIFIED", "INSTANCE_MAINTENANCE", "REPLICA_INCLUDED_MAINTENANCE", "INSTANCE_SELF_SERVICE_MAINTENANCE", "REPLICA_INCLUDED_SELF_SERVICE_MAINTENANCE" ], "enumDescriptions": [ "Maintenance type is unspecified.", "Indicates that a standalone instance is undergoing maintenance. The instance can be either a primary instance or a replica.", "Indicates that the primary instance and all of its replicas, including cascading replicas, are undergoing maintenance. Maintenance is performed on groups of replicas first, followed by the primary instance.", "Indicates that the standalone instance is undergoing maintenance, initiated by self-service. The instance can be either a primary instance or a replica.", "Indicates that the primary instance and all of its replicas are undergoing maintenance, initiated by self-service. Maintenance is performed on groups of replicas first, followed by the primary instance." ] } } }, "SqlInstancesExecuteSqlResponse": { "id": "SqlInstancesExecuteSqlResponse", "properties": { "messages": { "items": { "$ref": "Message" }, "description": "A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement.", "type": "array" }, "metadata": { "description": "The additional metadata information regarding the execution of the SQL statements.", "$ref": "Metadata" }, "results": { "description": "The list of results after executing all the SQL statements.", "type": "array", "items": { "$ref": "QueryResult" } }, "status": { "description": "Contains the error from the database if the SQL execution failed.", "$ref": "Status" } }, "description": "Execute SQL statements response.", "type": "object" }, "OperationError": { "id": "OperationError", "properties": { "kind": { "description": "This is always `sql#operationError`.", "type": "string" }, "code": { "description": "Identifies the specific error that occurred.", "type": "string" }, "message": { "description": "Additional information about the error encountered.", "type": "string" } }, "description": "Database instance operation error.", "type": "object" }, "BackupRunsListResponse": { "id": "BackupRunsListResponse", "properties": { "items": { "items": { "$ref": "BackupRun" }, "description": "A list of backup runs in reverse chronological order of the enqueued time.", "type": "array" }, "kind": { "description": "This is always `sql#backupRunsList`.", "type": "string" }, "nextPageToken": { "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.", "type": "string" } }, "description": "Backup run list results.", "type": "object" }, "UsersListResponse": { "description": "User list response.", "type": "object", "id": "UsersListResponse", "properties": { "items": { "items": { "$ref": "User" }, "description": "List of user resources in the instance.", "type": "array" }, "kind": { "description": "This is always `sql#usersList`.", "type": "string" }, "nextPageToken": { "description": "Unused.", "type": "string", "deprecated": true } } }, "PasswordValidationPolicy": { "description": "Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access.", "type": "object", "id": "PasswordValidationPolicy", "properties": { "minLength": { "format": "int32", "description": "Minimum number of characters allowed.", "type": "integer" }, "reuseInterval": { "description": "Number of previous passwords that cannot be reused.", "type": "integer", "format": "int32" }, "enablePasswordPolicy": { "description": "Whether to enable the password policy or not. When enabled, passwords must meet complexity requirements. Keep this policy enabled to help prevent unauthorized access. Disabling this policy allows weak passwords.", "type": "boolean" }, "complexity": { "enumDescriptions": [ "Complexity check is not specified.", "A combination of lowercase, uppercase, numeric, and non-alphanumeric characters." ], "description": "The complexity of the password.", "type": "string", "enum": [ "COMPLEXITY_UNSPECIFIED", "COMPLEXITY_DEFAULT" ] }, "disallowUsernameSubstring": { "description": "Disallow username as a part of the password.", "type": "boolean" }, "passwordChangeInterval": { "format": "google-duration", "description": "Minimum interval after which the password can be changed. This flag is only supported for PostgreSQL.", "type": "string" }, "disallowCompromisedCredentials": { "deprecated": true, "description": "This field is deprecated and will be removed in a future version of the API.", "type": "boolean" } } }, "SqlServerEntraIdConfig": { "id": "SqlServerEntraIdConfig", "properties": { "kind": { "readOnly": true, "description": "Output only. This is always sql#sqlServerEntraIdConfig", "type": "string" }, "applicationId": { "description": "Optional. The application ID for the Entra ID configuration.", "type": "string" }, "tenantId": { "description": "Optional. The tenant ID for the Entra ID configuration.", "type": "string" } }, "description": "SQL Server Entra ID configuration.", "type": "object" }, "InstancesTruncateLogRequest": { "id": "InstancesTruncateLogRequest", "properties": { "truncateLogContext": { "description": "Contains details about the truncate log operation.", "$ref": "TruncateLogContext" } }, "description": "Instance truncate log request.", "type": "object" }, "SslCertsCreateEphemeralRequest": { "description": "SslCerts create ephemeral certificate request.", "type": "object", "id": "SslCertsCreateEphemeralRequest", "properties": { "access_token": { "description": "Access token to include in the signed certificate.", "type": "string" }, "public_key": { "description": "PEM encoded public key to include in the signed certificate.", "type": "string" } } }, "ExternalSyncSelectedObject": { "description": "The selected object that Cloud SQL migrates.", "type": "object", "id": "ExternalSyncSelectedObject", "properties": { "database": { "description": "The name of the database that Cloud SQL migrates.", "type": "string" } } }, "RotateEntraIdCertificateContext": { "description": "Instance rotate Entra ID certificate context.", "type": "object", "id": "RotateEntraIdCertificateContext", "properties": { "kind": { "description": "Optional. This is always `sql#rotateEntraIdCertificateContext`.", "type": "string" }, "nextVersion": { "description": "Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.", "type": "string" } } }, "BackupReencryptionConfig": { "id": "BackupReencryptionConfig", "properties": { "backupLimit": { "description": "Backup re-encryption limit", "type": "integer", "format": "int32" }, "backupType": { "enumDescriptions": [ "Unknown backup type, will be defaulted to AUTOMATIC backup type", "Reencrypt automatic backups", "Reencrypt on-demand backups" ], "description": "Type of backups users want to re-encrypt.", "type": "string", "enum": [ "BACKUP_TYPE_UNSPECIFIED", "AUTOMATED", "ON_DEMAND" ] } }, "description": "Backup Reencryption Config", "type": "object" }, "InstancesAcquireSsrsLeaseRequest": { "description": "Request to acquire a lease for SSRS.", "type": "object", "id": "InstancesAcquireSsrsLeaseRequest", "properties": { "acquireSsrsLeaseContext": { "description": "Contains details about the acquire SSRS lease operation.", "$ref": "AcquireSsrsLeaseContext" } } }, "PointInTimeRestoreContext": { "description": "The context to perform a point-in-time recovery of an instance managed by Backup and Disaster Recovery (DR) Service.", "type": "object", "id": "PointInTimeRestoreContext", "properties": { "datasource": { "description": "The Backup and Disaster Recovery (DR) Service Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}.", "type": "string" }, "targetInstanceSettings": { "description": "Optional. Specifies the instance settings that will be overridden from the source instance. This field is only applicable for cross project PITRs.", "$ref": "DatabaseInstance" }, "privateNetwork": { "description": "Optional. 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`.", "type": "string" }, "targetInstanceClearSettingsFieldNames": { "description": "Optional. Specifies the instance settings that will be cleared from the source instance. This field is only applicable for cross project PITRs.", "type": "array", "items": { "type": "string" } }, "preferredSecondaryZone": { "description": "Optional. Point-in-time recovery of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field.", "type": "string" }, "region": { "description": "Optional. The region of the target instance where the datasource will be restored. For example: \"us-central1\".", "type": "string" }, "targetInstance": { "description": "Target instance name.", "type": "string" }, "allocatedIpRange": { "description": "Optional. The name of the allocated IP range for the internal IP Cloud SQL instance. For example: \"google-managed-services-default\". If you set this, then Cloud SQL creates the IP address for the cloned instance in the allocated range. This range must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035) standards. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use.", "type": "string" }, "preferredZone": { "description": "Optional. Point-in-time recovery of an instance to the specified zone. If no zone is specified, then clone to the same primary zone as the source instance.", "type": "string" }, "pointInTime": { "format": "google-datetime", "description": "Required. The date and time to which you want to restore the instance.", "type": "string" } } }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "id": "Empty", "properties": {} }, "ConnectionPoolFlags": { "id": "ConnectionPoolFlags", "properties": { "name": { "description": "Required. The name of the flag.", "type": "string" }, "value": { "description": "Required. 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.", "type": "string" } }, "description": "Connection pool flags for Cloud SQL instances managed connection pool configuration.", "type": "object" }, "TargetMetric": { "description": "Target metric for read pool auto scaling.", "type": "object", "id": "TargetMetric", "properties": { "metric": { "description": "The metric name to be used for auto scaling.", "type": "string" }, "targetValue": { "format": "float", "description": "The target value for the metric.", "type": "number" } } }, "BackupContext": { "description": "Backup context.", "type": "object", "id": "BackupContext", "properties": { "kind": { "description": "This is always `sql#backupContext`.", "type": "string" }, "name": { "description": "The name of the backup. Format: projects/{project}/backups/{backup}", "type": "string" }, "backupId": { "description": "The identifier of the backup.", "type": "string", "format": "int64" } } }, "DatabaseFlags": { "id": "DatabaseFlags", "properties": { "name": { "description": "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](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation.", "type": "string" }, "value": { "description": "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.", "type": "string" } }, "description": "Database flags for Cloud SQL instances.", "type": "object" }, "InsightsConfig": { "id": "InsightsConfig", "properties": { "recordApplicationTags": { "description": "Whether Query Insights will record application tags from query when enabled.", "type": "boolean" }, "queryInsightsEnabled": { "description": "Whether Query Insights feature is enabled.", "type": "boolean" }, "recordClientAddress": { "description": "Whether Query Insights will record client address when enabled.", "type": "boolean" }, "enhancedQueryInsightsEnabled": { "description": "Optional. Whether enhanced query insights feature is enabled.", "type": "boolean" }, "queryStringLength": { "format": "int32", "description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater 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.", "type": "integer" }, "queryPlansPerMinute": { "format": "int32", "description": "Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.", "type": "integer" } }, "description": "Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.", "type": "object" }, "AdvancedMachineFeatures": { "description": "Specifies options for controlling advanced machine features.", "type": "object", "id": "AdvancedMachineFeatures", "properties": { "threadsPerCore": { "description": "The number of threads per physical core.", "type": "integer", "format": "int32" } } }, "SelectedObjects": { "id": "SelectedObjects", "properties": { "database": { "description": "Required. The name of the database to migrate.", "type": "string" } }, "description": "A list of objects that the user selects for replication from an external source instance.", "type": "object" }, "Message": { "description": "Represents a notice or warning message from the database.", "type": "object", "id": "Message", "properties": { "message": { "description": "The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message.", "type": "string" }, "severity": { "description": "The severity of the message (e.g., \"NOTICE\" for PostgreSQL, \"WARNING\" for MySQL).", "type": "string" } } }, "SqlActiveDirectoryConfig": { "description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.", "type": "object", "id": "SqlActiveDirectoryConfig", "properties": { "adminCredentialSecretName": { "description": "Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}).", "type": "string" }, "organizationalUnit": { "description": "Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit.", "type": "string" }, "kind": { "description": "This is always sql#activeDirectoryConfig.", "type": "string" }, "mode": { "type": "string", "enumDescriptions": [ "Unspecified mode. Will default to MANAGED_ACTIVE_DIRECTORY if the mode is not specified to maintain backward compatibility.", "Managed Active Directory mode.", "Deprecated: Use CUSTOMER_MANAGED_ACTIVE_DIRECTORY instead.", "Customer-managed Active Directory mode." ], "description": "Optional. The mode of the Active Directory configuration.", "enumDeprecated": [ false, false, true, false ], "enum": [ "ACTIVE_DIRECTORY_MODE_UNSPECIFIED", "MANAGED_ACTIVE_DIRECTORY", "SELF_MANAGED_ACTIVE_DIRECTORY", "CUSTOMER_MANAGED_ACTIVE_DIRECTORY" ] }, "dnsServers": { "items": { "type": "string" }, "description": "Optional. Domain controller IPv4 addresses used to bootstrap Active Directory.", "type": "array" }, "domain": { "description": "The name of the domain (e.g., mydomain.com).", "type": "string" } } }, "SslCertsInsertResponse": { "description": "SslCert insert response.", "type": "object", "id": "SslCertsInsertResponse", "properties": { "operation": { "description": "The operation to track the ssl certs insert request.", "$ref": "Operation" }, "serverCaCert": { "description": "The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.", "$ref": "SslCert" }, "kind": { "description": "This is always `sql#sslCertsInsert`.", "type": "string" }, "clientCert": { "description": "The new client certificate and private key.", "$ref": "SslCertDetail" } } }, "Tier": { "id": "Tier", "properties": { "region": { "description": "The applicable regions for this tier.", "type": "array", "items": { "type": "string" } }, "tier": { "description": "An identifier for the machine type, for example, `db-custom-1-3840`. For related information, see [Pricing](/sql/pricing).", "type": "string" }, "kind": { "description": "This is always `sql#tier`.", "type": "string" }, "RAM": { "description": "The maximum RAM usage of this tier in bytes.", "type": "string", "format": "int64" }, "DiskQuota": { "description": "The maximum disk size of this tier in bytes.", "type": "string", "format": "int64" } }, "description": "A Google Cloud SQL service tier resource.", "type": "object" }, "FlagsListResponse": { "id": "FlagsListResponse", "properties": { "items": { "description": "List of flags.", "type": "array", "items": { "$ref": "Flag" } }, "kind": { "description": "This is always `sql#flagsList`.", "type": "string" } }, "description": "Flags list response.", "type": "object" }, "InstancesPreCheckMajorVersionUpgradeRequest": { "description": "Request for Pre-checks for MVU", "type": "object", "id": "InstancesPreCheckMajorVersionUpgradeRequest", "properties": { "preCheckMajorVersionUpgradeContext": { "description": "Required. Contains details about the pre-check major version upgrade operation.", "$ref": "PreCheckMajorVersionUpgradeContext" } } }, "BackupRetentionSettings": { "id": "BackupRetentionSettings", "properties": { "retainedBackups": { "description": "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.", "type": "integer", "format": "int32" }, "retentionUnit": { "description": "The unit that 'retained_backups' represents.", "type": "string", "enum": [ "RETENTION_UNIT_UNSPECIFIED", "COUNT" ], "enumDescriptions": [ "Backup retention unit is unspecified, will be treated as COUNT.", "Retention will be by count, eg. \"retain the most recent 7 backups\"." ] } }, "description": "We currently only support backup retention by specifying the number of backups we will retain.", "type": "object" }, "DemoteMasterMySqlReplicaConfiguration": { "description": "Read-replica configuration specific to MySQL databases.", "type": "object", "id": "DemoteMasterMySqlReplicaConfiguration", "properties": { "kind": { "description": "This is always `sql#demoteMasterMysqlReplicaConfiguration`.", "type": "string" }, "username": { "description": "The username for the replication connection.", "type": "string" }, "password": { "description": "The password for the replication connection.", "type": "string" }, "caCertificate": { "description": "PEM representation of the trusted CA's x509 certificate.", "type": "string" }, "clientCertificate": { "description": "PEM representation of the replica's x509 certificate.", "type": "string" }, "clientKey": { "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.", "type": "string" } } }, "RotateServerCertificateContext": { "description": "Instance rotate server certificate context.", "type": "object", "id": "RotateServerCertificateContext", "properties": { "nextVersion": { "description": "The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.", "type": "string" }, "kind": { "description": "Optional. This is always `sql#rotateServerCertificateContext`.", "type": "string" } } }, "ExportContext": { "description": "Database instance export context.", "type": "object", "id": "ExportContext", "properties": { "sqlExportOptions": { "description": "Options for exporting data as SQL statements.", "type": "object", "properties": { "parallel": { "description": "Optional. Whether or not the export should be parallel.", "type": "boolean" }, "mysqlExportOptions": { "properties": { "masterData": { "description": "Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.", "type": "integer", "format": "int32" } }, "description": "Options for exporting from MySQL.", "type": "object" }, "schemaOnly": { "description": "Export only schemas.", "type": "boolean" }, "threads": { "format": "int32", "description": "Optional. The number of threads to use for parallel export.", "type": "integer" }, "tables": { "items": { "type": "string" }, "description": "Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.", "type": "array" }, "postgresExportOptions": { "description": "Options for exporting from a Cloud SQL for PostgreSQL instance.", "type": "object", "properties": { "ifExists": { "description": "Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.", "type": "boolean" }, "clean": { "description": "Optional. Use this option to include DROP \u003cobject\u003e SQL statements. Use these statements to delete database objects before running the import operation.", "type": "boolean" } } } } }, "bakExportOptions": { "properties": { "differentialBase": { "description": "Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base", "type": "boolean" }, "striped": { "description": "Whether or not the export should be striped.", "type": "boolean" }, "stripeCount": { "description": "Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.", "type": "integer", "format": "int32" }, "exportLogStartTime": { "format": "google-datetime", "description": "Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.", "type": "string" }, "bakType": { "description": "Type of this bak file will be export, FULL or DIFF, SQL Server only", "type": "string", "enum": [ "BAK_TYPE_UNSPECIFIED", "FULL", "DIFF", "TLOG" ], "enumDescriptions": [ "Default type.", "Full backup.", "Differential backup.", "Transaction Log backup" ] }, "copyOnly": { "description": "Deprecated: copy_only is deprecated. Use differential_base instead", "type": "boolean", "deprecated": true }, "exportLogEndTime": { "format": "google-datetime", "description": "Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.", "type": "string" } }, "description": "Options for exporting BAK files (SQL Server-only)", "type": "object" }, "databases": { "description": "Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.", "type": "array", "items": { "type": "string" } }, "kind": { "description": "This is always `sql#exportContext`.", "type": "string" }, "tdeExportOptions": { "description": "Optional. Export parameters specific to SQL Server TDE certificates", "type": "object", "properties": { "name": { "description": "Required. Certificate name. Applicable only for SQL Server instances.", "type": "string" }, "privateKeyPath": { "description": "Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.", "type": "string" }, "privateKeyPassword": { "description": "Required. Password that encrypts the private key.", "type": "string" }, "certificatePath": { "description": "Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the bucket. Applicable only for SQL Server instances.", "type": "string" } } }, "offload": { "description": "Whether to perform a serverless export.", "type": "boolean" }, "uri": { "description": "The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.", "type": "string" }, "csvExportOptions": { "properties": { "selectQuery": { "description": "The select query used to extract the data.", "type": "string" }, "fieldsTerminatedBy": { "description": "Specifies the character that separates columns within each row (line) of the file.", "type": "string" }, "escapeCharacter": { "description": "Specifies the character that should appear before a data character that needs to be escaped.", "type": "string" }, "linesTerminatedBy": { "description": "This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.", "type": "string" }, "quoteCharacter": { "description": "Specifies the quoting character to be used when a data value is quoted.", "type": "string" } }, "description": "Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.", "type": "object" }, "fileType": { "enumDescriptions": [ "Unknown file type.", "File containing SQL statements.", "File in CSV format.", "", "TDE certificate." ], "description": "The file type for the specified uri.", "type": "string", "enum": [ "SQL_FILE_TYPE_UNSPECIFIED", "SQL", "CSV", "BAK", "TDE" ] } } }, "ReadPoolAutoScaleConfig": { "description": "The read pool auto-scale configuration.", "type": "object", "id": "ReadPoolAutoScaleConfig", "properties": { "minNodeCount": { "format": "int32", "description": "Minimum number of read pool nodes to be maintained.", "type": "integer" }, "scaleInCooldownSeconds": { "format": "int32", "description": "The cooldown period for scale-in operations.", "type": "integer" }, "scaleOutCooldownSeconds": { "format": "int32", "description": "The cooldown period for scale-out operations.", "type": "integer" }, "enabled": { "description": "Indicates whether read pool auto scaling is enabled.", "type": "boolean" }, "maxNodeCount": { "format": "int32", "description": "Maximum number of read pool nodes to be maintained.", "type": "integer" }, "disableScaleIn": { "description": "Indicates whether read pool auto scaling supports scale in operations (removing nodes).", "type": "boolean" }, "targetMetrics": { "description": "Optional. Target metrics for read pool auto scaling.", "type": "array", "items": { "$ref": "TargetMetric" } } } }, "AclEntry": { "description": "An entry for an Access Control list.", "type": "object", "id": "AclEntry", "properties": { "value": { "description": "The allowlisted value for the access control list.", "type": "string" }, "name": { "description": "Optional. A label to identify this entry.", "type": "string" }, "kind": { "description": "This is always `sql#aclEntry`.", "type": "string" }, "expirationTime": { "format": "google-datetime", "description": "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`.", "type": "string" } } }, "CloneContext": { "description": "Database instance clone context.", "type": "object", "id": "CloneContext", "properties": { "allocatedIpRange": { "description": "The name of the allocated ip range for the private ip Cloud SQL instance. For example: \"google-managed-services-default\". If set, the cloned instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use.", "type": "string" }, "preferredZone": { "description": "Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.", "type": "string" }, "destinationProject": { "description": "Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.", "type": "string" }, "pitrTimestampMs": { "description": "Reserved for future use.", "type": "string", "format": "int64" }, "databaseNames": { "description": "(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.", "type": "array", "items": { "type": "string" } }, "pointInTime": { "description": "Timestamp, if specified, identifies the time to which the source instance is cloned.", "type": "string", "format": "google-datetime" }, "preferredSecondaryZone": { "description": "Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types.", "type": "string" }, "destinationNetwork": { "description": "Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:`projects/my-network-project/global/networks/my-network`. This field is only required for cross-project cloning.", "type": "string" }, "kind": { "description": "This is always `sql#cloneContext`.", "type": "string" }, "destinationInstanceName": { "description": "Required. Name of the Cloud SQL instance to be created as a clone.", "type": "string" }, "sourceInstanceDeletionTime": { "description": "The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.", "type": "string", "format": "google-datetime" }, "binLogCoordinates": { "description": "Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.", "$ref": "BinLogCoordinates" } } }, "PscConfig": { "id": "PscConfig", "properties": { "pscAutoConnections": { "description": "Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.", "type": "array", "items": { "$ref": "PscAutoConnectionConfig" } }, "pscWriteEndpointDnsEnabled": { "description": "Optional. Indicates whether PSC write endpoint DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal global DNS record across all networks configured with Private Service Connect (PSC) auto-connections that always points to the cluster primary instance. This feature is only supported for Enterprise Plus edition. This will default to true for new Enterprise Plus instances when `psc_auto_dns_enabled` is enabled.", "type": "boolean" }, "allowedConsumerProjects": { "description": "Optional. 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).", "type": "array", "items": { "type": "string" } }, "pscAutoDnsEnabled": { "description": "Optional. Indicates whether PSC DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect (PSC) auto-connections. This will default to true for new instances when Private Service Connect is enabled.", "type": "boolean" }, "pscEnabled": { "description": "Whether PSC connectivity is enabled for this instance.", "type": "boolean" }, "networkAttachmentUri": { "description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID", "type": "string" } }, "description": "PSC settings for a Cloud SQL instance.", "type": "object" }, "SqlInstancesReleaseSsrsLeaseResponse": { "id": "SqlInstancesReleaseSsrsLeaseResponse", "properties": { "operationId": { "description": "The unique identifier for this operation.", "type": "string" } }, "description": "Response for the release SSRS lease request.", "type": "object" }, "ConnectionPoolConfig": { "id": "ConnectionPoolConfig", "properties": { "flags": { "items": { "$ref": "ConnectionPoolFlags" }, "description": "Optional. List of connection pool configuration flags.", "type": "array" }, "poolerCount": { "format": "int32", "readOnly": true, "description": "Output only. Number of connection poolers.", "type": "integer" }, "connectionPoolingEnabled": { "description": "Whether managed connection pooling is enabled.", "type": "boolean" } }, "description": "The managed connection pooling configuration.", "type": "object" }, "ListBackupsResponse": { "id": "ListBackupsResponse", "properties": { "backups": { "items": { "$ref": "Backup" }, "description": "A list of backups.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages.", "type": "string" }, "warnings": { "items": { "$ref": "ApiWarning" }, "description": "If a region isn't unavailable or if an unknown error occurs, then a warning message is returned.", "type": "array" } }, "description": "The response payload containing a list of the backups.", "type": "object" }, "ImportContext": { "id": "ImportContext", "properties": { "tdeImportOptions": { "description": "Optional. Import parameters specific to SQL Server TDE certificates", "type": "object", "properties": { "privateKeyPath": { "description": "Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.", "type": "string" }, "privateKeyPassword": { "description": "Required. Password that encrypts the private key.", "type": "string" }, "certificatePath": { "description": "Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.", "type": "string" }, "name": { "description": "Required. Certificate name. Applicable only for SQL Server instances.", "type": "string" } } }, "importUser": { "description": "The PostgreSQL user for this import operation. PostgreSQL instances only.", "type": "string" }, "kind": { "description": "This is always `sql#importContext`.", "type": "string" }, "bakImportOptions": { "description": "Import parameters specific to SQL Server .BAK files", "type": "object", "properties": { "encryptionOptions": { "type": "object", "properties": { "pvkPath": { "description": "Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.", "type": "string" }, "pvkPassword": { "description": "Password that encrypts the private key", "type": "string" }, "keepEncrypted": { "description": "Optional. Whether the imported file remains encrypted.", "type": "boolean" }, "certPath": { "description": "Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.", "type": "string" } } }, "bakType": { "description": "Type of the bak content, FULL or DIFF", "type": "string", "enum": [ "BAK_TYPE_UNSPECIFIED", "FULL", "DIFF", "TLOG" ], "enumDescriptions": [ "Default type.", "Full backup.", "Differential backup.", "Transaction Log backup" ] }, "striped": { "description": "Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.", "type": "boolean" }, "recoveryOnly": { "description": "Whether or not the backup importing request will just bring database online without downloading Bak content only one of \"no_recovery\" and \"recovery_only\" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.", "type": "boolean" }, "noRecovery": { "description": "Whether or not the backup importing will restore database with NORECOVERY option. Applies only to Cloud SQL for SQL Server.", "type": "boolean" }, "stopAt": { "description": "Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.", "type": "string", "format": "google-datetime" }, "stopAtMark": { "description": "Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.", "type": "string" } } }, "uri": { "description": "Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.", "type": "string" }, "database": { "description": "The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.", "type": "string" }, "csvImportOptions": { "description": "Options for importing data as CSV.", "type": "object", "properties": { "table": { "description": "The table to which CSV data is imported.", "type": "string" }, "linesTerminatedBy": { "description": "This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.", "type": "string" }, "escapeCharacter": { "description": "Specifies the character that should appear before a data character that needs to be escaped.", "type": "string" }, "fieldsTerminatedBy": { "description": "Specifies the character that separates columns within each row (line) of the file.", "type": "string" }, "columns": { "items": { "type": "string" }, "description": "The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.", "type": "array" }, "quoteCharacter": { "description": "Specifies the quoting character to be used when a data value is quoted.", "type": "string" } } }, "fileType": { "description": "The file type for the specified uri.\\`SQL`: The file contains SQL statements. \\`CSV`: The file contains CSV data.", "type": "string", "enum": [ "SQL_FILE_TYPE_UNSPECIFIED", "SQL", "CSV", "BAK", "TDE" ], "enumDescriptions": [ "Unknown file type.", "File containing SQL statements.", "File in CSV format.", "", "TDE certificate." ] }, "sqlImportOptions": { "description": "Optional. Options for importing data from SQL statements.", "type": "object", "properties": { "threads": { "description": "Optional. The number of threads to use for parallel import.", "type": "integer", "format": "int32" }, "parallel": { "description": "Optional. Whether or not the import should be parallel.", "type": "boolean" }, "postgresImportOptions": { "description": "Optional. Options for importing from a Cloud SQL for PostgreSQL instance.", "type": "object", "properties": { "clean": { "description": "Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", "type": "boolean" }, "ifExists": { "description": "Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", "type": "boolean" } } } } } }, "description": "Database instance import context.", "type": "object" }, "InstanceReference": { "description": "Reference to another Cloud SQL instance.", "type": "object", "id": "InstanceReference", "properties": { "name": { "description": "The name of the Cloud SQL instance being referenced. This does not include the project ID.", "type": "string" }, "project": { "description": "The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it.", "type": "string" }, "region": { "description": "The region of the Cloud SQL instance being referenced.", "type": "string" } } }, "InstancesListServerCasResponse": { "description": "Instances ListServerCas response.", "type": "object", "id": "InstancesListServerCasResponse", "properties": { "certs": { "items": { "$ref": "SslCert" }, "description": "List of server CA certificates for the instance.", "type": "array" }, "activeVersion": { "type": "string" }, "kind": { "description": "This is always `sql#instancesListServerCas`.", "type": "string" } } }, "PerformDiskShrinkContext": { "description": "Perform disk shrink context.", "type": "object", "id": "PerformDiskShrinkContext", "properties": { "targetSizeGb": { "format": "int64", "description": "The target disk shrink size in GigaBytes.", "type": "string" } } }, "GenerateEphemeralCertResponse": { "id": "GenerateEphemeralCertResponse", "properties": { "ephemeralCert": { "description": "Generated cert", "$ref": "SslCert" } }, "description": "Ephemeral certificate creation request.", "type": "object" }, "InstancesListServerCertificatesResponse": { "description": "Instances ListServerCertificates response.", "type": "object", "id": "InstancesListServerCertificatesResponse", "properties": { "serverCerts": { "items": { "$ref": "SslCert" }, "description": "List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.", "type": "array" }, "caCerts": { "description": "List of server CA certificates for the instance.", "type": "array", "items": { "$ref": "SslCert" } }, "activeVersion": { "description": "The `sha1_fingerprint` of the active certificate from `server_certs`.", "type": "string" }, "kind": { "description": "This is always `sql#instancesListServerCertificates`.", "type": "string" } } }, "SslCertsListResponse": { "description": "SslCerts list response.", "type": "object", "id": "SslCertsListResponse", "properties": { "items": { "description": "List of client certificates for the instance.", "type": "array", "items": { "$ref": "SslCert" } }, "kind": { "description": "This is always `sql#sslCertsList`.", "type": "string" } } }, "DataCacheConfig": { "id": "DataCacheConfig", "properties": { "dataCacheEnabled": { "description": "Whether data cache is enabled for the instance.", "type": "boolean" } }, "description": "Data cache configurations.", "type": "object" }, "SqlServerUserDetails": { "description": "Represents a Sql Server user on the Cloud SQL instance.", "type": "object", "id": "SqlServerUserDetails", "properties": { "disabled": { "description": "If the user has been disabled", "type": "boolean" }, "serverRoles": { "items": { "type": "string" }, "description": "The server roles for this user", "type": "array" } } }, "OperationsListResponse": { "description": "Operations list response.", "type": "object", "id": "OperationsListResponse", "properties": { "nextPageToken": { "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.", "type": "string" }, "kind": { "description": "This is always `sql#operationsList`.", "type": "string" }, "items": { "items": { "$ref": "Operation" }, "description": "List of operation resources.", "type": "array" } } }, "SslCertDetail": { "description": "SslCertDetail.", "type": "object", "id": "SslCertDetail", "properties": { "certInfo": { "description": "The public information about the cert.", "$ref": "SslCert" }, "certPrivateKey": { "description": "The private key for the client cert, in pem format. Keep private in order to protect your security.", "type": "string" } } }, "Reschedule": { "type": "object", "id": "Reschedule", "properties": { "rescheduleType": { "enumDescriptions": [ "", "Reschedules maintenance to happen now (within 5 minutes).", "Reschedules maintenance to occur within one week from the originally scheduled day and time.", "Reschedules maintenance to a specific time and day." ], "description": "Required. The type of the reschedule.", "type": "string", "enum": [ "RESCHEDULE_TYPE_UNSPECIFIED", "IMMEDIATE", "NEXT_AVAILABLE_WINDOW", "SPECIFIC_TIME" ] }, "scheduleTime": { "format": "google-datetime", "description": "Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string" } } }, "Metadata": { "description": "The additional metadata information regarding the execution of the SQL statements.", "type": "object", "id": "Metadata", "properties": { "sqlStatementExecutionTime": { "format": "google-duration", "description": "The time taken to execute the SQL statements.", "type": "string" } } }, "GeminiInstanceConfig": { "id": "GeminiInstanceConfig", "properties": { "flagRecommenderEnabled": { "description": "Output only. Whether the flag recommender is enabled.", "type": "boolean", "readOnly": true }, "oomSessionCancelEnabled": { "readOnly": true, "description": "Output only. Whether canceling the out-of-memory (OOM) session is enabled.", "type": "boolean" }, "entitled": { "description": "Output only. Whether Gemini is enabled.", "type": "boolean", "readOnly": true }, "activeQueryEnabled": { "description": "Output only. Whether the active query is enabled.", "type": "boolean", "readOnly": true }, "indexAdvisorEnabled": { "readOnly": true, "description": "Output only. Whether the index advisor is enabled.", "type": "boolean" }, "googleVacuumMgmtEnabled": { "description": "Output only. Whether the vacuum management is enabled.", "type": "boolean", "readOnly": true } }, "description": "Gemini instance configuration.", "type": "object" }, "SqlInstancesStartExternalSyncRequest": { "id": "SqlInstancesStartExternalSyncRequest", "properties": { "skipVerification": { "description": "Whether to skip the verification step (VESS).", "type": "boolean" }, "mysqlSyncConfig": { "description": "MySQL-specific settings for start external sync.", "$ref": "MySqlSyncConfig" }, "syncParallelLevel": { "enumDescriptions": [ "Unknown sync parallel level. Will be defaulted to OPTIMAL.", "Minimal parallel level.", "Optimal parallel level.", "Maximum parallel level." ], "description": "Optional. Parallel level for initial data sync. Currently only applicable for MySQL.", "type": "string", "enum": [ "EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED", "MIN", "OPTIMAL", "MAX" ] }, "syncMode": { "enumDescriptions": [ "Unknown external sync mode, will be defaulted to ONLINE mode", "Online external sync will set up replication after initial data external sync", "Offline external sync only dumps and loads a one-time snapshot of the primary instance's data" ], "description": "External sync mode.", "type": "string", "enum": [ "EXTERNAL_SYNC_MODE_UNSPECIFIED", "ONLINE", "OFFLINE" ] }, "migrationType": { "description": "Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.", "type": "string", "enum": [ "MIGRATION_TYPE_UNSPECIFIED", "LOGICAL", "PHYSICAL" ], "enumDescriptions": [ "Default value is a logical dump file-based migration", "Logical dump file-based migration", "Physical file-based migration" ] }, "replicaOverwriteEnabled": { "description": "Optional. MySQL only. True if end-user has confirmed that this SES call will wipe replica databases overlapping with the proposed selected_objects. If this field is not set and there are both overlapping and additional databases proposed, an error will be returned.", "type": "boolean" } }, "description": "Instance start external sync request.", "type": "object" }, "TiersListResponse": { "id": "TiersListResponse", "properties": { "items": { "items": { "$ref": "Tier" }, "description": "List of tiers.", "type": "array" }, "kind": { "description": "This is always `sql#tiersList`.", "type": "string" } }, "description": "Tiers list response.", "type": "object" }, "SslCertsInsertRequest": { "description": "SslCerts insert request.", "type": "object", "id": "SslCertsInsertRequest", "properties": { "commonName": { "description": "User supplied name. Must be a distinct name from the other certificates for this instance.", "type": "string" } } }, "Row": { "description": "Contains the values for a row.", "type": "object", "id": "Row", "properties": { "values": { "items": { "$ref": "Value" }, "description": "The values for the row.", "type": "array" } } }, "InstancesImportRequest": { "id": "InstancesImportRequest", "properties": { "importContext": { "description": "Contains details about the import operation.", "$ref": "ImportContext" } }, "description": "Database instance import request.", "type": "object" }, "User": { "description": "A Cloud SQL user resource.", "type": "object", "id": "User", "properties": { "project": { "description": "The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL.", "type": "string" }, "sqlserverUserDetails": { "$ref": "SqlServerUserDetails" }, "kind": { "description": "This is always `sql#user`.", "type": "string" }, "password": { "description": "The password for the user.", "type": "string" }, "passwordPolicy": { "description": "User level password validation policy.", "$ref": "UserPasswordValidationPolicy" }, "instance": { "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.", "type": "string" }, "databaseRoles": { "items": { "type": "string" }, "description": "Optional. Role memberships of the user", "type": "array" }, "host": { "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.", "type": "string" }, "etag": { "description": "This field is deprecated and will be removed from a future version of the API.", "type": "string" }, "iamStatus": { "description": "Indicates if a group is active or inactive for IAM database authentication.", "type": "string", "enum": [ "IAM_STATUS_UNSPECIFIED", "INACTIVE", "ACTIVE" ], "enumDescriptions": [ "The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive or active. Users with an IamStatus of IAM_STATUS_UNSPECIFIED will not display whether they are active or inactive as that is not applicable to them.", "INACTIVE indicates a group is not available for IAM database authentication.", "ACTIVE indicates a group is available for IAM database authentication." ] }, "iamEmail": { "description": "Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.", "type": "string" }, "dualPasswordType": { "enumDescriptions": [ "The default value.", "Do not update the user's dual password status.", "No dual password usable for connecting using this user.", "Dual password usable for connecting using this user." ], "description": "Dual password status for the user.", "type": "string", "enum": [ "DUAL_PASSWORD_TYPE_UNSPECIFIED", "NO_MODIFY_DUAL_PASSWORD", "NO_DUAL_PASSWORD", "DUAL_PASSWORD" ] }, "name": { "description": "The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.", "type": "string" }, "type": { "enumDescriptions": [ "The database's built-in user type.", "Cloud IAM user.", "Cloud IAM service account.", "Cloud IAM group. Not used for login.", "Read-only. Login for a user that belongs to the Cloud IAM group.", "Read-only. Login for a service account that belongs to the Cloud IAM group.", "Microsoft Entra ID user." ], "description": "The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.", "type": "string", "enum": [ "BUILT_IN", "CLOUD_IAM_USER", "CLOUD_IAM_SERVICE_ACCOUNT", "CLOUD_IAM_GROUP", "CLOUD_IAM_GROUP_USER", "CLOUD_IAM_GROUP_SERVICE_ACCOUNT", "ENTRAID_USER" ] } } }, "BackupConfiguration": { "id": "BackupConfiguration", "properties": { "startTime": { "description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.", "type": "string" }, "location": { "description": "Location of the backup", "type": "string" }, "pointInTimeRecoveryEnabled": { "description": "Whether point in time recovery is enabled.", "type": "boolean" }, "transactionalLogStorageState": { "description": "Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.", "enum": [ "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED", "DISK", "SWITCHING_TO_CLOUD_STORAGE", "SWITCHED_TO_CLOUD_STORAGE", "CLOUD_STORAGE" ], "readOnly": true, "enumDescriptions": [ "Unspecified.", "The transaction logs used for PITR for the instance are stored on a data disk.", "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.", "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.", "The transaction logs used for PITR for the instance are stored in Cloud Storage. Only applicable to MySQL and PostgreSQL." ], "type": "string" }, "kind": { "description": "This is always `sql#backupConfiguration`.", "type": "string" }, "backupRetentionSettings": { "description": "Backup retention settings.", "$ref": "BackupRetentionSettings" }, "backupTier": { "type": "string", "readOnly": true, "enumDescriptions": [ "Unspecified.", "Instance is managed by Cloud SQL.", "Deprecated: ADVANCED is deprecated. Please use ENHANCED instead.", "Instance is managed by Google Cloud Backup and DR Service." ], "description": "Output only. Backup tier that manages the backups for the instance.", "enumDeprecated": [ false, false, true, false ], "enum": [ "BACKUP_TIER_UNSPECIFIED", "STANDARD", "ADVANCED", "ENHANCED" ] }, "replicationLogArchivingEnabled": { "description": "Reserved for future use.", "type": "boolean" }, "binaryLogEnabled": { "description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.", "type": "boolean" }, "enabled": { "description": "Whether this configuration is enabled.", "type": "boolean" }, "transactionLogRetentionDays": { "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", "type": "integer", "format": "int32" } }, "description": "Database instance backup configuration.", "type": "object" }, "Interval": { "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", "type": "object", "id": "Interval", "properties": { "startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string", "format": "google-datetime" } } }, "SqlServerDatabaseDetails": { "description": "Represents a Sql Server database on the Cloud SQL instance.", "type": "object", "id": "SqlServerDatabaseDetails", "properties": { "compatibilityLevel": { "description": "The version of SQL Server with which the database is to be made compatible", "type": "integer", "format": "int32" }, "recoveryModel": { "description": "The recovery model of a SQL Server database", "type": "string" } } }, "SqlInstancesVerifyExternalSyncSettingsRequest": { "id": "SqlInstancesVerifyExternalSyncSettingsRequest", "properties": { "verifyReplicationOnly": { "description": "Optional. Flag to verify settings required by replication setup only", "type": "boolean" }, "selectedObjects": { "description": "Optional. Migrate only the specified objects from the source instance. If this field is empty, then migrate all objects.", "type": "array", "items": { "$ref": "ExternalSyncSelectedObject" } }, "mysqlSyncConfig": { "description": "Optional. MySQL-specific settings for start external sync.", "$ref": "MySqlSyncConfig" }, "syncParallelLevel": { "description": "Optional. Parallel level for initial data sync. Only applicable for PostgreSQL.", "type": "string", "enum": [ "EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED", "MIN", "OPTIMAL", "MAX" ], "enumDescriptions": [ "Unknown sync parallel level. Will be defaulted to OPTIMAL.", "Minimal parallel level.", "Optimal parallel level.", "Maximum parallel level." ] }, "verifyConnectionOnly": { "description": "Flag to enable verifying connection only", "type": "boolean" }, "syncMode": { "description": "External sync mode", "type": "string", "enum": [ "EXTERNAL_SYNC_MODE_UNSPECIFIED", "ONLINE", "OFFLINE" ], "enumDescriptions": [ "Unknown external sync mode, will be defaulted to ONLINE mode", "Online external sync will set up replication after initial data external sync", "Offline external sync only dumps and loads a one-time snapshot of the primary instance's data" ] }, "migrationType": { "enumDescriptions": [ "Default value is a logical dump file-based migration", "Logical dump file-based migration", "Physical file-based migration" ], "description": "Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.", "type": "string", "enum": [ "MIGRATION_TYPE_UNSPECIFIED", "LOGICAL", "PHYSICAL" ] } }, "description": "Instance verify external sync settings request.", "type": "object" }, "DiskEncryptionStatus": { "description": "Disk encryption status for an instance.", "type": "object", "id": "DiskEncryptionStatus", "properties": { "kmsKeyVersionName": { "description": "KMS key version used to encrypt the Cloud SQL instance resource", "type": "string" }, "kind": { "description": "This is always `sql#diskEncryptionStatus`.", "type": "string" } } }, "DemoteContext": { "id": "DemoteContext", "properties": { "kind": { "description": "This is always `sql#demoteContext`.", "type": "string" }, "sourceRepresentativeInstanceName": { "description": "Required. The name of the instance which acts as the on-premises primary instance in the replication setup.", "type": "string" } }, "description": "This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.", "type": "object" }, "ApiWarning": { "description": "An Admin API warning message.", "type": "object", "id": "ApiWarning", "properties": { "code": { "description": "Code to uniquely identify the warning type.", "type": "string", "enum": [ "SQL_API_WARNING_CODE_UNSPECIFIED", "REGION_UNREACHABLE", "MAX_RESULTS_EXCEEDS_LIMIT", "COMPROMISED_CREDENTIALS", "INTERNAL_STATE_FAILURE" ], "enumDescriptions": [ "An unknown or unset warning type from Cloud SQL API.", "Warning when one or more regions are not reachable. The returned result set may be incomplete.", "Warning when user provided maxResults parameter exceeds the limit. The returned result set may be incomplete.", "Warning when user tries to create/update a user with credentials that have previously been compromised by a public data breach.", "Warning when the operation succeeds but some non-critical workflow state failed." ] }, "message": { "description": "The warning message.", "type": "string" }, "region": { "description": "The region name for REGION_UNREACHABLE warning.", "type": "string" } } }, "SqlInstancesRescheduleMaintenanceRequestBody": { "description": "Reschedule options for maintenance windows.", "type": "object", "id": "SqlInstancesRescheduleMaintenanceRequestBody", "properties": { "reschedule": { "description": "Required. The type of the reschedule the user wants.", "$ref": "Reschedule" } } }, "DatabaseInstance": { "description": "A Cloud SQL instance resource.", "type": "object", "id": "DatabaseInstance", "properties": { "maintenanceVersion": { "description": "The current software version on the instance.", "type": "string" }, "connectionName": { "description": "Connection name of the Cloud SQL instance used in connection strings.", "type": "string" }, "tags": { "additionalProperties": { "type": "string" }, "description": "Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: `\"\" : \"\"`. For example, a single resource can have the following tags: ``` \"123/environment\": \"production\", \"123/costCenter\": \"marketing\", ``` For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.", "type": "object" }, "settings": { "description": "The user settings.", "$ref": "Settings" }, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "type": "array", "items": { "$ref": "AvailableDatabaseVersion" }, "readOnly": true }, "currentDiskSize": { "format": "int64", "deprecated": true, "description": "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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details.", "type": "string" }, "databaseVersion": { "description": "The database engine type and version. The `databaseVersion` field cannot be changed after instance creation.", "enumDeprecated": [ false, true, true, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "MYSQL_8_0_18", "MYSQL_8_0_26", "MYSQL_8_0_27", "MYSQL_8_0_28", "MYSQL_8_0_29", "MYSQL_8_0_30", "MYSQL_8_0_31", "MYSQL_8_0_32", "MYSQL_8_0_33", "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", "MYSQL_8_0_37", "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", "MYSQL_8_0_43", "MYSQL_8_0_44", "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", "MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", "SQLSERVER_2017_WEB", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", "POSTGRES_18", "POSTGRES_19", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", "SQLSERVER_2019_WEB", "SQLSERVER_2022_STANDARD", "SQLSERVER_2022_ENTERPRISE", "SQLSERVER_2022_EXPRESS", "SQLSERVER_2022_WEB", "SQLSERVER_2025_STANDARD", "SQLSERVER_2025_ENTERPRISE", "SQLSERVER_2025_EXPRESS" ], "type": "string", "enumDescriptions": [ "This is an unknown database version.", "The database version is MySQL 5.1.", "The database version is MySQL 5.5.", "The database version is MySQL 5.6.", "The database version is MySQL 5.7.", "The database version is MySQL 8.", "The database major version is MySQL 8.0 and the minor version is 18.", "The database major version is MySQL 8.0 and the minor version is 26.", "The database major version is MySQL 8.0 and the minor version is 27.", "The database major version is MySQL 8.0 and the minor version is 28.", "The database major version is MySQL 8.0 and the minor version is 29.", "The database major version is MySQL 8.0 and the minor version is 30.", "The database major version is MySQL 8.0 and the minor version is 31.", "The database major version is MySQL 8.0 and the minor version is 32.", "The database major version is MySQL 8.0 and the minor version is 33.", "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", "The database major version is MySQL 8.0 and the minor version is 37.", "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", "The database major version is MySQL 8.0 and the minor version is 43.", "The database major version is MySQL 8.0 and the minor version is 44.", "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", "The database version is SQL Server 2017 Web.", "The database version is PostgreSQL 9.6.", "The database version is PostgreSQL 10.", "The database version is PostgreSQL 11.", "The database version is PostgreSQL 12.", "The database version is PostgreSQL 13.", "The database version is PostgreSQL 14.", "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", "The database version is PostgreSQL 18.", "The database version is PostgreSQL 19.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", "The database version is SQL Server 2019 Web.", "The database version is SQL Server 2022 Standard.", "The database version is SQL Server 2022 Enterprise.", "The database version is SQL Server 2022 Express.", "The database version is SQL Server 2022 Web.", "The database version is SQL Server 2025 Standard.", "The database version is SQL Server 2025 Enterprise.", "The database version is SQL Server 2025 Express." ] }, "outOfDiskReport": { "description": "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", "$ref": "SqlOutOfDiskReport" }, "nodes": { "items": { "$ref": "PoolNodeConfig" }, "description": "Output only. Entries containing information about each read pool node of the read pool.", "type": "array", "readOnly": true }, "dnsName": { "readOnly": true, "description": "Output only. The dns name of the instance.", "type": "string" }, "databaseInstalledVersion": { "description": "Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`.", "type": "string", "readOnly": true }, "pscServiceAttachmentLink": { "description": "Output only. The link to service attachment of PSC instance.", "type": "string", "readOnly": true }, "rootPassword": { "description": "Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.", "type": "string" }, "satisfiesPzi": { "description": "Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.", "type": "boolean", "readOnly": true }, "state": { "description": "The current serving state of the Cloud SQL instance.", "enumDeprecated": [ false, false, false, false, false, false, false, true, false ], "enum": [ "SQL_INSTANCE_STATE_UNSPECIFIED", "RUNNABLE", "SUSPENDED", "PENDING_DELETE", "PENDING_CREATE", "MAINTENANCE", "FAILED", "ONLINE_MAINTENANCE", "REPAIRING" ], "type": "string", "enumDescriptions": [ "The state of the instance is unknown.", "The instance is running, or has been stopped by owner.", "The instance is not available, for example due to problems with billing.", "The instance is being deleted.", "The instance is being created.", "The instance is down for maintenance.", "The creation of the instance failed or a fatal error occurred during maintenance.", "Deprecated", "(Applicable to read pool nodes only.) The read pool node needs to be repaired. The database might be unavailable." ] }, "nodeCount": { "description": "The number of read pool nodes in a read pool.", "type": "integer", "format": "int32" }, "serviceAccountEmailAddress": { "description": "The service account email address assigned to the instance.\\This property is read-only.", "type": "string" }, "etag": { "description": "This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.", "type": "string" }, "kind": { "description": "This is always `sql#instance`.", "type": "string" }, "writeEndpoint": { "readOnly": true, "description": "Output only. The dns name of the primary instance in a replication group.", "type": "string" }, "diskEncryptionConfiguration": { "description": "Disk encryption configuration specific to an instance.", "$ref": "DiskEncryptionConfiguration" }, "ipAddresses": { "description": "The assigned IP addresses for the instance.", "type": "array", "items": { "$ref": "IpMapping" } }, "sqlNetworkArchitecture": { "enumDescriptions": [ "", "The instance uses the new network architecture.", "The instance uses the old network architecture." ], "type": "string", "enum": [ "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED", "NEW_NETWORK_ARCHITECTURE", "OLD_NETWORK_ARCHITECTURE" ] }, "switchTransactionLogsToCloudStorageEnabled": { "description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", "type": "boolean" }, "failoverReplica": { "properties": { "available": { "description": "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.", "type": "boolean" }, "name": { "description": "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.", "type": "string" } }, "description": "The name and status of the failover replica.", "type": "object" }, "gceZone": { "description": "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.", "type": "string" }, "secondaryGceZone": { "description": "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.", "type": "string" }, "includeReplicasForMajorVersionUpgrade": { "description": "Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.", "type": "boolean" }, "maxDiskSize": { "description": "The maximum disk size of the instance in bytes.", "type": "string", "deprecated": true, "format": "int64" }, "name": { "description": "Name of the Cloud SQL instance. This does not include the project ID.", "type": "string" }, "replicationCluster": { "description": "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. Applicable to MySQL and PostgreSQL.", "$ref": "ReplicationCluster" }, "dnsNames": { "description": "Output only. The list of DNS names used by this instance.", "type": "array", "items": { "$ref": "DnsNameMapping" }, "readOnly": true }, "masterInstanceName": { "description": "The name of the instance which will act as primary in the replication setup.", "type": "string" }, "availableMaintenanceVersions": { "readOnly": true, "description": "Output only. List all maintenance versions applicable on the instance", "type": "array", "items": { "type": "string" } }, "instanceType": { "description": "The instance type.", "type": "string", "enum": [ "SQL_INSTANCE_TYPE_UNSPECIFIED", "CLOUD_SQL_INSTANCE", "ON_PREMISES_INSTANCE", "READ_REPLICA_INSTANCE", "READ_POOL_INSTANCE" ], "enumDescriptions": [ "This is an unknown Cloud SQL instance type.", "A regular Cloud SQL instance that is not replicating from a primary instance.", "An instance running on the customer's premises that is not managed by Cloud SQL.", "A Cloud SQL instance acting as a read-replica.", "A Cloud SQL read pool." ] }, "region": { "description": "The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`.", "type": "string" }, "serverCaCert": { "description": "SSL configuration.", "$ref": "SslCert" }, "suspensionReason": { "description": "If the instance state is SUSPENDED, the reason for the suspension.", "type": "array", "items": { "enumDescriptions": [ "This is an unknown suspension reason.", "The instance is suspended due to billing issues (for example:, account issue)", "The instance is suspended due to illegal content (for example:, child pornography, copyrighted material, etc.).", "The instance is causing operational issues (for example:, causing the database to crash).", "The KMS key used by the instance is either revoked or denied access to", "The project is suspended due to abuse detected by Ares." ], "type": "string", "enum": [ "SQL_SUSPENSION_REASON_UNSPECIFIED", "BILLING_ISSUE", "LEGAL_ISSUE", "OPERATIONAL_ISSUE", "KMS_KEY_ISSUE", "PROJECT_ABUSE" ] } }, "project": { "description": "The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.", "type": "string" }, "ipv6Address": { "deprecated": true, "description": "The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.", "type": "string" }, "primaryDnsName": { "readOnly": true, "deprecated": true, "description": "Output only. DEPRECATED: please use write_endpoint instead.", "type": "string" }, "backendType": { "type": "string", "enumDescriptions": [ "This is an unknown backend type for instance.", "V1 speckle instance.", "V2 speckle instance.", "On premises instance." ], "description": "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.", "enumDeprecated": [ false, true, false, false ], "enum": [ "SQL_BACKEND_TYPE_UNSPECIFIED", "FIRST_GEN", "SECOND_GEN", "EXTERNAL" ] }, "replicaNames": { "items": { "type": "string" }, "description": "The replicas of the instance.", "type": "array" }, "onPremisesConfiguration": { "description": "Configuration specific to on-premises instances.", "$ref": "OnPremisesConfiguration" }, "replicaConfiguration": { "description": "Configuration specific to failover replicas and read replicas.", "$ref": "ReplicaConfiguration" }, "scheduledMaintenance": { "description": "The start time of any upcoming scheduled maintenance for this instance.", "$ref": "SqlScheduledMaintenance" }, "selfLink": { "description": "The URI of this resource.", "type": "string" }, "createTime": { "description": "Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string", "readOnly": true, "format": "google-datetime" }, "satisfiesPzs": { "description": "This status indicates whether the instance satisfies PZS. The status is reserved for future use.", "type": "boolean" }, "diskEncryptionStatus": { "description": "Disk encryption status specific to an instance.", "$ref": "DiskEncryptionStatus" }, "geminiConfig": { "description": "Gemini instance configuration.", "$ref": "GeminiInstanceConfig" } } }, "DiskEncryptionConfiguration": { "description": "Disk encryption configuration for an instance.", "type": "object", "id": "DiskEncryptionConfiguration", "properties": { "kmsKeyName": { "description": "Resource name of KMS key for disk encryption", "type": "string" }, "kind": { "description": "This is always `sql#diskEncryptionConfiguration`.", "type": "string" } } }, "InstancesDemoteRequest": { "id": "InstancesDemoteRequest", "properties": { "demoteContext": { "description": "Required. Contains details about the demote operation.", "$ref": "DemoteContext" } }, "description": "This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.", "type": "object" }, "InstancesFailoverRequest": { "id": "InstancesFailoverRequest", "properties": { "failoverContext": { "description": "Failover Context.", "$ref": "FailoverContext" } }, "description": "Instance failover request.", "type": "object" }, "InstancesRotateServerCertificateRequest": { "description": "Rotate server certificate request.", "type": "object", "id": "InstancesRotateServerCertificateRequest", "properties": { "rotateServerCertificateContext": { "description": "Optional. Contains details about the rotate server certificate operation.", "$ref": "RotateServerCertificateContext" } } }, "ExecuteSqlPayload": { "description": "The request payload used to execute SQL statements.", "type": "object", "id": "ExecuteSqlPayload", "properties": { "database": { "description": "Optional. Name of the database on which the statement will be executed.", "type": "string" }, "user": { "description": "Optional. The name of an existing database user to connect to the database. When `auto_iam_authn` is set to true, this field is ignored and the API caller's IAM user is used.", "type": "string" }, "application": { "description": "Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters.", "type": "string" }, "sqlStatement": { "description": "Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.", "type": "string" }, "autoIamAuthn": { "description": "Optional. When set to `true`, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database.", "type": "boolean" }, "rowLimit": { "description": "Optional. The maximum number of rows returned per SQL statement.", "type": "string", "format": "int64" }, "partialResultMode": { "description": "Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error.", "type": "string", "enum": [ "PARTIAL_RESULT_MODE_UNSPECIFIED", "FAIL_PARTIAL_RESULT", "ALLOW_PARTIAL_RESULT" ], "enumDescriptions": [ "Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.", "Throw an error if the result exceeds 10 MB or if only a partial result can be retrieved. Don't return the result.", "Return a truncated result and set `partial_result` to true if the result exceeds 10 MB or if only a partial result can be retrieved due to error. Don't throw an error." ] } } }, "GenerateEphemeralCertRequest": { "description": "Ephemeral certificate creation request.", "type": "object", "id": "GenerateEphemeralCertRequest", "properties": { "public_key": { "description": "PEM encoded public key to include in the signed certificate.", "type": "string" }, "readTime": { "description": "Optional. Optional snapshot read timestamp to trade freshness for performance.", "type": "string", "format": "google-datetime" }, "validDuration": { "description": "Optional. If set, it will contain the cert valid duration.", "type": "string", "format": "google-duration" }, "access_token": { "description": "Optional. Access token to include in the signed certificate.", "type": "string" } } }, "RestoreBackupContext": { "id": "RestoreBackupContext", "properties": { "kind": { "description": "This is always `sql#restoreBackupContext`.", "type": "string" }, "project": { "description": "The full project ID of the source instance.", "type": "string" }, "backupRunId": { "format": "int64", "description": "The ID of the backup run to restore from.", "type": "string" }, "instanceId": { "description": "The ID of the instance that the backup was taken from.", "type": "string" } }, "description": "Database instance restore from backup context. Backup context contains source instance id and project id.", "type": "object" }, "MaintenanceWindow": { "description": "Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.", "type": "object", "id": "MaintenanceWindow", "properties": { "updateTrack": { "enumDescriptions": [ "This is an unknown maintenance timing preference.", "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).", "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).", "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." ], "description": "Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance).", "type": "string", "enum": [ "SQL_UPDATE_TRACK_UNSPECIFIED", "canary", "stable", "week5" ] }, "hour": { "format": "int32", "description": "Hour of day - 0 to 23. Specify in the UTC time zone.", "type": "integer" }, "kind": { "description": "This is always `sql#maintenanceWindow`.", "type": "string" }, "day": { "description": "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.", "type": "integer", "format": "int32" } } }, "IpMapping": { "description": "Database instance IP mapping", "type": "object", "id": "IpMapping", "properties": { "type": { "enumDescriptions": [ "This is an unknown IP address type.", "IP address the customer is supposed to connect to. Usually this is the load balancer's IP address", "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 IP used when using private IPs and network peering.", "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." ], "description": "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.", "type": "string", "enum": [ "SQL_IP_ADDRESS_TYPE_UNSPECIFIED", "PRIMARY", "OUTGOING", "PRIVATE", "MIGRATED_1ST_GEN" ] }, "ipAddress": { "description": "The IP address assigned.", "type": "string" }, "timeToRetire": { "format": "google-datetime", "description": "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.", "type": "string" } } }, "Status": { "id": "Status", "properties": { "details": { "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object" }, "DatabasesListResponse": { "id": "DatabasesListResponse", "properties": { "kind": { "description": "This is always `sql#databasesList`.", "type": "string" }, "items": { "items": { "$ref": "Database" }, "description": "List of database resources in the instance.", "type": "array" } }, "description": "Database list response.", "type": "object" }, "OperationMetadata": { "id": "OperationMetadata", "properties": { "target": { "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "cancelRequested": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true }, "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string" }, "statusDetail": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true }, "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" } }, "description": "Represents the metadata of the long-running operation.", "type": "object" }, "InstancesRotateEntraIdCertificateRequest": { "id": "InstancesRotateEntraIdCertificateRequest", "properties": { "rotateEntraIdCertificateContext": { "description": "Optional. Contains details about the rotate server certificate operation.", "$ref": "RotateEntraIdCertificateContext" } }, "description": "Rotate Entra ID certificate request.", "type": "object" }, "RotateServerCaContext": { "id": "RotateServerCaContext", "properties": { "nextVersion": { "description": "The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version.", "type": "string" }, "kind": { "description": "This is always `sql#rotateServerCaContext`.", "type": "string" } }, "description": "Instance rotate server CA context.", "type": "object" }, "InstancesCloneRequest": { "id": "InstancesCloneRequest", "properties": { "cloneContext": { "description": "Required. Contains details about the clone operation.", "$ref": "CloneContext" } }, "description": "Database instance clone request.", "type": "object" }, "InstancesListEntraIdCertificatesResponse": { "description": "Instances ListEntraIdCertificates response.", "type": "object", "id": "InstancesListEntraIdCertificatesResponse", "properties": { "certs": { "items": { "$ref": "SslCert" }, "description": "List of Entra ID certificates for the instance.", "type": "array" }, "activeVersion": { "description": "The `sha1_fingerprint` of the active certificate from `certs`.", "type": "string" }, "kind": { "description": "This is always `sql#instancesListEntraIdCertificates`.", "type": "string" } } }, "ReplicaConfiguration": { "description": "Read-replica configuration for connecting to the primary instance.", "type": "object", "id": "ReplicaConfiguration", "properties": { "kind": { "description": "This is always `sql#replicaConfiguration`.", "type": "string" }, "mysqlReplicaConfiguration": { "description": "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.", "$ref": "MySqlReplicaConfiguration" }, "failoverTarget": { "description": "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.", "type": "boolean" }, "cascadableReplica": { "description": "Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.", "type": "boolean" } } }, "Settings": { "id": "Settings", "properties": { "pricingPlan": { "enumDescriptions": [ "This is an unknown pricing plan for this instance.", "The instance is billed at a monthly flat rate.", "The instance is billed per usage." ], "description": "The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.", "type": "string", "enum": [ "SQL_PRICING_PLAN_UNSPECIFIED", "PACKAGE", "PER_USE" ] }, "databaseReplicationEnabled": { "description": "Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.", "type": "boolean" }, "replicationType": { "description": "The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.", "enum": [ "SQL_REPLICATION_TYPE_UNSPECIFIED", "SYNCHRONOUS", "ASYNCHRONOUS" ], "deprecated": true, "enumDescriptions": [ "This is an unknown replication type for a Cloud SQL instance.", "The synchronous replication mode for First Generation instances. It is the default value.", "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." ], "type": "string" }, "availabilityType": { "enumDescriptions": [ "This is an unknown Availability type.", "Zonal available instance.", "Regional available instance." ], "description": "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](https://cloud.google.com/sql/docs/mysql/high-availability).", "type": "string", "enum": [ "SQL_AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL" ] }, "crashSafeReplicationEnabled": { "description": "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.", "type": "boolean", "deprecated": true }, "insightsConfig": { "description": "Insights configuration, for now relevant only for Postgres.", "$ref": "InsightsConfig" }, "edition": { "description": "Optional. The edition of the instance.", "type": "string", "enum": [ "EDITION_UNSPECIFIED", "ENTERPRISE", "ENTERPRISE_PLUS" ], "enumDescriptions": [ "The instance did not specify the edition.", "The instance is an enterprise edition.", "The instance is an Enterprise Plus edition." ] }, "userLabels": { "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", "type": "object", "additionalProperties": { "type": "string" } }, "backupConfiguration": { "description": "The daily backup configuration for the instance.", "$ref": "BackupConfiguration" }, "collation": { "description": "The name of server Instance collation.", "type": "string" }, "connectionPoolConfig": { "description": "Optional. The managed connection pooling configuration for the instance.", "$ref": "ConnectionPoolConfig" }, "autoUpgradeEnabled": { "description": "Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.", "type": "boolean" }, "tier": { "description": "The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance.", "type": "string" }, "activationPolicy": { "description": "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.", "enumDeprecated": [ false, false, false, true ], "enum": [ "SQL_ACTIVATION_POLICY_UNSPECIFIED", "ALWAYS", "NEVER", "ON_DEMAND" ], "type": "string", "enumDescriptions": [ "Unknown activation plan.", "The instance is always up and running.", "The instance never starts.", "The instance starts upon receiving requests." ] }, "retainBackupsOnDelete": { "description": "Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.", "type": "boolean" }, "entraidConfig": { "description": "Optional. The Microsoft Entra ID configuration for the SQL Server instance.", "$ref": "SqlServerEntraIdConfig" }, "performanceCaptureConfig": { "description": "Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations.", "$ref": "PerformanceCaptureConfig" }, "dataDiskProvisionedIops": { "format": "int64", "description": "Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.", "type": "string" }, "kind": { "description": "This is always `sql#settings`.", "type": "string" }, "dataDiskProvisionedThroughput": { "description": "Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.", "type": "string", "format": "int64" }, "denyMaintenancePeriods": { "items": { "$ref": "DenyMaintenancePeriod" }, "description": "Deny maintenance periods", "type": "array" }, "storageAutoResize": { "description": "Configuration to increase storage size automatically. The default value is true.", "type": "boolean" }, "settingsVersion": { "description": "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.", "type": "string", "format": "int64" }, "locationPreference": { "description": "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.", "$ref": "LocationPreference" }, "databaseFlags": { "description": "The database flags passed to the instance at startup.", "type": "array", "items": { "$ref": "DatabaseFlags" } }, "maintenanceWindow": { "description": "The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.", "$ref": "MaintenanceWindow" }, "dataDiskSizeGb": { "format": "int64", "description": "The size of data disk, in GB. The data disk size minimum is 10GB.", "type": "string" }, "ipConfiguration": { "description": "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.", "$ref": "IpConfiguration" }, "dataCacheConfig": { "description": "Configuration for data cache.", "$ref": "DataCacheConfig" }, "enableDataplexIntegration": { "description": "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.", "type": "boolean" }, "advancedMachineFeatures": { "description": "Specifies advanced machine configuration for the instances relevant only for SQL Server.", "$ref": "AdvancedMachineFeatures" }, "timeZone": { "description": "Server timezone, relevant only for Cloud SQL for SQL Server.", "type": "string" }, "finalBackupConfig": { "description": "Optional. The final backup configuration for the instance.", "$ref": "FinalBackupConfig" }, "deletionProtectionEnabled": { "description": "Configuration to protect against accidental instance deletion.", "type": "boolean" }, "dataApiAccess": { "description": "This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.", "type": "string", "enum": [ "DATA_API_ACCESS_UNSPECIFIED", "DISALLOW_DATA_API", "ALLOW_DATA_API" ], "enumDescriptions": [ "Unspecified, effectively the same as `DISALLOW_DATA_API`.", "Disallow using ExecuteSql API to connect to the instance.", "Allow using ExecuteSql API to connect to the instance. For private IP instances, this allows authorized users to access the instance from the public internet using ExecuteSql API." ] }, "activeDirectoryConfig": { "description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.", "$ref": "SqlActiveDirectoryConfig" }, "acceleratedReplicaMode": { "description": "Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.", "type": "boolean" }, "replicationLagMaxSeconds": { "format": "int32", "description": "Optional. Configuration value for recreation of replica after certain replication lag", "type": "integer" }, "readPoolAutoScaleConfig": { "description": "Optional. The read pool auto-scale configuration for the instance.", "$ref": "ReadPoolAutoScaleConfig" }, "storageAutoResizeLimit": { "format": "int64", "description": "The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.", "type": "string" }, "enableGoogleMlIntegration": { "description": "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 MySQL and Cloud SQL for PostgreSQL instances.", "type": "boolean" }, "authorizedGaeApplications": { "deprecated": true, "items": { "type": "string" }, "description": "The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.", "type": "array" }, "dataDiskType": { "description": "The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances.", "enumDeprecated": [ false, false, false, true, false ], "enum": [ "SQL_DATA_DISK_TYPE_UNSPECIFIED", "PD_SSD", "PD_HDD", "OBSOLETE_LOCAL_SSD", "HYPERDISK_BALANCED" ], "enumDescriptions": [ "This is an unknown data disk type.", "An SSD data disk.", "An HDD data disk.", "This field is deprecated and will be removed from a future version of the API.", "A Hyperdisk Balanced data disk." ], "type": "string" }, "sqlServerAuditConfig": { "description": "SQL Server specific audit configuration.", "$ref": "SqlServerAuditConfig" }, "passwordValidationPolicy": { "description": "The local user password validation policy of the instance.", "$ref": "PasswordValidationPolicy" }, "connectorEnforcement": { "description": "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.", "type": "string", "enum": [ "CONNECTOR_ENFORCEMENT_UNSPECIFIED", "NOT_REQUIRED", "REQUIRED" ], "enumDescriptions": [ "The requirement for Cloud SQL connectors is unknown.", "Do not require Cloud SQL connectors.", "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." ] } }, "description": "Database instance settings.", "type": "object" }, "FinalBackupConfig": { "id": "FinalBackupConfig", "properties": { "enabled": { "description": "Whether the final backup is enabled for the instance.", "type": "boolean" }, "retentionDays": { "description": "The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days).", "type": "integer", "format": "int32" } }, "description": "Config used to determine the final backup settings for the instance.", "type": "object" }, "SqlScheduledMaintenance": { "id": "SqlScheduledMaintenance", "properties": { "canDefer": { "type": "boolean", "deprecated": true }, "startTime": { "description": "The start time of any upcoming scheduled maintenance for this instance.", "type": "string", "format": "google-datetime" }, "canReschedule": { "description": "If the scheduled maintenance can be rescheduled.", "type": "boolean" }, "scheduleDeadlineTime": { "format": "google-datetime", "description": "Maintenance cannot be rescheduled to start beyond this deadline.", "type": "string" } }, "description": "Any scheduled maintenance for this instance.", "type": "object" }, "PoolNodeConfig": { "description": "Details of a single read pool node of a read pool.", "type": "object", "id": "PoolNodeConfig", "properties": { "ipAddresses": { "items": { "$ref": "IpMapping" }, "description": "Output only. Mappings containing IP addresses that can be used to connect to the read pool node.", "type": "array", "readOnly": true }, "dnsNames": { "items": { "$ref": "DnsNameMapping" }, "description": "Output only. The list of DNS names used by this read pool node.", "type": "array", "readOnly": true }, "pscServiceAttachmentLink": { "readOnly": true, "description": "Output only. The Private Service Connect (PSC) service attachment of the read pool node.", "type": "string" }, "pscAutoConnections": { "description": "Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node.", "type": "array", "items": { "$ref": "PscAutoConnectionConfig" }, "readOnly": true }, "dnsName": { "readOnly": true, "description": "Output only. The DNS name of the read pool node.", "type": "string" }, "state": { "description": "Output only. The current state of the read pool node.", "enumDeprecated": [ false, false, false, false, false, false, false, true, false ], "enum": [ "SQL_INSTANCE_STATE_UNSPECIFIED", "RUNNABLE", "SUSPENDED", "PENDING_DELETE", "PENDING_CREATE", "MAINTENANCE", "FAILED", "ONLINE_MAINTENANCE", "REPAIRING" ], "type": "string", "readOnly": true, "enumDescriptions": [ "The state of the instance is unknown.", "The instance is running, or has been stopped by owner.", "The instance is not available, for example due to problems with billing.", "The instance is being deleted.", "The instance is being created.", "The instance is down for maintenance.", "The creation of the instance failed or a fatal error occurred during maintenance.", "Deprecated", "(Applicable to read pool nodes only.) The read pool node needs to be repaired. The database might be unavailable." ] }, "name": { "readOnly": true, "description": "Output only. The name of the read pool node, to be used for retrieving metrics and logs.", "type": "string" }, "gceZone": { "description": "Output only. The zone of the read pool node.", "type": "string", "readOnly": true } } }, "SqlServerAuditConfig": { "description": "SQL Server specific audit configuration.", "type": "object", "id": "SqlServerAuditConfig", "properties": { "bucket": { "description": "The name of the destination bucket (e.g., gs://mybucket).", "type": "string" }, "kind": { "description": "This is always sql#sqlServerAuditConfig", "type": "string" }, "uploadInterval": { "description": "How often to upload generated audit files.", "type": "string", "format": "google-duration" }, "retentionInterval": { "format": "google-duration", "description": "How long to keep generated audit files.", "type": "string" } } }, "InstancesListResponse": { "description": "Database instances list response.", "type": "object", "id": "InstancesListResponse", "properties": { "warnings": { "items": { "$ref": "ApiWarning" }, "description": "List of warnings that occurred while handling the request.", "type": "array" }, "nextPageToken": { "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.", "type": "string" }, "items": { "description": "List of database instance resources.", "type": "array", "items": { "$ref": "DatabaseInstance" } }, "kind": { "description": "This is always `sql#instancesList`.", "type": "string" } } }, "PreCheckMajorVersionUpgradeContext": { "id": "PreCheckMajorVersionUpgradeContext", "properties": { "kind": { "description": "Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.", "type": "string" }, "targetDatabaseVersion": { "enumDescriptions": [ "This is an unknown database version.", "The database version is MySQL 5.1.", "The database version is MySQL 5.5.", "The database version is MySQL 5.6.", "The database version is MySQL 5.7.", "The database version is MySQL 8.", "The database major version is MySQL 8.0 and the minor version is 18.", "The database major version is MySQL 8.0 and the minor version is 26.", "The database major version is MySQL 8.0 and the minor version is 27.", "The database major version is MySQL 8.0 and the minor version is 28.", "The database major version is MySQL 8.0 and the minor version is 29.", "The database major version is MySQL 8.0 and the minor version is 30.", "The database major version is MySQL 8.0 and the minor version is 31.", "The database major version is MySQL 8.0 and the minor version is 32.", "The database major version is MySQL 8.0 and the minor version is 33.", "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", "The database major version is MySQL 8.0 and the minor version is 37.", "The database major version is MySQL 8.0 and the minor version is 39.", "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", "The database major version is MySQL 8.0 and the minor version is 43.", "The database major version is MySQL 8.0 and the minor version is 44.", "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", "The database version is SQL Server 2017 Web.", "The database version is PostgreSQL 9.6.", "The database version is PostgreSQL 10.", "The database version is PostgreSQL 11.", "The database version is PostgreSQL 12.", "The database version is PostgreSQL 13.", "The database version is PostgreSQL 14.", "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", "The database version is PostgreSQL 18.", "The database version is PostgreSQL 19.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", "The database version is SQL Server 2019 Web.", "The database version is SQL Server 2022 Standard.", "The database version is SQL Server 2022 Enterprise.", "The database version is SQL Server 2022 Express.", "The database version is SQL Server 2022 Web.", "The database version is SQL Server 2025 Standard.", "The database version is SQL Server 2025 Enterprise.", "The database version is SQL Server 2025 Express." ], "type": "string", "description": "Required. The target database version to upgrade to.", "enumDeprecated": [ false, true, true, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "MYSQL_8_0_18", "MYSQL_8_0_26", "MYSQL_8_0_27", "MYSQL_8_0_28", "MYSQL_8_0_29", "MYSQL_8_0_30", "MYSQL_8_0_31", "MYSQL_8_0_32", "MYSQL_8_0_33", "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", "MYSQL_8_0_37", "MYSQL_8_0_39", "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", "MYSQL_8_0_43", "MYSQL_8_0_44", "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", "MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", "SQLSERVER_2017_WEB", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14", "POSTGRES_15", "POSTGRES_16", "POSTGRES_17", "POSTGRES_18", "POSTGRES_19", "SQLSERVER_2019_STANDARD", "SQLSERVER_2019_ENTERPRISE", "SQLSERVER_2019_EXPRESS", "SQLSERVER_2019_WEB", "SQLSERVER_2022_STANDARD", "SQLSERVER_2022_ENTERPRISE", "SQLSERVER_2022_EXPRESS", "SQLSERVER_2022_WEB", "SQLSERVER_2025_STANDARD", "SQLSERVER_2025_ENTERPRISE", "SQLSERVER_2025_EXPRESS" ] }, "preCheckResponse": { "readOnly": true, "items": { "$ref": "PreCheckResponse" }, "description": "Output only. The responses from the precheck operation.", "type": "array" } }, "description": "Pre-check major version upgrade context.", "type": "object" }, "PscAutoConnectionConfig": { "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.", "type": "object", "id": "PscAutoConnectionConfig", "properties": { "consumerNetwork": { "description": "Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.", "type": "string" }, "ipAddress": { "description": "The IP address of the consumer endpoint.", "type": "string" }, "consumerNetworkStatus": { "description": "The connection policy status of the consumer network.", "type": "string" }, "consumerProject": { "description": "Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network.", "type": "string" }, "status": { "description": "The connection status of the consumer endpoint.", "type": "string" } } }, "SqlInstancesAcquireSsrsLeaseResponse": { "description": "Response for the acquire SSRS lease request.", "type": "object", "id": "SqlInstancesAcquireSsrsLeaseResponse", "properties": { "operationId": { "description": "The unique identifier for this operation.", "type": "string" } } }, "SqlExternalSyncSettingError": { "id": "SqlExternalSyncSettingError", "properties": { "kind": { "description": "Can be `sql#externalSyncSettingError` or `sql#externalSyncSettingWarning`.", "type": "string" }, "type": { "description": "Identifies the specific error that occurred.", "type": "string", "enum": [ "SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED", "CONNECTION_FAILURE", "BINLOG_NOT_ENABLED", "INCOMPATIBLE_DATABASE_VERSION", "REPLICA_ALREADY_SETUP", "INSUFFICIENT_PRIVILEGE", "UNSUPPORTED_MIGRATION_TYPE", "NO_PGLOGICAL_INSTALLED", "PGLOGICAL_NODE_ALREADY_EXISTS", "INVALID_WAL_LEVEL", "INVALID_SHARED_PRELOAD_LIBRARY", "INSUFFICIENT_MAX_REPLICATION_SLOTS", "INSUFFICIENT_MAX_WAL_SENDERS", "INSUFFICIENT_MAX_WORKER_PROCESSES", "UNSUPPORTED_EXTENSIONS", "INVALID_RDS_LOGICAL_REPLICATION", "INVALID_LOGGING_SETUP", "INVALID_DB_PARAM", "UNSUPPORTED_GTID_MODE", "SQLSERVER_AGENT_NOT_RUNNING", "UNSUPPORTED_TABLE_DEFINITION", "UNSUPPORTED_DEFINER", "SQLSERVER_SERVERNAME_MISMATCH", "PRIMARY_ALREADY_SETUP", "UNSUPPORTED_BINLOG_FORMAT", "BINLOG_RETENTION_SETTING", "UNSUPPORTED_STORAGE_ENGINE", "LIMITED_SUPPORT_TABLES", "EXISTING_DATA_IN_REPLICA", "MISSING_OPTIONAL_PRIVILEGES", "RISKY_BACKUP_ADMIN_PRIVILEGE", "INSUFFICIENT_GCS_PERMISSIONS", "INVALID_FILE_INFO", "UNSUPPORTED_DATABASE_SETTINGS", "MYSQL_PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE", "LOCAL_INFILE_OFF", "TURN_ON_PITR_AFTER_PROMOTE", "INCOMPATIBLE_DATABASE_MINOR_VERSION", "SOURCE_MAX_SUBSCRIPTIONS", "UNABLE_TO_VERIFY_DEFINERS", "SUBSCRIPTION_CALCULATION_STATUS", "PG_SUBSCRIPTION_COUNT", "PG_SYNC_PARALLEL_LEVEL", "INSUFFICIENT_DISK_SIZE", "INSUFFICIENT_MACHINE_TIER", "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", "EXTENSIONS_NOT_ENABLED_IN_REPLICA", "UNSUPPORTED_COLUMNS", "USERS_NOT_CREATED_IN_REPLICA", "UNSUPPORTED_SYSTEM_OBJECTS", "UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY", "SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE", "PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI", "SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS", "PROMPT_DELETE_EXISTING", "WILL_DELETE_EXISTING", "PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE" ], "enumDescriptions": [ "", "", "", "", "", "The replication user is missing privileges that are required.", "Unsupported migration type.", "No pglogical extension installed on databases, applicable for postgres.", "pglogical node already exists on databases, applicable for postgres.", "The value of parameter wal_level is not set to logical.", "The value of parameter shared_preload_libraries does not include pglogical.", "The value of parameter max_replication_slots is not sufficient.", "The value of parameter max_wal_senders is not sufficient.", "The value of parameter max_worker_processes is not sufficient.", "Extensions installed are either not supported or having unsupported versions.", "The value of parameter rds.logical_replication is not set to 1.", "The primary instance logging setup doesn't allow EM sync.", "The primary instance database parameter setup doesn't allow EM sync.", "The gtid_mode is not supported, applicable for MySQL.", "SQL Server Agent is not running.", "The table definition is not support due to missing primary key or replica identity, applicable for postgres. Note that this is a warning and won't block the migration.", "The customer has a definer that will break EM setup.", "SQL Server @@SERVERNAME does not match actual host name.", "The primary instance has been setup and will fail the setup.", "The primary instance has unsupported binary log format.", "The primary instance's binary log retention setting.", "The primary instance has tables with unsupported storage engine.", "Source has tables with limited support eg: PostgreSQL tables without primary keys.", "The replica instance contains existing data.", "The replication user is missing privileges that are optional.", "Additional BACKUP_ADMIN privilege is granted to the replication user which may lock source MySQL 8 instance for DDLs during initial sync.", "The Cloud Storage bucket is missing necessary permissions.", "The Cloud Storage bucket has an error in the file or contains invalid file information.", "The source instance has unsupported database settings for migration.", "The replication user is missing parallel import specific privileges. (e.g. LOCK TABLES) for MySQL.", "The global variable local_infile is off on external server replica.", "This code instructs customers to turn on point-in-time recovery manually for the instance after promoting the Cloud SQL for PostgreSQL instance.", "The minor version of replica database is incompatible with the source.", "This warning message indicates that Cloud SQL uses the maximum number of subscriptions to migrate data from the source to the destination.", "Unable to verify definers on the source for MySQL.", "If a time out occurs while the subscription counts are calculated, then this value is set to 1. Otherwise, this value is set to 2.", "Count of subscriptions needed to sync source data for PostgreSQL database.", "Final parallel level that is used to do migration.", "The disk size of the replica instance is smaller than the data size of the source instance.", "The data size of the source instance is greater than 1 TB, the number of cores of the replica instance is less than 8, and the memory of the replica is less than 32 GB.", "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", "This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", "The source database has generated columns that can't be migrated. Please change them to regular columns before migration.", "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.", "The selected objects include system objects that aren't supported for migration.", "The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration.", "The selected objects don't exist on the source instance.", "PSC only destination instance does not have a network attachment URI.", "Selected objects reference unselected objects. Based on their object type (foreign key constraint or view), selected objects will fail during migration.", "The migration will delete existing data in the replica; set replica_overwrite_enabled in the request to acknowledge this. This is an error. MySQL only.", "The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only.", "The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL." ] }, "detail": { "description": "Additional information about the error encountered.", "type": "string" } }, "description": "External primary instance migration setting error/warning.", "type": "object" }, "DemoteMasterConfiguration": { "id": "DemoteMasterConfiguration", "properties": { "kind": { "description": "This is always `sql#demoteMasterConfiguration`.", "type": "string" }, "mysqlReplicaConfiguration": { "description": "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.", "$ref": "DemoteMasterMySqlReplicaConfiguration" } }, "description": "Read-replica configuration for connecting to the on-premises primary instance.", "type": "object" }, "IpConfiguration": { "id": "IpConfiguration", "properties": { "authorizedNetworks": { "description": "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`).", "type": "array", "items": { "$ref": "AclEntry" } }, "sslMode": { "enumDescriptions": [ "The SSL mode is unknown.", "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 `require_ssl` flag must be false or cleared to avoid a conflict between the values of the two flags.", "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 `require_ssl` flag must be false or cleared to avoid a conflict between the values of the two flags.", "Only allow connections encrypted with SSL/TLS and with valid client certificates. When this value is used, the legacy `require_ssl` 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](https://cloud.google.com/sql/docs/postgres/connect-auth-proxy) or [Cloud SQL Connectors](https://cloud.google.com/sql/docs/postgres/connect-connectors) to enforce client identity verification. Only applicable to MySQL and PostgreSQL. Not applicable to SQL Server." ], "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "type": "string", "enum": [ "SSL_MODE_UNSPECIFIED", "ALLOW_UNENCRYPTED_AND_ENCRYPTED", "ENCRYPTED_ONLY", "TRUSTED_CLIENT_CERTIFICATE_REQUIRED" ] }, "customSubjectAlternativeNames": { "description": "Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.", "type": "array", "items": { "type": "string" } }, "serverCaMode": { "enumDescriptions": [ "CA mode is unspecified. It is effectively the same as `GOOGLE_MANAGED_INTERNAL_CA`.", "Google-managed self-signed internal CA.", "Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS).", "Customer-managed CA hosted on Google Cloud's Certificate Authority Service (CAS)." ], "description": "Specify what type of CA is used for the server certificate.", "type": "string", "enum": [ "CA_MODE_UNSPECIFIED", "GOOGLE_MANAGED_INTERNAL_CA", "GOOGLE_MANAGED_CAS_CA", "CUSTOMER_MANAGED_CAS_CA" ] }, "serverCertificateRotationMode": { "enumDescriptions": [ "Unspecified: no automatic server certificate rotation.", "No automatic server certificate rotation. The user must [manage server certificate rotation](/sql/docs/mysql/manage-ssl-instance#rotate-server-certificate-cas) on their side.", "Automatic server certificate rotation during Cloud SQL scheduled maintenance or self-service maintenance updates. Requires `server_ca_mode` to be `GOOGLE_MANAGED_CAS_CA` or `CUSTOMER_MANAGED_CAS_CA`." ], "description": "Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.", "type": "string", "enum": [ "SERVER_CERTIFICATE_ROTATION_MODE_UNSPECIFIED", "NO_AUTOMATIC_ROTATION", "AUTOMATIC_ROTATION_DURING_MAINTENANCE" ] }, "requireSsl": { "description": "Use `ssl_mode` 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 `ssl_mode` flag instead of the `require_ssl` flag.", "type": "boolean" }, "allocatedIpRange": { "description": "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](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.`", "type": "string" }, "pscConfig": { "description": "PSC settings for this instance.", "$ref": "PscConfig" }, "enablePrivatePathForGoogleCloudServices": { "description": "Controls connectivity to private IP instances from Google services, such as BigQuery.", "type": "boolean" }, "ipv4Enabled": { "description": "Whether the instance is assigned a public IP address or not.", "type": "boolean" }, "privateNetwork": { "description": "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.", "type": "string" }, "serverCaPool": { "description": "Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}", "type": "string" } }, "description": "IP Management configuration.", "type": "object" }, "OnPremisesConfiguration": { "id": "OnPremisesConfiguration", "properties": { "sourceInstance": { "description": "The reference to Cloud SQL instance if the source is Cloud SQL.", "$ref": "InstanceReference" }, "clientCertificate": { "description": "PEM representation of the replica's x509 certificate.", "type": "string" }, "kind": { "description": "This is always `sql#onPremisesConfiguration`.", "type": "string" }, "password": { "description": "The password for connecting to on-premises instance.", "type": "string" }, "caCertificate": { "description": "PEM representation of the trusted CA's x509 certificate.", "type": "string" }, "hostPort": { "description": "The host and port of the on-premises instance in host:port format", "type": "string" }, "sslOption": { "description": "Optional. SSL option for replica connection to the on-premises source.", "type": "string", "enum": [ "SSL_OPTION_UNSPECIFIED", "DISABLE", "REQUIRE", "VERIFY_CA" ], "enumDescriptions": [ "Unknown SSL option i.e. SSL option not specified by user.", "SSL is not used for replica connection to the on-premises source.", "SSL is required for replica connection to the on-premises source.", "Verify CA is required for replica connection to the on-premises source." ] }, "dumpFilePath": { "description": "The dump file to create the Cloud SQL replica.", "type": "string" }, "selectedObjects": { "description": "Optional. A list of objects that the user selects for replication from an external source instance.", "type": "array", "items": { "$ref": "SelectedObjects" } }, "username": { "description": "The username for connecting to on-premises instance.", "type": "string" }, "clientKey": { "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" } }, "description": "On-premises instance configuration.", "type": "object" }, "DenyMaintenancePeriod": { "id": "DenyMaintenancePeriod", "properties": { "startDate": { "description": "\"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", "type": "string" }, "endDate": { "description": "\"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", "type": "string" }, "time": { "description": "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", "type": "string" } }, "description": "Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.", "type": "object" }, "Value": { "description": "The cell value of the table.", "type": "object", "id": "Value", "properties": { "value": { "description": "The cell value in string format.", "type": "string" }, "nullValue": { "description": "If cell value is null, then this flag will be set to true.", "type": "boolean" } } }, "PerformanceCaptureConfig": { "description": "Performance capture configuration.", "type": "object", "id": "PerformanceCaptureConfig", "properties": { "transactionDurationThreshold": { "description": "Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.", "type": "integer", "format": "int32" }, "probeThreshold": { "format": "int32", "description": "Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.", "type": "integer" }, "enabled": { "description": "Optional. Enables or disables the performance capture feature.", "type": "boolean" }, "probingIntervalSeconds": { "description": "Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached.", "type": "integer", "format": "int32" }, "secondsBehindSourceThreshold": { "description": "Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica.", "type": "integer", "format": "int32" }, "runningThreadsThreshold": { "description": "Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance.", "type": "integer", "format": "int32" } } }, "PreCheckResponse": { "id": "PreCheckResponse", "properties": { "messageType": { "description": "The type of message whether it is an info, warning, or error.", "type": "string", "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "enumDescriptions": [ "Default unspecified value to prevent unintended behavior changes.", "General informational messages that don't require action.", "Warnings that might impact the upgrade but don't block it.", "Errors that a user must resolve before proceeding with the upgrade." ] }, "message": { "description": "The message to be displayed to the user.", "type": "string" }, "actionsRequired": { "items": { "type": "string" }, "description": "The actions that the user needs to take. Use repeated for multiple actions.", "type": "array" } }, "description": "Structured PreCheckResponse containing message, type, and required actions.", "type": "object" }, "BinLogCoordinates": { "id": "BinLogCoordinates", "properties": { "binLogPosition": { "description": "Position (offset) within the binary log file.", "type": "string", "format": "int64" }, "kind": { "description": "This is always `sql#binLogCoordinates`.", "type": "string" }, "binLogFileName": { "description": "Name of the binary log file for a Cloud SQL instance.", "type": "string" } }, "description": "Binary log coordinates.", "type": "object" }, "OperationErrors": { "id": "OperationErrors", "properties": { "kind": { "description": "This is always `sql#operationErrors`.", "type": "string" }, "errors": { "items": { "$ref": "OperationError" }, "description": "The list of errors encountered while processing this operation.", "type": "array" } }, "description": "Database instance operation errors list wrapper.", "type": "object" }, "SslCert": { "id": "SslCert", "properties": { "kind": { "description": "This is always `sql#sslCert`.", "type": "string" }, "cert": { "description": "PEM representation.", "type": "string" }, "createTime": { "description": "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`", "type": "string", "format": "google-datetime" }, "commonName": { "description": "User supplied name. Constrained to [a-zA-Z.-_ ]+.", "type": "string" }, "selfLink": { "description": "The URI of this resource.", "type": "string" }, "certSerialNumber": { "description": "Serial number, as extracted from the certificate.", "type": "string" }, "instance": { "description": "Name of the database instance.", "type": "string" }, "expirationTime": { "format": "google-datetime", "description": "The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.", "type": "string" }, "sha1Fingerprint": { "description": "Sha1 Fingerprint.", "type": "string" } }, "description": "SslCerts Resource", "type": "object" }, "AvailableDatabaseVersion": { "description": "An available database version. It can be a major or a minor version.", "type": "object", "id": "AvailableDatabaseVersion", "properties": { "name": { "description": "The database version name. For MySQL 8.0, this string provides the database major and minor version.", "type": "string" }, "displayName": { "description": "The database version's display name.", "type": "string" }, "majorVersion": { "description": "The version's major version name.", "type": "string" } } }, "PasswordStatus": { "id": "PasswordStatus", "properties": { "locked": { "description": "If true, user does not have login privileges.", "type": "boolean" }, "passwordExpirationTime": { "format": "google-datetime", "description": "The expiration time of the current password.", "type": "string" } }, "description": "Read-only password status.", "type": "object" }, "SqlInstancesGetLatestRecoveryTimeResponse": { "id": "SqlInstancesGetLatestRecoveryTimeResponse", "properties": { "earliestRecoveryTime": { "description": "Timestamp, identifies the earliest recovery time of the source instance.", "type": "string", "format": "google-datetime" }, "latestRecoveryTime": { "description": "Timestamp, identifies the latest recovery time of the source instance.", "type": "string", "format": "google-datetime" }, "kind": { "description": "This is always `sql#getLatestRecoveryTime`.", "type": "string" } }, "description": "Instance get latest recovery time response.", "type": "object" }, "InstancesReencryptRequest": { "description": "Database Instance reencrypt request.", "type": "object", "id": "InstancesReencryptRequest", "properties": { "backupReencryptionConfig": { "description": "Configuration specific to backup re-encryption", "$ref": "BackupReencryptionConfig" } } } }, "discoveryVersion": "v1", "mtlsRootUrl": "https://sqladmin.mtls.googleapis.com/", "fullyEncodeReservedExpansion": true, "resources": { "instances": { "methods": { "reencrypt": { "flatPath": "v1/projects/{project}/instances/{instance}/reencrypt", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.instances.reencrypt", "parameters": { "project": { "description": "ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "request": { "$ref": "InstancesReencryptRequest" }, "httpMethod": "POST", "description": "Reencrypt CMEK instance with latest key version.", "path": "v1/projects/{project}/instances/{instance}/reencrypt", "response": { "$ref": "Operation" } }, "import": { "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "id": "sql.instances.import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{project}/instances/{instance}/import", "description": "Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.", "path": "v1/projects/{project}/instances/{instance}/import", "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "InstancesImportRequest" } }, "listServerCas": { "httpMethod": "GET", "path": "v1/projects/{project}/instances/{instance}/listServerCas", "response": { "$ref": "InstancesListServerCasResponse" }, "description": "Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.", "flatPath": "v1/projects/{project}/instances/{instance}/listServerCas", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.listServerCas", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "parameterOrder": [ "project", "instance" ] }, "releaseSsrsLease": { "httpMethod": "POST", "description": "Release a lease for the setup of SQL Server Reporting Services (SSRS).", "path": "v1/projects/{project}/instances/{instance}/releaseSsrsLease", "response": { "$ref": "SqlInstancesReleaseSsrsLeaseResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/releaseSsrsLease", "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "Required. The project ID that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Required. The Cloud SQL instance ID. This doesn't include the project ID. The instance ID contains lowercase letters, numbers, and hyphens, and it must start with a letter. This ID can have a maximum length of 98 characters.", "location": "path", "type": "string", "required": true } }, "id": "sql.instances.releaseSsrsLease" }, "ListServerCertificates": { "httpMethod": "GET", "description": "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. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.", "path": "v1/projects/{project}/instances/{instance}/listServerCertificates", "response": { "$ref": "InstancesListServerCertificatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/listServerCertificates", "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Required. Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "id": "sql.instances.ListServerCertificates" }, "pointInTimeRestore": { "flatPath": "v1/projects/{projectsId}:pointInTimeRestore", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.pointInTimeRestore", "parameters": { "parent": { "description": "Required. The parent resource where you created this instance. Format: projects/{project}", "pattern": "^projects/[^/]+$", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "PointInTimeRestoreContext" }, "httpMethod": "POST", "path": "v1/{+parent}:pointInTimeRestore", "response": { "$ref": "Operation" }, "description": "Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery." }, "promoteReplica": { "httpMethod": "POST", "path": "v1/projects/{project}/instances/{instance}/promoteReplica", "response": { "$ref": "Operation" }, "description": "Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/promoteReplica", "parameters": { "project": { "required": true, "description": "ID of the project that contains the read replica.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL read replica instance name.", "location": "path", "type": "string" }, "failover": { "description": "Set to true to invoke a replica failover to the DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance.", "location": "query", "type": "boolean" } }, "id": "sql.instances.promoteReplica", "parameterOrder": [ "project", "instance" ] }, "patch": { "parameterOrder": [ "project", "instance" ], "id": "sql.instances.patch", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "flatPath": "v1/projects/{project}/instances/{instance}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "description": "Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.", "path": "v1/projects/{project}/instances/{instance}", "response": { "$ref": "Operation" }, "request": { "$ref": "DatabaseInstance" }, "httpMethod": "PATCH" }, "insert": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances", "parameters": { "project": { "required": true, "description": "Project ID of the project to which the newly created Cloud SQL instances should belong.", "location": "path", "type": "string" } }, "id": "sql.instances.insert", "parameterOrder": [ "project" ], "httpMethod": "POST", "request": { "$ref": "DatabaseInstance" }, "path": "v1/projects/{project}/instances", "response": { "$ref": "Operation" }, "description": "Creates a new Cloud SQL instance." }, "acquireSsrsLease": { "flatPath": "v1/projects/{project}/instances/{instance}/acquireSsrsLease", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.instances.acquireSsrsLease", "parameters": { "project": { "required": true, "description": "Required. Project ID of the project that contains the instance (Example: project-id).", "location": "path", "type": "string" }, "instance": { "description": "Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).", "location": "path", "type": "string", "required": true } }, "request": { "$ref": "InstancesAcquireSsrsLeaseRequest" }, "httpMethod": "POST", "description": "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "path": "v1/projects/{project}/instances/{instance}/acquireSsrsLease", "response": { "$ref": "SqlInstancesAcquireSsrsLeaseResponse" } }, "switchover": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/switchover", "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "description": "ID of the project that contains the replica.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL read replica instance name.", "location": "path", "type": "string" }, "dbTimeout": { "format": "google-duration", "description": "Optional. (MySQL and PostgreSQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.", "location": "query", "type": "string" } }, "id": "sql.instances.switchover", "httpMethod": "POST", "description": "Switches over from the primary instance to the DR replica instance.", "path": "v1/projects/{project}/instances/{instance}/switchover", "response": { "$ref": "Operation" } }, "ListEntraIdCertificates": { "flatPath": "v1/projects/{project}/instances/{instance}/listEntraIdCertificates", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.instances.ListEntraIdCertificates", "parameters": { "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Required. Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "httpMethod": "GET", "description": "Lists all versions of EntraID certificates for the specified instance. There can be up to three sets of certificates 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.", "path": "v1/projects/{project}/instances/{instance}/listEntraIdCertificates", "response": { "$ref": "InstancesListEntraIdCertificatesResponse" } }, "update": { "httpMethod": "PUT", "request": { "$ref": "DatabaseInstance" }, "description": "Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.", "path": "v1/projects/{project}/instances/{instance}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}", "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.instances.update" }, "stopReplica": { "flatPath": "v1/projects/{project}/instances/{instance}/stopReplica", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.instances.stopReplica", "parameters": { "project": { "description": "ID of the project that contains the read replica.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL read replica instance name.", "location": "path", "type": "string" } }, "httpMethod": "POST", "description": "Stops the replication in the read replica instance.", "path": "v1/projects/{project}/instances/{instance}/stopReplica", "response": { "$ref": "Operation" } }, "clone": { "flatPath": "v1/projects/{project}/instances/{instance}/clone", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.clone", "parameters": { "project": { "required": true, "description": "Required. Project ID of the source Cloud SQL instance.", "location": "path", "type": "string" }, "instance": { "description": "Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "project", "instance" ], "request": { "$ref": "InstancesCloneRequest" }, "httpMethod": "POST", "path": "v1/projects/{project}/instances/{instance}/clone", "response": { "$ref": "Operation" }, "description": "Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart." }, "truncateLog": { "description": "Truncate MySQL general and slow query log tables MySQL only.", "path": "v1/projects/{project}/instances/{instance}/truncateLog", "response": { "$ref": "Operation" }, "request": { "$ref": "InstancesTruncateLogRequest" }, "httpMethod": "POST", "parameterOrder": [ "project", "instance" ], "id": "sql.instances.truncateLog", "parameters": { "project": { "description": "Project ID of the Cloud SQL project.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "flatPath": "v1/projects/{project}/instances/{instance}/truncateLog", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "restoreBackup": { "parameterOrder": [ "project", "instance" ], "id": "sql.instances.restoreBackup", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "flatPath": "v1/projects/{project}/instances/{instance}/restoreBackup", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "description": "Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.", "path": "v1/projects/{project}/instances/{instance}/restoreBackup", "response": { "$ref": "Operation" }, "request": { "$ref": "InstancesRestoreBackupRequest" }, "httpMethod": "POST" }, "executeSql": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/executeSql", "parameters": { "project": { "required": true, "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Required. Database instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.instances.executeSql", "parameterOrder": [ "project", "instance" ], "httpMethod": "POST", "request": { "$ref": "ExecuteSqlPayload" }, "path": "v1/projects/{project}/instances/{instance}/executeSql", "response": { "$ref": "SqlInstancesExecuteSqlResponse" }, "description": "Execute SQL statements." }, "delete": { "parameterOrder": [ "project", "instance" ], "id": "sql.instances.delete", "parameters": { "enableFinalBackup": { "description": "Flag to opt-in for final backup. By default, it is turned off.", "location": "query", "type": "boolean" }, "project": { "description": "Project ID of the project that contains the instance to be deleted.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true }, "finalBackupTtlDays": { "description": "Optional. Retention period of the final backup.", "location": "query", "type": "string", "format": "int64" }, "finalBackupExpiryTime": { "format": "google-datetime", "description": "Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.", "location": "query", "type": "string" }, "finalBackupDescription": { "description": "Optional. The description of the final backup.", "location": "query", "type": "string" } }, "flatPath": "v1/projects/{project}/instances/{instance}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "description": "Deletes a Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}", "response": { "$ref": "Operation" }, "httpMethod": "DELETE" }, "list": { "httpMethod": "GET", "path": "v1/projects/{project}/instances", "response": { "$ref": "InstancesListResponse" }, "description": "Lists instances under a given project.", "flatPath": "v1/projects/{project}/instances", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.list", "parameters": { "maxResults": { "description": "The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "location": "query", "type": "integer", "format": "uint32" }, "pageToken": { "description": "A previously-returned page token representing part of the larger set of results to view.", "location": "query", "type": "string" }, "project": { "description": "Project ID of the project for which to list Cloud SQL instances.", "location": "path", "type": "string", "required": true }, "filter": { "description": "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ] }, "demoteMaster": { "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Cloud SQL instance name.", "location": "path", "type": "string", "required": true } }, "id": "sql.instances.demoteMaster", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/demoteMaster", "description": "Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.", "path": "v1/projects/{project}/instances/{instance}/demoteMaster", "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "InstancesDemoteMasterRequest" } }, "demote": { "parameters": { "project": { "required": true, "description": "Required. ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Required. Cloud SQL instance name.", "location": "path", "type": "string", "required": true } }, "id": "sql.instances.demote", "parameterOrder": [ "project", "instance" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/demote", "path": "v1/projects/{project}/instances/{instance}/demote", "response": { "$ref": "Operation" }, "description": "Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.", "httpMethod": "POST", "request": { "$ref": "InstancesDemoteRequest" } }, "export": { "description": "Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.", "path": "v1/projects/{project}/instances/{instance}/export", "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "InstancesExportRequest" }, "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance to be exported.", "location": "path", "type": "string" }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "id": "sql.instances.export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{project}/instances/{instance}/export" }, "failover": { "httpMethod": "POST", "request": { "$ref": "InstancesFailoverRequest" }, "description": "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](https://cloud.google.com/sql/docs/mysql/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.", "path": "v1/projects/{project}/instances/{instance}/failover", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/failover", "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "description": "ID of the project that contains the read replica.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.instances.failover" }, "addServerCa": { "parameterOrder": [ "project", "instance" ], "id": "sql.instances.addServerCa", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "flatPath": "v1/projects/{project}/instances/{instance}/addServerCa", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.", "path": "v1/projects/{project}/instances/{instance}/addServerCa", "response": { "$ref": "Operation" }, "httpMethod": "POST" }, "preCheckMajorVersionUpgrade": { "httpMethod": "POST", "request": { "$ref": "InstancesPreCheckMajorVersionUpgradeRequest" }, "path": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade", "response": { "$ref": "Operation" }, "description": "Execute MVU Pre-checks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade", "parameters": { "project": { "required": true, "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Required. Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.instances.preCheckMajorVersionUpgrade", "parameterOrder": [ "project", "instance" ] }, "RotateEntraIdCertificate": { "description": "Rotates the server certificate version to one previously added with the addEntraIdCertificate method.", "path": "v1/projects/{project}/instances/{instance}/rotateEntraIdCertificate", "response": { "$ref": "Operation" }, "request": { "$ref": "InstancesRotateEntraIdCertificateRequest" }, "httpMethod": "POST", "parameterOrder": [ "project", "instance" ], "id": "sql.instances.RotateEntraIdCertificate", "parameters": { "project": { "required": true, "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Required. Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "flatPath": "v1/projects/{project}/instances/{instance}/rotateEntraIdCertificate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "startReplica": { "httpMethod": "POST", "path": "v1/projects/{project}/instances/{instance}/startReplica", "response": { "$ref": "Operation" }, "description": "Starts the replication in the read replica instance.", "flatPath": "v1/projects/{project}/instances/{instance}/startReplica", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.startReplica", "parameters": { "project": { "required": true, "description": "ID of the project that contains the read replica.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL read replica instance name.", "location": "path", "type": "string" } }, "parameterOrder": [ "project", "instance" ] }, "rotateServerCa": { "path": "v1/projects/{project}/instances/{instance}/rotateServerCa", "response": { "$ref": "Operation" }, "description": "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, use RotateServerCertificate to rotate the server certificate.", "request": { "$ref": "InstancesRotateServerCaRequest" }, "httpMethod": "POST", "id": "sql.instances.rotateServerCa", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "parameterOrder": [ "project", "instance" ], "flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCa", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "addEntraIdCertificate": { "description": "Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version.", "path": "v1/projects/{project}/instances/{instance}/addEntraIdCertificate", "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameterOrder": [ "project", "instance" ], "id": "sql.instances.addEntraIdCertificate", "parameters": { "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Required. Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "flatPath": "v1/projects/{project}/instances/{instance}/addEntraIdCertificate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "resetSslConfig": { "httpMethod": "POST", "path": "v1/projects/{project}/instances/{instance}/resetSslConfig", "response": { "$ref": "Operation" }, "description": "Deletes all client certificates and generates a new server SSL certificate for the instance.", "flatPath": "v1/projects/{project}/instances/{instance}/resetSslConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.resetSslConfig", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" }, "mode": { "enumDescriptions": [ "Reset SSL mode is not specified.", "Refresh all TLS configs. This is the default behaviour.", "Refreshes the replication-related TLS configuration settings provided by the primary instance. Not applicable to on-premises replication instances." ], "location": "query", "type": "string", "description": "Optional. Reset SSL mode to use.", "enum": [ "RESET_SSL_MODE_UNSPECIFIED", "ALL", "SYNC_FROM_PRIMARY" ] } }, "parameterOrder": [ "project", "instance" ] }, "restart": { "flatPath": "v1/projects/{project}/instances/{instance}/restart", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.instances.restart", "parameters": { "project": { "description": "Project ID of the project that contains the instance to be restarted.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "description": "Restarts a Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/restart", "response": { "$ref": "Operation" } }, "addServerCertificate": { "flatPath": "v1/projects/{project}/instances/{instance}/addServerCertificate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.instances.addServerCertificate", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "httpMethod": "POST", "description": "Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, use AddServerCa instead.", "path": "v1/projects/{project}/instances/{instance}/addServerCertificate", "response": { "$ref": "Operation" } }, "RotateServerCertificate": { "flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCertificate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.RotateServerCertificate", "parameters": { "project": { "required": true, "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Required. Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "project", "instance" ], "request": { "$ref": "InstancesRotateServerCertificateRequest" }, "httpMethod": "POST", "path": "v1/projects/{project}/instances/{instance}/rotateServerCertificate", "response": { "$ref": "Operation" }, "description": "Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead." }, "get": { "httpMethod": "GET", "path": "v1/projects/{project}/instances/{instance}", "response": { "$ref": "DatabaseInstance" }, "description": "Retrieves a resource containing information about a Cloud SQL instance.", "flatPath": "v1/projects/{project}/instances/{instance}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.instances.get", "parameters": { "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Required. Database instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "project", "instance" ] } } }, "sslCerts": { "methods": { "delete": { "httpMethod": "DELETE", "description": "Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.", "path": "v1/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}", "parameterOrder": [ "project", "instance", "sha1Fingerprint" ], "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" }, "sha1Fingerprint": { "required": true, "description": "Sha1 FingerPrint.", "location": "path", "type": "string" } }, "id": "sql.sslCerts.delete" }, "list": { "flatPath": "v1/projects/{project}/instances/{instance}/sslCerts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.sslCerts.list", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "parameterOrder": [ "project", "instance" ], "httpMethod": "GET", "path": "v1/projects/{project}/instances/{instance}/sslCerts", "response": { "$ref": "SslCertsListResponse" }, "description": "Lists all of the current SSL certificates for the instance." }, "createEphemeral": { "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "description": "Project ID of the Cloud SQL project.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.sslCerts.createEphemeral", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/createEphemeral", "description": "Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.", "path": "v1/projects/{project}/instances/{instance}/createEphemeral", "response": { "$ref": "SslCert" }, "httpMethod": "POST", "request": { "$ref": "SslCertsCreateEphemeralRequest" } }, "get": { "parameterOrder": [ "project", "instance", "sha1Fingerprint" ], "id": "sql.sslCerts.get", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" }, "sha1Fingerprint": { "description": "Sha1 FingerPrint.", "location": "path", "type": "string", "required": true } }, "flatPath": "v1/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "description": "Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.", "path": "v1/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}", "response": { "$ref": "SslCert" }, "httpMethod": "GET" }, "insert": { "flatPath": "v1/projects/{project}/instances/{instance}/sslCerts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.sslCerts.insert", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "request": { "$ref": "SslCertsInsertRequest" }, "httpMethod": "POST", "description": "Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.", "path": "v1/projects/{project}/instances/{instance}/sslCerts", "response": { "$ref": "SslCertsInsertResponse" } } } }, "flags": { "methods": { "list": { "path": "v1/flags", "response": { "$ref": "FlagsListResponse" }, "description": "Lists all available database flags for Cloud SQL instances.", "httpMethod": "GET", "id": "sql.flags.list", "parameters": { "databaseVersion": { "description": "Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.", "location": "query", "type": "string" }, "flagScope": { "location": "query", "type": "string", "enumDescriptions": [ "Assume database flags if unspecified", "database flags", "connection pool configuration flags" ], "description": "Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified.", "enum": [ "SQL_FLAG_SCOPE_UNSPECIFIED", "SQL_FLAG_SCOPE_DATABASE", "SQL_FLAG_SCOPE_CONNECTION_POOL" ] } }, "parameterOrder": [], "flatPath": "v1/flags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] } } }, "projects": { "resources": { "instances": { "methods": { "performDiskShrink": { "id": "sql.projects.instances.performDiskShrink", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "parameterOrder": [ "project", "instance" ], "flatPath": "v1/projects/{project}/instances/{instance}/performDiskShrink", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "path": "v1/projects/{project}/instances/{instance}/performDiskShrink", "response": { "$ref": "Operation" }, "description": "Perform Disk Shrink on primary instance.", "request": { "$ref": "PerformDiskShrinkContext" }, "httpMethod": "POST" }, "getLatestRecoveryTime": { "description": "Get Latest Recovery Time for a given instance.", "path": "v1/projects/{project}/instances/{instance}/getLatestRecoveryTime", "response": { "$ref": "SqlInstancesGetLatestRecoveryTimeResponse" }, "httpMethod": "GET", "parameterOrder": [ "project", "instance" ], "id": "sql.projects.instances.getLatestRecoveryTime", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" }, "sourceInstanceDeletionTime": { "format": "google-datetime", "description": "The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.", "location": "query", "type": "string" } }, "flatPath": "v1/projects/{project}/instances/{instance}/getLatestRecoveryTime", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "verifyExternalSyncSettings": { "flatPath": "v1/projects/{project}/instances/{instance}/verifyExternalSyncSettings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.projects.instances.verifyExternalSyncSettings", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "project", "instance" ], "request": { "$ref": "SqlInstancesVerifyExternalSyncSettingsRequest" }, "httpMethod": "POST", "path": "v1/projects/{project}/instances/{instance}/verifyExternalSyncSettings", "response": { "$ref": "SqlInstancesVerifyExternalSyncSettingsResponse" }, "description": "Verify External primary instance external sync settings." }, "rescheduleMaintenance": { "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "id": "sql.projects.instances.rescheduleMaintenance", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/rescheduleMaintenance", "description": "Reschedules the maintenance on the given instance.", "path": "v1/projects/{project}/instances/{instance}/rescheduleMaintenance", "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "SqlInstancesRescheduleMaintenanceRequestBody" } }, "resetReplicaSize": { "path": "v1/projects/{project}/instances/{instance}/resetReplicaSize", "response": { "$ref": "Operation" }, "description": "Reset Replica Size to primary instance disk size.", "httpMethod": "POST", "request": { "$ref": "SqlInstancesResetReplicaSizeRequest" }, "parameters": { "project": { "required": true, "description": "ID of the project that contains the read replica.", "location": "path", "type": "string" }, "instance": { "description": "Cloud SQL read replica instance name.", "location": "path", "type": "string", "required": true } }, "id": "sql.projects.instances.resetReplicaSize", "parameterOrder": [ "project", "instance" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/resetReplicaSize" }, "startExternalSync": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/startExternalSync", "parameters": { "project": { "description": "ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.projects.instances.startExternalSync", "parameterOrder": [ "project", "instance" ], "httpMethod": "POST", "request": { "$ref": "SqlInstancesStartExternalSyncRequest" }, "path": "v1/projects/{project}/instances/{instance}/startExternalSync", "response": { "$ref": "Operation" }, "description": "Start External primary instance migration." }, "getDiskShrinkConfig": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/getDiskShrinkConfig", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.projects.instances.getDiskShrinkConfig", "parameterOrder": [ "project", "instance" ], "httpMethod": "GET", "path": "v1/projects/{project}/instances/{instance}/getDiskShrinkConfig", "response": { "$ref": "SqlInstancesGetDiskShrinkConfigResponse" }, "description": "Get Disk Shrink Config for a given instance." } } } } }, "users": { "methods": { "get": { "path": "v1/projects/{project}/instances/{instance}/users/{name}", "response": { "$ref": "User" }, "description": "Retrieves a resource containing information about a user.", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true }, "name": { "description": "User of the instance.", "location": "path", "type": "string", "required": true }, "host": { "description": "Host of a user of the instance.", "location": "query", "type": "string" } }, "id": "sql.users.get", "parameterOrder": [ "project", "instance", "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/users/{name}" }, "insert": { "path": "v1/projects/{project}/instances/{instance}/users", "response": { "$ref": "Operation" }, "description": "Creates a new user in a Cloud SQL instance.", "request": { "$ref": "User" }, "httpMethod": "POST", "id": "sql.users.insert", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "project", "instance" ], "flatPath": "v1/projects/{project}/instances/{instance}/users", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "list": { "description": "Lists users in the specified Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/users", "response": { "$ref": "UsersListResponse" }, "httpMethod": "GET", "parameterOrder": [ "project", "instance" ], "id": "sql.users.list", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "flatPath": "v1/projects/{project}/instances/{instance}/users", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "delete": { "httpMethod": "DELETE", "description": "Deletes a user from a Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/users", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/users", "parameterOrder": [ "project", "instance" ], "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string" }, "host": { "description": "Host of the user in the instance.", "location": "query", "type": "string" }, "name": { "description": "Name of the user in the instance.", "location": "query", "type": "string" } }, "id": "sql.users.delete" }, "update": { "parameterOrder": [ "project", "instance" ], "parameters": { "databaseRoles": { "description": "Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.", "location": "query", "type": "string", "repeated": true }, "revokeExistingRoles": { "description": "Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles.", "location": "query", "type": "boolean" }, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true }, "name": { "description": "Name of the user in the instance.", "location": "query", "type": "string" }, "host": { "description": "Optional. Host of the user in the instance.", "location": "query", "type": "string" } }, "id": "sql.users.update", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/users", "description": "Updates an existing user in a Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/users", "response": { "$ref": "Operation" }, "httpMethod": "PUT", "request": { "$ref": "User" } } } }, "backupRuns": { "methods": { "get": { "path": "v1/projects/{project}/instances/{instance}/backupRuns/{id}", "response": { "$ref": "BackupRun" }, "description": "Retrieves a resource containing information about a backup run.", "httpMethod": "GET", "id": "sql.backupRuns.get", "parameters": { "id": { "location": "path", "type": "string", "format": "int64", "description": "The ID of this backup run.", "required": true }, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "project", "instance", "id" ], "flatPath": "v1/projects/{project}/instances/{instance}/backupRuns/{id}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "insert": { "path": "v1/projects/{project}/instances/{instance}/backupRuns", "response": { "$ref": "Operation" }, "description": "Creates a new backup run on demand.", "httpMethod": "POST", "request": { "$ref": "BackupRun" }, "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.backupRuns.insert", "parameterOrder": [ "project", "instance" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/backupRuns" }, "delete": { "path": "v1/projects/{project}/instances/{instance}/backupRuns/{id}", "response": { "$ref": "Operation" }, "description": "Deletes the backup taken by a backup run.", "httpMethod": "DELETE", "id": "sql.backupRuns.delete", "parameters": { "id": { "required": true, "description": "The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/backupRuns/list) method.", "location": "path", "type": "string", "format": "int64" }, "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "parameterOrder": [ "project", "instance", "id" ], "flatPath": "v1/projects/{project}/instances/{instance}/backupRuns/{id}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "list": { "parameterOrder": [ "project", "instance" ], "parameters": { "maxResults": { "format": "int32", "description": "Maximum number of backup runs per response.", "location": "query", "type": "integer" }, "pageToken": { "description": "A previously-returned page token representing part of the larger set of results to view.", "location": "query", "type": "string" }, "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID, or \"-\" for all instances. This does not include the project ID.", "location": "path", "type": "string" } }, "id": "sql.backupRuns.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/backupRuns", "description": "Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.", "path": "v1/projects/{project}/instances/{instance}/backupRuns", "response": { "$ref": "BackupRunsListResponse" }, "httpMethod": "GET" } } }, "connect": { "methods": { "get": { "description": "Retrieves connect settings about a Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/connectSettings", "response": { "$ref": "ConnectSettings" }, "httpMethod": "GET", "parameterOrder": [ "project", "instance" ], "parameters": { "readTime": { "format": "google-datetime", "description": "Optional. Optional snapshot read timestamp to trade freshness for performance.", "location": "query", "type": "string" }, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "id": "sql.connect.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/connectSettings" }, "generateEphemeralCert": { "request": { "$ref": "GenerateEphemeralCertRequest" }, "httpMethod": "POST", "description": "Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.", "path": "v1/projects/{project}/instances/{instance}:generateEphemeralCert", "response": { "$ref": "GenerateEphemeralCertResponse" }, "flatPath": "v1/projects/{project}/instances/{instance}:generateEphemeralCert", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.connect.generateEphemeral", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string" } } } } }, "operations": { "methods": { "get": { "httpMethod": "GET", "path": "v1/projects/{project}/operations/{operation}", "response": { "$ref": "Operation" }, "description": "Retrieves an instance operation that has been performed on an instance.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/operations/{operation}", "parameters": { "project": { "required": true, "description": "Required. Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "operation": { "description": "Required. Instance operation ID.", "location": "path", "type": "string", "required": true } }, "id": "sql.operations.get", "parameterOrder": [ "project", "operation" ] }, "cancel": { "parameterOrder": [ "project", "operation" ], "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "operation": { "description": "Instance operation ID.", "location": "path", "type": "string", "required": true } }, "id": "sql.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/operations/{operation}/cancel", "description": "Cancels an instance operation that has been performed on an instance.", "path": "v1/projects/{project}/operations/{operation}/cancel", "response": { "$ref": "Empty" }, "httpMethod": "POST" }, "list": { "flatPath": "v1/projects/{project}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project" ], "id": "sql.operations.list", "parameters": { "pageToken": { "description": "A previously-returned page token representing part of the larger set of results to view.", "location": "query", "type": "string" }, "maxResults": { "description": "Maximum number of operations per response.", "location": "query", "type": "integer", "format": "uint32" }, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "query", "type": "string" } }, "httpMethod": "GET", "description": "Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.", "path": "v1/projects/{project}/operations", "response": { "$ref": "OperationsListResponse" } } } }, "Backups": { "methods": { "UpdateBackup": { "flatPath": "v1/projects/{projectsId}/backups/{backupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "name" ], "id": "sql.Backups.UpdateBackup", "parameters": { "name": { "pattern": "^projects/[^/]+/backups/[^/]+$", "required": true, "description": "Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.", "location": "path", "type": "string" }, "updateMask": { "description": "The list of fields that you can update. You can update only the description and retention period of the final backup.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "request": { "$ref": "Backup" }, "httpMethod": "PATCH", "description": "Updates the retention period and description of the backup. You can use this API to update final backups only.", "path": "v1/{+name}", "response": { "$ref": "Operation" } }, "GetBackup": { "description": "Retrieves a resource containing information about a backup.", "path": "v1/{+name}", "response": { "$ref": "Backup" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "sql.Backups.GetBackup", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup}", "pattern": "^projects/[^/]+/backups/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/backups/{backupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ] }, "ListBackups": { "parameters": { "pageToken": { "description": "A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+$", "required": true, "description": "Required. The parent that owns this collection of backups. Format: projects/{project}" }, "pageSize": { "description": "The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "description": "Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime\u003e=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.", "location": "query", "type": "string" } }, "id": "sql.Backups.ListBackups", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{projectsId}/backups", "path": "v1/{+parent}/backups", "response": { "$ref": "ListBackupsResponse" }, "description": "Lists all backups associated with the project.", "httpMethod": "GET" }, "DeleteBackup": { "flatPath": "v1/projects/{projectsId}/backups/{backupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "id": "sql.Backups.DeleteBackup", "parameters": { "name": { "pattern": "^projects/[^/]+/backups/[^/]+$", "required": true, "description": "Required. The name of the backup to delete. Format: projects/{project}/backups/{backup}", "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "description": "Deletes the backup." }, "CreateBackup": { "httpMethod": "POST", "request": { "$ref": "Backup" }, "path": "v1/{+parent}/backups", "response": { "$ref": "Operation" }, "description": "Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{projectsId}/backups", "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+$", "required": true, "description": "Required. The parent resource where this backup is created. Format: projects/{project}" } }, "id": "sql.Backups.CreateBackup", "parameterOrder": [ "parent" ] } } }, "databases": { "methods": { "delete": { "flatPath": "v1/projects/{project}/instances/{instance}/databases/{database}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance", "database" ], "id": "sql.databases.delete", "parameters": { "database": { "required": true, "description": "Name of the database to be deleted in the instance.", "location": "path", "type": "string" }, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "httpMethod": "DELETE", "description": "Deletes a database from a Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/databases/{database}", "response": { "$ref": "Operation" } }, "update": { "parameterOrder": [ "project", "instance", "database" ], "id": "sql.databases.update", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string" }, "database": { "description": "Name of the database to be updated in the instance.", "location": "path", "type": "string", "required": true } }, "flatPath": "v1/projects/{project}/instances/{instance}/databases/{database}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "description": "Updates a resource containing information about a database inside a Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/databases/{database}", "response": { "$ref": "Operation" }, "request": { "$ref": "Database" }, "httpMethod": "PUT" }, "list": { "flatPath": "v1/projects/{project}/instances/{instance}/databases", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "parameterOrder": [ "project", "instance" ], "id": "sql.databases.list", "parameters": { "project": { "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string", "required": true }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET", "description": "Lists databases in the specified Cloud SQL instance.", "path": "v1/projects/{project}/instances/{instance}/databases", "response": { "$ref": "DatabasesListResponse" } }, "get": { "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string" }, "database": { "description": "Name of the database in the instance.", "location": "path", "type": "string", "required": true } }, "id": "sql.databases.get", "parameterOrder": [ "project", "instance", "database" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/databases/{database}", "path": "v1/projects/{project}/instances/{instance}/databases/{database}", "response": { "$ref": "Database" }, "description": "Retrieves a resource containing information about a database inside a Cloud SQL instance.", "httpMethod": "GET" }, "insert": { "parameterOrder": [ "project", "instance" ], "id": "sql.databases.insert", "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "required": true, "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string" } }, "flatPath": "v1/projects/{project}/instances/{instance}/databases", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "description": "Inserts a resource containing information about a database inside a Cloud SQL instance. **Note:** You can't modify the default character set and collation.", "path": "v1/projects/{project}/instances/{instance}/databases", "response": { "$ref": "Operation" }, "request": { "$ref": "Database" }, "httpMethod": "POST" }, "patch": { "httpMethod": "PATCH", "request": { "$ref": "Database" }, "description": "Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.", "path": "v1/projects/{project}/instances/{instance}/databases/{database}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/instances/{instance}/databases/{database}", "parameterOrder": [ "project", "instance", "database" ], "parameters": { "project": { "required": true, "description": "Project ID of the project that contains the instance.", "location": "path", "type": "string" }, "instance": { "description": "Database instance ID. This does not include the project ID.", "location": "path", "type": "string", "required": true }, "database": { "description": "Name of the database to be updated in the instance.", "location": "path", "type": "string", "required": true } }, "id": "sql.databases.patch" } } }, "tiers": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sqlservice.admin" ], "flatPath": "v1/projects/{project}/tiers", "parameters": { "project": { "description": "Project ID of the project for which to list tiers.", "location": "path", "type": "string", "required": true } }, "id": "sql.tiers.list", "parameterOrder": [ "project" ], "httpMethod": "GET", "path": "v1/projects/{project}/tiers", "response": { "$ref": "TiersListResponse" }, "description": "Lists all available machine types (tiers) for Cloud SQL, for example, `db-custom-1-3840`. For more information, see https://cloud.google.com/sql/pricing." } } } }, "title": "Cloud SQL Admin API", "revision": "20260424", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/sqlservice.admin": { "description": "Manage your Google SQL Service instances" } } } }, "id": "sqladmin:v1", "parameters": { "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "type": "string", "location": "query", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "location": "query", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "location": "query", "default": "true" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" } }, "rootUrl": "https://sqladmin.googleapis.com/", "description": "API for Cloud SQL database instance management", "version": "v1", "kind": "discovery#restDescription", "documentationLink": "https://cloud.google.com/sql/docs", "baseUrl": "https://sqladmin.googleapis.com/", "ownerName": "Google", "protocol": "rest" }