Creates a new backup run on demand. This method is applicable only to Second Generation instances.

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: sql1-beta4 --scope <scope> backup-runs insert ...

Required Scalar Arguments

  • <project> (string)
    • Project ID of the project that contains the instance.
  • <instance> (string)
    • Cloud SQL instance ID. 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:

BackupRun:
  description: string
  disk-encryption-configuration:
    kind: string
    kms-key-name: string
  disk-encryption-status:
    kind: string
    kms-key-version-name: string
  end-time: string
  enqueued-time: string
  error:
    code: string
    kind: string
    message: string
  id: string
  instance: string
  kind: string
  location: string
  self-link: string
  start-time: string
  status: string
  type: string
  window-start-time: 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 . description=et
    • The description of this run, only applicable to on-demand backups.
  • disk-encryption-configuration kind=magna
    • This is always <code>sql#diskEncryptionConfiguration</code>.

  • kms-key-name=no

    • Resource name of KMS key for disk encryption

  • ..disk-encryption-status kind=ipsum

    • This is always <code>sql#diskEncryptionStatus</code>.

  • kms-key-version-name=voluptua.

    • KMS key version used to encrypt the Cloud SQL instance resource

  • .. end-time=at

    • The time the backup operation completed in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>.
  • enqueued-time=sanctus
    • The time the run was enqueued in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>.
  • error code=sed
    • Identifies the specific error that occurred.
  • kind=amet.
    • This is always <code>sql#operationError</code>.

  • message=takimata

    • Additional information about the error encountered.

  • .. id=amet.

    • The identifier for this backup run. Unique only for a specific Cloud SQL instance.
  • instance=duo
    • Name of the database instance.
  • kind=ipsum
    • This is always <code>sql#backupRun</code>.
  • location=gubergren
    • Location of the backups.
  • self-link=lorem
    • The URI of this resource.
  • start-time=gubergren
    • The time the backup operation actually started in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>.
  • status=eos
    • The status of this run.
  • type=dolor
    • The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
  • window-start-time=ea
    • The start time of the backup window during which this the backup was attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>.

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").