Method: instances.clone

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

HTTP request

POST https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/clone

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID of the source as well as the clone Cloud SQL instance.
instance

string

The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.

Request body

The request body contains an instance of InstancesCloneRequest.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/sqlservice.admin

For more information, see the Authentication Overview.

InstancesCloneRequest

Database instance clone request.

JSON representation 
{
  "cloneContext": {
    object (CloneContext)
  }
}
Fields
cloneContext

object (CloneContext)

Contains details about the clone operation.

CloneContext

Database instance clone context.

JSON representation 
{
  "kind": string,
  "pitrTimestampMs": string,
  "destinationInstanceName": string,
  "binLogCoordinates": {
    object (BinLogCoordinates)
  },
  "pointInTime": string,
  "allocatedIpRange": string,
  "databaseNames": [
    string
  ]
}
Fields
kind

string

This is always sql#cloneContext.
pitrTimestampMs

string (int64 format)

Reserved for future use.
destinationInstanceName

string

Name of the Cloud SQL instance to be created as a clone.
binLogCoordinates

object (BinLogCoordinates)

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.
pointInTime

string (Timestamp format)

Timestamp, if specified, identifies the time to which the source instance is cloned.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
allocatedIpRange

string

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. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. Reserved for future use.
databaseNames[]

string

(SQL Server only) instances.clone only the specified databases from the source instance. instances.clone all databases if empty.

BinLogCoordinates

Binary log coordinates.

JSON representation 
{
  "binLogFileName": string,
  "binLogPosition": string,
  "kind": string
}
Fields
binLogFileName

string

Name of the binary log file for a Cloud SQL instance.
binLogPosition

string (int64 format)

Position (offset) within the binary log file.
kind

string

This is always sql#binLogCoordinates.