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

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: sqladmin1 --scope <scope> instances clone ...

Required Scalar Arguments

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

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

InstancesCloneRequest:
  clone-context:
    allocated-ip-range: string
    bin-log-coordinates:
      bin-log-file-name: string
      bin-log-position: string
      kind: string
    database-names: [string]
    destination-instance-name: string
    kind: string
    pitr-timestamp-ms: string
    point-in-time: string
    preferred-zone: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .clone-context allocated-ip-range=amet.
    • 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.
  • bin-log-coordinates bin-log-file-name=consetetur
    • Name of the binary log file for a Cloud SQL instance.
  • bin-log-position=diam
    • Position (offset) within the binary log file.

  • kind=dolor

    • This is always sql#binLogCoordinates.

  • .. database-names=et

    • (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
    • Each invocation of this argument appends the given value to the array.
  • destination-instance-name=et
    • Name of the Cloud SQL instance to be created as a clone.
  • kind=sadipscing
    • This is always sql#cloneContext.
  • pitr-timestamp-ms=stet
    • Reserved for future use.
  • point-in-time=dolor
    • Timestamp, if specified, identifies the time to which the source instance is cloned.
  • preferred-zone=duo
    • Optional. (Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

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

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

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

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").