blob: 435e46defb3f4fce82a35599481b07fd28a3f676 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/sqlservice.admin": {
"description": "Manage your Google SQL Service instances"
}
}
}
},
"basePath": "",
"baseUrl": "https://sqladmin.googleapis.com/",
"batchPath": "batch",
"canonicalName": "SQL Admin",
"description": "API for Cloud SQL database instance management",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/cloud-sql/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "sql:v1beta4",
"kind": "discovery#restDescription",
"name": "sql",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"backupRuns": {
"methods": {
"delete": {
"description": "Deletes the backup taken by a backup run.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"httpMethod": "DELETE",
"id": "sql.backupRuns.delete",
"parameterOrder": [
"project",
"instance",
"id"
],
"parameters": {
"id": {
"description": "The ID of the Backup Run to delete. To find a Backup Run ID, use the \u003ca\nhref=\"/sql/docs/db_path/admin-api/rest/v1beta4/backupRuns/list\"\u003elist\u003c/a\u003e\nmethod.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the backupRun to delete.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a resource containing information about a backup run.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"httpMethod": "GET",
"id": "sql.backupRuns.get",
"parameterOrder": [
"project",
"instance",
"id"
],
"parameters": {
"id": {
"description": "The ID of this Backup Run.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource backupRun.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}",
"response": {
"$ref": "BackupRun"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Creates a new backup run on demand. This method is applicable only to\nSecond Generation instances.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"httpMethod": "POST",
"id": "sql.backupRuns.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should create this backupRun.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"request": {
"$ref": "BackupRun"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists all backup runs associated with a given instance and configuration in\nthe reverse chronological order of the backup initiation time.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"httpMethod": "GET",
"id": "sql.backupRuns.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"description": "Maximum number of backup runs per response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of\nresults to view.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of backupRuns.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns",
"response": {
"$ref": "BackupRunsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"databases": {
"methods": {
"delete": {
"description": "Deletes a database from a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "DELETE",
"id": "sql.databases.delete",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database to be deleted in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database to delete.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a resource containing information about a database inside a Cloud\nSQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "GET",
"id": "sql.databases.get",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource database.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"response": {
"$ref": "Database"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Inserts a resource containing information about a database inside a Cloud\nSQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"httpMethod": "POST",
"id": "sql.databases.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should add this database.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"request": {
"$ref": "Database"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists databases in the specified Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"httpMethod": "GET",
"id": "sql.databases.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of databases.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases",
"response": {
"$ref": "DatabasesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"patch": {
"description": "Partially updates a resource containing information about a database inside\na Cloud SQL instance. This method supports patch semantics.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "PATCH",
"id": "sql.databases.patch",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database to be updated in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database for Cloud SQL to update.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"request": {
"$ref": "Database"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"update": {
"description": "Updates a resource containing information about a database inside a Cloud\nSQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"httpMethod": "PUT",
"id": "sql.databases.update",
"parameterOrder": [
"project",
"instance",
"database"
],
"parameters": {
"database": {
"description": "Name of the database to be updated in the instance.",
"location": "path",
"required": true,
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database for Cloud SQL to update.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/databases/{database}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}",
"request": {
"$ref": "Database"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"flags": {
"methods": {
"list": {
"description": "List all available database flags for Cloud SQL instances.",
"flatPath": "sql/v1beta4/flags",
"httpMethod": "GET",
"id": "sql.flags.list",
"parameterOrder": [],
"parameters": {
"databaseVersion": {
"description": "Database type and version you want to retrieve flags for. By default, this\nmethod returns flags for all database types and versions.",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/flags",
"response": {
"$ref": "FlagsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"instances": {
"methods": {
"addServerCa": {
"description": "Add a new trusted Certificate Authority (CA) version for the specified\ninstance. Required to prepare for a certificate rotation. If a CA version\nwas previously added but never used in a certificate rotation, this\noperation replaces that version. There cannot be more than one CA version\nwaiting to be rotated in.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa",
"httpMethod": "POST",
"id": "sql.instances.addServerCa",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should add this server CA.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"clone": {
"description": "Creates a Cloud SQL instance as a clone of the source instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/clone",
"httpMethod": "POST",
"id": "sql.instances.clone",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "The ID of the Cloud SQL instance to be cloned (source). This does not\ninclude the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL should clone this instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the source as well as the clone Cloud SQL instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/clone",
"request": {
"$ref": "InstancesCloneRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"delete": {
"description": "Deletes a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "DELETE",
"id": "sql.instances.delete",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance to be deleted.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of database instance to delete.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"demoteMaster": {
"description": "Demotes the stand-alone instance to be a Cloud SQL read replica for an\nexternal database server.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster",
"httpMethod": "POST",
"id": "sql.instances.demoteMaster",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL demotes this master database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/demoteMaster",
"request": {
"$ref": "InstancesDemoteMasterRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"export": {
"description": "Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL\ndump or CSV file.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/export",
"httpMethod": "POST",
"id": "sql.instances.export",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL exports this database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance to be exported.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/export",
"request": {
"$ref": "InstancesExportRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"failover": {
"description": "Failover the instance to its failover replica instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/failover",
"httpMethod": "POST",
"id": "sql.instances.failover",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL sends this database instance during a\nfailover. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/failover",
"request": {
"$ref": "InstancesFailoverRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a resource containing information about a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "GET",
"id": "sql.instances.get",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"response": {
"$ref": "DatabaseInstance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"import": {
"description": "Imports data into a Cloud SQL instance from a SQL dump or CSV file in\nCloud Storage.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/import",
"httpMethod": "POST",
"id": "sql.instances.import",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL imports this database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/import",
"request": {
"$ref": "InstancesImportRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"insert": {
"description": "Creates a new Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances",
"httpMethod": "POST",
"id": "sql.instances.insert",
"parameterOrder": [
"project"
],
"parameters": {
"parent": {
"description": "The parent resource where Cloud SQL creates this database instance.\nFormat: projects/{project}/locations/{location}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project to which the newly created Cloud SQL instances\nshould belong.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances",
"request": {
"$ref": "DatabaseInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists instances under a given project.",
"flatPath": "sql/v1beta4/projects/{project}/instances",
"httpMethod": "GET",
"id": "sql.instances.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "An expression for filtering the results of the request, such as by name or\nlabel.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "The maximum number of results to return per response.",
"format": "uint32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of\nresults to view.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project for which to list Cloud SQL instances.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances",
"response": {
"$ref": "InstancesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"listServerCas": {
"description": "Lists all of the trusted Certificate Authorities (CAs) for the specified\ninstance. There can be up to three CAs listed: the CA that was used to sign\nthe certificate that is currently in use, a CA that has been added but not\nyet used to sign a certificate, and a CA used to sign a certificate that\nhas previously rotated out.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCas",
"httpMethod": "GET",
"id": "sql.instances.listServerCas",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of server CAs.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCas",
"response": {
"$ref": "InstancesListServerCasResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"patch": {
"description": "Updates settings of a Cloud SQL instance.\nThis method supports patch semantics.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "PATCH",
"id": "sql.instances.patch",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database instance for Cloud SQL to update.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"request": {
"$ref": "DatabaseInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"promoteReplica": {
"description": "Promotes the read replica instance to be a stand-alone Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica",
"httpMethod": "POST",
"id": "sql.instances.promoteReplica",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL read replica instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL promotes this replica database\ninstance. Format: projects/{project}/locations/{location}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"resetSslConfig": {
"description": "Deletes all client certificates and generates a new server SSL certificate\nfor the instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig",
"httpMethod": "POST",
"id": "sql.instances.resetSslConfig",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL resets this SSL config.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/resetSslConfig",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"restart": {
"description": "Restarts a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/restart",
"httpMethod": "POST",
"id": "sql.instances.restart",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL restarts this database instance.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance to be restarted.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/restart",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"restoreBackup": {
"description": "Restores a backup of a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup",
"httpMethod": "POST",
"id": "sql.instances.restoreBackup",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL restores this database instance from\nbackup. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/restoreBackup",
"request": {
"$ref": "InstancesRestoreBackupRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"rotateServerCa": {
"description": "Rotates the server certificate to one signed by the Certificate Authority\n(CA) version previously added with the addServerCA method.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa",
"httpMethod": "POST",
"id": "sql.instances.rotateServerCa",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL rotates these server CAs.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa",
"request": {
"$ref": "InstancesRotateServerCaRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"startReplica": {
"description": "Starts the replication in the read replica instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/startReplica",
"httpMethod": "POST",
"id": "sql.instances.startReplica",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL read replica instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL starts this database instance\nreplication. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/startReplica",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"stopReplica": {
"description": "Stops the replication in the read replica instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/stopReplica",
"httpMethod": "POST",
"id": "sql.instances.stopReplica",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL read replica instance name.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL stops this database instance\nreplication. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/stopReplica",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"truncateLog": {
"description": "Truncate MySQL general and slow query log tables",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/truncateLog",
"httpMethod": "POST",
"id": "sql.instances.truncateLog",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL truncates this log.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the Cloud SQL project.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/truncateLog",
"request": {
"$ref": "InstancesTruncateLogRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"update": {
"description": "Updates settings of a Cloud SQL instance. \u003caside\nclass=\"caution\"\u003e\u003cstrong\u003eCaution:\u003c/strong\u003e This is not a partial update, so\nyou must include values for all the settings that you want to retain. For\npartial updates, use \u003ca\nhref=\"/sql/docs/db_path/admin-api/rest/v1beta4/instances/patch\"\u003epatch\u003c/a\u003e.\u003c/aside\u003e",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}",
"httpMethod": "PUT",
"id": "sql.instances.update",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the database instance for Cloud SQL to update.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}",
"request": {
"$ref": "DatabaseInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Retrieves an instance operation that has been performed on an instance.",
"flatPath": "sql/v1beta4/projects/{project}/operations/{operation}",
"httpMethod": "GET",
"id": "sql.operations.get",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Instance operation ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the operation for Cloud SQL to get.\nFormat: projects/{project}/locations/{location}/operations/{operation}",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/operations/{operation}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists all instance operations that have been performed on the given Cloud\nSQL instance in the reverse chronological order of the start time.",
"flatPath": "sql/v1beta4/projects/{project}/operations",
"httpMethod": "GET",
"id": "sql.operations.list",
"parameterOrder": [
"project"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Maximum number of operations per response.",
"format": "uint32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of\nresults to view.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Indirect parent. The direct parent should combine with the instance name,\nwhich owns this collection of operations.\nFormat:\nprojects/{project}/locations/{location}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/operations",
"response": {
"$ref": "OperationsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"projects": {
"resources": {
"instances": {
"methods": {
"rescheduleMaintenance": {
"description": "Reschedules the maintenance on the given instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance",
"httpMethod": "POST",
"id": "sql.projects.instances.rescheduleMaintenance",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL reshedule this database instance's\nmaintenance. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance",
"request": {
"$ref": "SqlInstancesRescheduleMaintenanceRequestBody"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"locations": {
"resources": {
"instances": {
"methods": {
"rescheduleMaintenance": {
"description": "Reschedules the maintenance on the given instance.",
"flatPath": "sql/v1beta4/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/rescheduleMaintenance",
"httpMethod": "POST",
"id": "sql.projects.locations.instances.rescheduleMaintenance",
"parameterOrder": [
"parent"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL reshedule this database instance's\nmaintenance. Format:\nprojects/{project}/locations/{location}/instances/{instance}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"project": {
"description": "ID of the project that contains the instance.",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/{+parent}/rescheduleMaintenance",
"request": {
"$ref": "SqlInstancesRescheduleMaintenanceRequestBody"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
}
}
}
}
},
"sslCerts": {
"methods": {
"createEphemeral": {
"description": "Generates a short-lived X509 certificate containing the provided public key\nand signed by a private key specific to the target instance. Users may use\nthe certificate to authenticate as themselves when connecting to the\ndatabase.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral",
"httpMethod": "POST",
"id": "sql.sslCerts.createEphemeral",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL creates this ephemeral certificate.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the Cloud SQL project.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/createEphemeral",
"request": {
"$ref": "SslCertsCreateEphemeralRequest"
},
"response": {
"$ref": "SslCert"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"delete": {
"description": "Deletes the SSL certificate. For First Generation instances, the\ncertificate remains valid until the instance is restarted.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"httpMethod": "DELETE",
"id": "sql.sslCerts.delete",
"parameterOrder": [
"project",
"instance",
"sha1Fingerprint"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of SSL certificate to delete.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert}",
"location": "query",
"type": "string"
},
"sha1Fingerprint": {
"description": "Sha1 FingerPrint.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"get": {
"description": "Retrieves a particular SSL certificate. Does not include the private key\n(required for usage). The private key must be saved from the response to\ninitial creation.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"httpMethod": "GET",
"id": "sql.sslCerts.get",
"parameterOrder": [
"project",
"instance",
"sha1Fingerprint"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "Name of the resource ssl certificate.\nFormat:\nprojects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert}",
"location": "query",
"type": "string"
},
"sha1Fingerprint": {
"description": "Sha1 FingerPrint.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}",
"response": {
"$ref": "SslCert"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Creates an SSL certificate and returns it along with the private key and\nserver certificate authority. The new certificate will not be usable until\nthe instance is restarted.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"httpMethod": "POST",
"id": "sql.sslCerts.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL creates this SSL certificate.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"request": {
"$ref": "SslCertsInsertRequest"
},
"response": {
"$ref": "SslCertsInsertResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"list": {
"description": "Lists all of the current SSL certificates for the instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"httpMethod": "GET",
"id": "sql.sslCerts.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Cloud SQL instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of SSL certificates.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/sslCerts",
"response": {
"$ref": "SslCertsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"tiers": {
"methods": {
"list": {
"description": "Lists all available machine types (tiers) for Cloud SQL, for example,\ndb-n1-standard-1. For related information, see \u003ca\nhref=\"/sql/pricing\"\u003ePricing\u003c/a\u003e.",
"flatPath": "sql/v1beta4/projects/{project}/tiers",
"httpMethod": "GET",
"id": "sql.tiers.list",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID of the project for which to list tiers.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/tiers",
"response": {
"$ref": "TiersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
},
"users": {
"methods": {
"delete": {
"description": "Deletes a user from a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "DELETE",
"id": "sql.users.delete",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"host": {
"description": "Host of the user in the instance.",
"location": "query",
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "Name of the user in the instance.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the user to delete.\nFormat: projects/{project}/locations/{location}/instances/{instance}/users",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"insert": {
"description": "Creates a new user in a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "POST",
"id": "sql.users.insert",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent resource where Cloud SQL creates this user.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"request": {
"$ref": "User"
},
"response": {
"$ref": "Operation"
},
"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.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "GET",
"id": "sql.users.list",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent, which owns this collection of users.\nFormat: projects/{project}/locations/{location}/instances/{instance}",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"response": {
"$ref": "UsersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
"update": {
"description": "Updates an existing user in a Cloud SQL instance.",
"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"httpMethod": "PUT",
"id": "sql.users.update",
"parameterOrder": [
"project",
"instance"
],
"parameters": {
"host": {
"description": "Optional. Host of the user in the instance.",
"location": "query",
"type": "string"
},
"instance": {
"description": "Database instance ID. This does not include the project ID.",
"location": "path",
"required": true,
"type": "string"
},
"name": {
"description": "Name of the user in the instance.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
"required": true,
"type": "string"
},
"resourceName": {
"description": "The name of the user for Cloud SQL to update.\nFormat: projects/{project}/locations/{location}/instances/{instance}/users",
"location": "query",
"type": "string"
}
},
"path": "sql/v1beta4/projects/{project}/instances/{instance}/users",
"request": {
"$ref": "User"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/sqlservice.admin"
]
}
}
}
},
"revision": "20191214",
"rootUrl": "https://sqladmin.googleapis.com/",
"schemas": {
"AclEntry": {
"description": "An entry for an Access Control list.",
"id": "AclEntry",
"properties": {
"expirationTime": {
"description": "The time when this access control entry expires in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#aclEntry\u003c/code\u003e.",
"type": "string"
},
"name": {
"description": "Optional. A label to identify this entry.",
"type": "string"
},
"value": {
"description": "The whitelisted value for the access control list.",
"type": "string"
}
},
"type": "object"
},
"ApiWarning": {
"description": "An Admin API warning message.",
"id": "ApiWarning",
"properties": {
"code": {
"description": "Code to uniquely identify the warning type.",
"enum": [
"SQL_API_WARNING_CODE_UNSPECIFIED",
"REGION_UNREACHABLE"
],
"enumDescriptions": [
"An unknown or unset warning type from Cloud SQL API.",
"Warning when one or more regions are not reachable. The returned result\nset may be incomplete."
],
"type": "string"
},
"message": {
"description": "The warning message.",
"type": "string"
}
},
"type": "object"
},
"BackupConfiguration": {
"description": "Database instance backup configuration.",
"id": "BackupConfiguration",
"properties": {
"binaryLogEnabled": {
"description": "Whether binary log is enabled. If backup configuration is disabled, binary\nlog must be disabled as well.",
"type": "boolean"
},
"enabled": {
"description": "Whether this configuration is enabled.",
"type": "boolean"
},
"kind": {
"description": "This is always \u003ccode\u003esql#backupConfiguration\u003c/code\u003e.",
"type": "string"
},
"location": {
"description": "Location of the backup",
"type": "string"
},
"replicationLogArchivingEnabled": {
"description": "Reserved for future use.",
"type": "boolean"
},
"startTime": {
"description": "Start time for the daily backup configuration in UTC timezone in the 24\nhour format - \u003ccode\u003eHH:MM\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"BackupRun": {
"description": "A BackupRun resource.",
"id": "BackupRun",
"properties": {
"description": {
"description": "The description of this run, only applicable to on-demand backups.",
"type": "string"
},
"diskEncryptionConfiguration": {
"$ref": "DiskEncryptionConfiguration",
"description": "Encryption configuration specific to a backup.\nApplies only to Second Generation instances."
},
"diskEncryptionStatus": {
"$ref": "DiskEncryptionStatus",
"description": "Encryption status specific to a backup.\nApplies only to Second Generation instances."
},
"endTime": {
"description": "The time the backup operation completed in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"enqueuedTime": {
"description": "The time the run was enqueued in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"error": {
"$ref": "OperationError",
"description": "Information about why the backup operation failed. This is only present if\nthe run has the FAILED status."
},
"id": {
"description": "The identifier for this backup run. Unique only for a specific Cloud SQL\ninstance.",
"format": "int64",
"type": "string"
},
"instance": {
"description": "Name of the database instance.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#backupRun\u003c/code\u003e.",
"type": "string"
},
"location": {
"description": "Location of the backups.",
"type": "string"
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"startTime": {
"description": "The time the backup operation actually started in UTC timezone in \u003ca\nhref=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e format, for example\n\u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
},
"status": {
"description": "The status of this run.",
"enum": [
"SQL_BACKUP_RUN_STATUS_UNSPECIFIED",
"ENQUEUED",
"OVERDUE",
"RUNNING",
"FAILED",
"SUCCESSFUL",
"SKIPPED",
"DELETION_PENDING",
"DELETION_FAILED",
"DELETED"
],
"enumDescriptions": [
"The status of the run is unknown.",
"The backup operation was enqueued.",
"The backup is overdue across a given backup window. Indicates a\nproblem. Example: Long-running operation in progress during\nthe whole window.",
"The backup is in progress.",
"The backup failed.",
"The backup was successful.",
"The backup was skipped (without problems) for a given backup\nwindow. Example: Instance was idle.",
"The backup is about to be deleted.",
"The backup deletion failed.",
"The backup has been deleted."
],
"type": "string"
},
"type": {
"description": "The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\".",
"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."
],
"type": "string"
},
"windowStartTime": {
"description": "The start time of the backup window during which this the backup was\nattempted in \u003ca href=\"https://tools.ietf.org/html/rfc3339\"\u003eRFC 3339\u003c/a\u003e\nformat, for example \u003ccode\u003e2012-11-15T16:19:00.094Z\u003c/code\u003e.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"BackupRunsListResponse": {
"description": "Backup run list results.",
"id": "BackupRunsListResponse",
"properties": {
"items": {
"description": "A list of backup runs in reverse chronological order of the enqueued time.",
"items": {
"$ref": "BackupRun"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#backupRunsList\u003c/code\u003e.",
"type": "string"
},
"nextPageToken": {
"description": "The continuation token, used to page through large result sets. Provide\nthis value in a subsequent request to return the next page of results.",
"type": "string"
}
},
"type": "object"
},
"BinLogCoordinates": {
"description": "Binary log coordinates.",
"id": "BinLogCoordinates",
"properties": {
"binLogFileName": {
"description": "Name of the binary log file for a Cloud SQL instance.",
"type": "string"
},
"binLogPosition": {
"description": "Position (offset) within the binary log file.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#binLogCoordinates\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"CloneContext": {
"description": "Database instance clone context.",
"id": "CloneContext",
"properties": {
"binLogCoordinates": {
"$ref": "BinLogCoordinates",
"description": "Binary log coordinates, if specified, identify the position up to which the\nsource instance should be cloned. If not specified, the source instance is\ncloned up to the most recent binary log coordinates."
},
"destinationInstanceName": {
"description": "Name of the Cloud SQL instance to be created as a clone.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#cloneContext\u003c/code\u003e.",
"type": "string"
},
"pitrTimestampMs": {
"description": "Reserved for future use.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Database": {
"description": "Represents a SQL database on the Cloud SQL instance.",
"id": "Database",
"properties": {
"charset": {
"description": "The MySQL charset value.",
"type": "string"
},
"collation": {
"description": "The MySQL collation value.",
"type": "string"
},
"etag": {
"description": "This field is deprecated and will be removed from a future version of the\nAPI.",
"type": "string"
},
"instance": {
"description": "The name of the Cloud SQL instance. This does not include the project ID.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#database\u003c/code\u003e.",
"type": "string"
},
"name": {
"description": "The name of the database in the Cloud SQL instance. This does not include\nthe project ID or instance name.",
"type": "string"
},
"project": {
"description": "The project ID of the project containing the Cloud SQL database. The Google\napps domain is prefixed if applicable.",
"type": "string"
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"sqlserverDatabaseDetails": {
"$ref": "SqlServerDatabaseDetails"
}
},
"type": "object"
},
"DatabaseFlags": {
"description": "Database flags for Cloud SQL instances.",
"id": "DatabaseFlags",
"properties": {
"name": {
"description": "The name of the flag. These flags are passed at instance startup, so\ninclude both server options and system variables for MySQL. Flags should be\nspecified with underscores, not hyphens. For more information, see \u003ca\nhref=\"/sql/docs/mysql/flags\"\u003eConfiguring Database Flags\u003c/a\u003e in the Cloud\nSQL documentation.",
"type": "string"
},
"value": {
"description": "The value of the flag. Booleans should be set to \u003ccode\u003eon\u003c/code\u003e for true\nand \u003ccode\u003eoff\u003c/code\u003e for false. This field must be omitted if the flag\ndoesn't take a value.",
"type": "string"
}
},
"type": "object"
},
"DatabaseInstance": {
"description": "A Cloud SQL instance resource.",
"id": "DatabaseInstance",
"properties": {
"backendType": {
"description": "\u003ccode\u003eFIRST_GEN\u003c/code\u003e: First Generation instance. MySQL only. \u003cbr\n/\u003e\u003ccode\u003eSECOND_GEN\u003c/code\u003e: Second Generation instance or PostgreSQL\ninstance. \u003cbr /\u003e\u003ccode\u003eEXTERNAL\u003c/code\u003e: A database server that is not\nmanaged by Google. \u003cbr\u003eThis property is read-only; use the\n\u003ccode\u003etier\u003c/code\u003e property in the \u003ccode\u003esettings\u003c/code\u003e object to determine\nthe database type and Second or First Generation.",
"enum": [
"SQL_BACKEND_TYPE_UNSPECIFIED",
"FIRST_GEN",
"SECOND_GEN",
"EXTERNAL"
],
"enumDescriptions": [
"This is an unknown backend type for instance.",
"V1 speckle instance.",
"V2 speckle instance.",
"On premises instance."
],
"type": "string"
},
"connectionName": {
"description": "Connection name of the Cloud SQL instance used in connection strings.",
"type": "string"
},
"currentDiskSize": {
"description": "The current disk usage of the instance in bytes. This property has been\ndeprecated. Users should use the\n\"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud\nMonitoring API instead. Please see \u003ca\nhref=\"https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ\"\u003ethis\nannouncement\u003c/a\u003e for details.",
"format": "int64",
"type": "string"
},
"databaseVersion": {
"description": "The database engine type and version. The \u003ccode\u003edatabaseVersion\u003c/code\u003e\nfield can not be changed after instance creation. MySQL Second Generation\ninstances: \u003ccode\u003eMYSQL_5_7\u003c/code\u003e (default) or \u003ccode\u003eMYSQL_5_6\u003c/code\u003e.\nPostgreSQL instances: \u003ccode\u003ePOSTGRES_9_6\u003c/code\u003e (default) or\n\u003ccode\u003ePOSTGRES_11 Beta\u003c/code\u003e MySQL First Generation\ninstances: \u003ccode\u003eMYSQL_5_6\u003c/code\u003e (default) or \u003ccode\u003eMYSQL_5_5\u003c/code\u003e",
"enum": [
"SQL_DATABASE_VERSION_UNSPECIFIED",
"OBSOLETE_MYSQL_5_0",
"MYSQL_5_1",
"MYSQL_5_5",
"MARIADB_10_0",
"MYSQL_5_6",
"MYSQL_5_7",
"OBSOLETE_POSTGRES_9_5",
"SQLSERVER_ENTERPRISE_2016",
"POSTGRES_9_6",
"POSTGRES_11",
"SQLSERVER_2017_STANDARD",
"SQLSERVER_2017_ENTERPRISE",
"SQLSERVER_2017_EXPRESS",
"SQLSERVER_2017_WEB",
"POSTGRES_10"
],
"enumDescriptions": [
"This is an unknown database version.",
"The database version is MySQL 5.0.",
"The database version is MySQL 5.1.",
"The database version is MySQL 5.5.",
"The database version is MariaDB 10.0.",
"The database version is MySQL 5.6.",
"The database version is MySQL 5.7.",
"The database version is PostgreSQL 9.5.",
"The database version is SQL Server 2016.",
"The database version is PostgreSQL 9.6.",
"The database version is PostgreSQL 11.",
"The database version is SQL Server 2017.",
"",
"",
"",
"The database version is PostgreSQL 10."
],
"type": "string"
},
"diskEncryptionConfiguration": {
"$ref": "DiskEncryptionConfiguration",
"description": "Disk encryption configuration specific to an instance.\nApplies only to Second Generation instances."
},
"diskEncryptionStatus": {
"$ref": "DiskEncryptionStatus",
"description": "Disk encryption status specific to an instance.\nApplies only to Second Generation instances."
},
"etag": {
"description": "This field is deprecated and will be removed from a future version of the\nAPI. Use the \u003ccode\u003esettings.settingsVersion\u003c/code\u003e field instead.",
"type": "string"
},
"failoverReplica": {
"description": "The name and status of the failover replica. This property is applicable\nonly to Second Generation instances.",
"properties": {
"available": {
"description": "The availability status of the failover replica. A false status indicates\nthat the failover replica is out of sync. The master can only failover to\nthe failover replica when the status is true.",
"type": "boolean"
},
"name": {
"description": "The name of the failover replica. If specified at instance creation, a\nfailover replica is created for the instance. The name\ndoesn't include the project ID. This property is applicable only to\nSecond Generation instances.",
"type": "string"
}
},
"type": "object"
},
"gceZone": {
"description": "The Compute Engine zone that the instance is currently serving from. This\nvalue could be different from the zone that was specified when the instance\nwas created if the instance has failed over to its secondary zone.",
"type": "string"
},
"instanceType": {
"description": "The instance type. This can be one of the following.\n\u003cbr\u003e\u003ccode\u003eCLOUD_SQL_INSTANCE\u003c/code\u003e: A Cloud SQL instance that is not\nreplicating from a master. \u003cbr\u003e\u003ccode\u003eON_PREMISES_INSTANCE\u003c/code\u003e: An\ninstance running on the\ncustomer's premises. \u003cbr\u003e\u003ccode\u003eREAD_REPLICA_INSTANCE\u003c/code\u003e: A Cloud SQL\ninstance configured as a read-replica.",
"enum": [
"SQL_INSTANCE_TYPE_UNSPECIFIED",
"CLOUD_SQL_INSTANCE",
"ON_PREMISES_INSTANCE",
"READ_REPLICA_INSTANCE"
],
"enumDescriptions": [
"This is an unknown Cloud SQL instance type.",
"A regular Cloud SQL instance.",
"An instance running on the customer's premises that is not managed by\nCloud SQL.",
"A Cloud SQL instance acting as a read-replica."
],
"type": "string"
},
"ipAddresses": {
"description": "The assigned IP addresses for the instance.",
"items": {
"$ref": "IpMapping"
},
"type": "array"
},
"ipv6Address": {
"description": "The IPv6 address assigned to the instance. This property is applicable only\nto First Generation instances.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#instance\u003c/code\u003e.",
"type": "string"
},
"masterInstanceName": {
"description": "The name of the instance which will act as master in the replication setup.",
"type": "string"
},
"maxDiskSize": {
"description": "The maximum disk size of the instance in bytes.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Name of the Cloud SQL instance. This does not include the project ID.",
"type": "string"
},
"onPremisesConfiguration": {
"$ref": "OnPremisesConfiguration",
"description": "Configuration specific to on-premises instances."
},
"project": {
"description": "The project ID of the project containing the Cloud SQL instance. The Google\napps domain is prefixed if applicable.",
"type": "string"
},
"region": {
"description": "The geographical region. Can be \u003ccode\u003eus-central\u003c/code\u003e\n(\u003ccode\u003eFIRST_GEN\u003c/code\u003e instances only), \u003ccode\u003eus-central1\u003c/code\u003e\n(\u003ccode\u003eSECOND_GEN\u003c/code\u003e instances only), \u003ccode\u003easia-east1\u003c/code\u003e or\n\u003ccode\u003eeurope-west1\u003c/code\u003e. Defaults to \u003ccode\u003eus-central\u003c/code\u003e or\n\u003ccode\u003eus-central1\u003c/code\u003e depending on the instance type (First Generation\nor Second Generation). The region can not be changed after instance\ncreation.",
"type": "string"
},
"replicaConfiguration": {
"$ref": "ReplicaConfiguration",
"description": "Configuration specific to failover replicas and read replicas."
},
"replicaNames": {
"description": "The replicas of the instance.",
"items": {
"type": "string"
},
"type": "array"
},
"rootPassword": {
"description": "Initial root password. Use only on creation.",
"type": "string"
},
"scheduledMaintenance": {
"$ref": "SqlScheduledMaintenance",
"description": "The start time of any upcoming scheduled maintenance for this instance."
},
"selfLink": {
"description": "The URI of this resource.",
"type": "string"
},
"serverCaCert": {
"$ref": "SslCert",
"description": "SSL configuration."
},
"serviceAccountEmailAddress": {
"description": "The service account email address assigned to the instance. This property\nis applicable only to Second Generation instances.",
"type": "string"
},
"settings": {
"$ref": "Settings",
"description": "The user settings."
},
"state": {
"description": "The current serving state of the Cloud SQL instance. This can be one of the\nfollowing. \u003cbr\u003e\u003ccode\u003eRUNNABLE\u003c/code\u003e: The instance is running, or is ready\nto run when accessed. \u003cbr\u003e\u003ccode\u003eSUSPENDED\u003c/code\u003e: The instance is not\navailable, for example due to problems with billing.\n\u003cbr\u003e\u003ccode\u003ePENDING_CREATE\u003c/code\u003e: The instance is being created.\n\u003cbr\u003e\u003ccode\u003eMAINTENANCE\u003c/code\u003e: The instance is down for maintenance.\n\u003cbr\u003e\u003ccode\u003eFAILED\u003c/code\u003e: The instance creation failed.\n\u003cbr\u003e\u003ccode\u003eUNKNOWN_STATE\u003c/code\u003e: The state of the instance is unknown.",
"enum": [
"SQL_INSTANCE_STATE_UNSPECIFIED",
"RUNNABLE",
"SUSPENDED",
"PENDING_DELETE",
"PENDING_CREATE",
"MAINTENANCE",
"FAILED"
],
"enumDescriptions": [
"The state of the instance is unknown.",
"The instance is running.",
"The instance is currently offline, but it may run again in the future.",
"The instance is being deleted.",
"The instance is being created.",
"The instance is down for maintenance.",
"The instance failed to be created."
],
"type": "string"
},
"suspensionReason": {
"description": "If the instance state is SUSPENDED, the reason for the suspension.",
"enumDescriptions": [
"This is an unknown suspension reason.",
"The instance is suspended due to billing issues (e.g., GCP account issue)",
"The instance is suspended due to illegal content (e.g., child pornography,\ncopyrighted material, etc.).",
"The instance is causing operational issues (e.g., causing the database\nto crash).",
"The KMS key used by the instance is either revoked or denied access to"
],
"items": {
"enum": [
"SQL_SUSPENSION_REASON_UNSPECIFIED",
"BILLING_ISSUE",
"LEGAL_ISSUE",
"OPERATIONAL_ISSUE",
"KMS_KEY_ISSUE"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"DatabasesListResponse": {
"description": "Database list response.",
"id": "DatabasesListResponse",
"properties": {
"items": {
"description": "List of database resources in the instance.",
"items": {
"$ref": "Database"
},
"type": "array"
},
"kind": {
"description": "This is always \u003ccode\u003esql#databasesList\u003c/code\u003e.",
"type": "string"
}
},
"type": "object"
},
"DemoteMasterConfiguration": {
"description": "Read-replica configuration for connecting to the on-premises master.",
"id": "DemoteMasterConfiguration",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#demoteMasterConfiguration\u003c/code\u003e.",
"type": "string"
},
"mysqlReplicaConfiguration": {
"$ref": "DemoteMasterMySqlReplicaConfiguration",
"description": "MySQL specific configuration when replicating from a MySQL on-premises\nmaster. Replication configuration information such as the username,\npassword, certificates, and keys are not stored in the instance metadata.\nThe configuration information is used only to set up the replication\nconnection and is stored by MySQL in a file named \u003ccode\u003emaster.info\u003c/code\u003e\nin the data directory."
}
},
"type": "object"
},
"DemoteMasterContext": {
"description": "Database instance demote master context.",
"id": "DemoteMasterContext",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#demoteMasterContext\u003c/code\u003e.",
"type": "string"
},
"masterInstanceName": {
"description": "The name of the instance which will act as on-premises master in the\nreplication setup.",
"type": "string"
},
"replicaConfiguration": {
"$ref": "DemoteMasterConfiguration",
"description": "Configuration specific to read-replicas replicating from the on-premises\nmaster."
},
"verifyGtidConsistency": {
"description": "Verify GTID consistency for demote operation. Default value:\n\u003ccode\u003eTrue\u003c/code\u003e. Second Generation instances only. Setting this flag to\nfalse enables you to bypass GTID consistency check between on-premises\nmaster and Cloud SQL instance during the demotion operation but also\nexposes you to the risk of future replication failures. Change the value\nonly if you know the reason for the GTID divergence and are confident that\ndoing so will not cause any replication issues.",
"type": "boolean"
}
},
"type": "object"
},
"DemoteMasterMySqlReplicaConfiguration": {
"description": "Read-replica configuration specific to MySQL databases.",
"id": "DemoteMasterMySqlReplicaConfiguration",
"properties": {
"caCertificate": {
"description": "PEM representation of the trusted CA's x509 certificate.",
"type": "string"
},
"clientCertificate": {
"description": "PEM representation of the slave's x509 certificate.",
"type": "string"
},
"clientKey": {
"description": "PEM representation of the slave's private key. The corresponsing public key\nis encoded in the client's certificate. The format of the slave's private\nkey can be either PKCS #1 or PKCS #8.",
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#demoteMasterMysqlReplicaConfiguration\u003c/code\u003e.",
"type": "string"
},
"password": {
"description": "The password for the replication connection.",
"type": "string"
},
"username": {
"description": "The username for the replication connection.",
"type": "string"
}
},
"type": "object"
},
"DiskEncryptionConfiguration": {
"description": "Disk encryption configuration for an instance.",
"id": "DiskEncryptionConfiguration",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#diskEncryptionConfiguration\u003c/code\u003e.",
"type": "string"
},
"kmsKeyName": {
"description": "Resource name of KMS key for disk encryption",
"type": "string"
}
},
"type": "object"
},
"DiskEncryptionStatus": {
"description": "Disk encryption status for an instance.",
"id": "DiskEncryptionStatus",
"properties": {
"kind": {
"description": "This is always \u003ccode\u003esql#diskEncryptionStatus\u003c/code\u003e.",
"type": "string"
},
"kmsKeyVersionName": {
"description": "KMS key version used to encrypt the Cloud SQL instance resource",
"type": "string"
}
},
"type": "object"
},
"ExportContext": {
"description": "Database instance export context.",
"id": "ExportContext",
"properties": {
"csvExportOptions": {
"description": "Options for exporting data as CSV.",
"properties": {
"selectQuery": {
"description": "The select query used to extract the data.",
"type": "string"
}
},
"type": "object"
},
"databases": {
"description": "Databases to be exported. \u003cbr /\u003e \u003cb\u003eMySQL instances:\u003c/b\u003e If\n\u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eSQL\u003c/code\u003e and no database is specified, all\ndatabases are exported, except for the \u003ccode\u003emysql\u003c/code\u003e system database.\nIf \u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eCSV\u003c/code\u003e, you can specify one database,\neither by using this property or by using the\n\u003ccode\u003ecsvExportOptions.selectQuery\u003c/code\u003e property, which takes precedence\nover this property. \u003cbr /\u003e \u003cb\u003ePostgreSQL instances:\u003c/b\u003e You must specify\none database to be exported. If \u003ccode\u003efileType\u003c/code\u003e is \u003ccode\u003eCSV\u003c/code\u003e,\nthis database must match the one specified in the\n\u003ccode\u003ecsvExportOptions.selectQuery\u003c/code\u003e property.",
"items": {
"type": "string"
},
"type": "array"
},
"fileType": {
"description": "The file type for the specified uri. \u003cbr\u003e\u003ccode\u003eSQL\u003c/code\u003e: The file\ncontains SQL statements. \u003cbr\u003e\u003ccode\u003eCSV\u003c/code\u003e: The file contains CSV data.",
"enum": [
"SQL_FILE_TYPE_UNSPECIFIED",
"SQL",
"CSV",
"BAK"
],
"enumDescriptions": [
"Unknown file type.",
"File containing SQL statements.",
"File in CSV format.",
""
],
"type": "string"
},
"kind": {
"description": "This is always \u003ccode\u003esql#exportContext\u003c/code\u003e.",
"type": "string"
},
"sqlExportOptions": {
"description": "Options for exporting data as SQL statements.",
"properties": {
"mysqlExportOptions": {
"description": "Options for exporting from MySQL.",
"properties": {
"masterData": {
"description": "Option to include SQL statement required to set up replication.\nIf set to \u003ccode\u003e1\u003c/code\u003e, the dump file includes\n a CHANGE MASTER TO statement with the binary log coordinates.\nIf set to \u003ccode\u003e2\u003c/code\u003e, the CHANGE MASTER TO statement is written as\n a SQL comment, and has no effect.\nAll other values are ignored.",
"format": "int32",
"type": "integer"
}
},