Disks: createSnapshot

Requires authorization

Creates a snapshot of a specified persistent disk.

Request

HTTP request

POST https://www.googleapis.com/compute/beta/projects/project/zones/zone/disks/disk/createSnapshot

Parameters

Parameter name Value Description
Path parameters
disk string Name of the persistent disk to snapshot.
project string Project ID for this request.
zone string The name of the zone for this request.
Optional query parameters
guestFlush boolean
requestId string An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

In the request body, supply data with the following structure:

{
  "kind": "compute#snapshot",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": string,
  "sourceDisk": string,
  "sourceDiskId": string,
  "diskSizeGb": long,
  "storageBytes": long,
  "storageBytesStatus": string,
  "licenses": [
    string
  ],
  "snapshotEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "sha256": string
  },
  "sourceDiskEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "sha256": string
  },
  "selfLink": string,
  "labels": {
    (key): string
  },
  "labelFingerprint": bytes
}
Property name Value Description Notes
kind string [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
status string [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
diskSizeGb long [Output Only] Size of the snapshot, specified in GB.
sourceDisk string [Output Only] The source disk used to create this snapshot.
name string Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description string An optional description of this resource. Provide this property when you create the resource.
sourceDiskId string [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
storageBytes long [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
storageBytesStatus string [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
licenses[] list [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
snapshotEncryptionKey nested object Encrypts the snapshot using a customer-supplied encryption key.

After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.

Customer-supplied encryption keys do not protect access to metadata of the disk.

If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
snapshotEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
snapshotEncryptionKey.rsaEncryptedKey string Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:
  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Get the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
snapshotEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceDiskEncryptionKey nested object The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
sourceDiskEncryptionKey.rsaEncryptedKey string Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:
  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Get the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
sourceDiskEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
labels object Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
labels.(key) string
labelFingerprint bytes A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a get() request to retrieve a snapshot.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "compute#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string
}
Property name Value Description Notes
kind string [Output Only] Type of the resource. Always compute#operation for Operation resources.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp string [Deprecated] This field is deprecated.
name string [Output Only] Name of the resource.
zone string [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
clientOperationId string [Output Only] Reserved for future use.
operationType string [Output Only] The type of operation, such as insert, update, or delete, and so on.
targetId unsigned long [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
status string [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage string [Output Only] An optional textual description of the current status of the operation.
user string [Output Only] User who requested the operation, for example: user@example.com.
progress integer [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
insertTime string [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
startTime string [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime string [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error object [Output Only] If errors are generated during processing of the operation, this field will be populated.
error.errors[] list [Output Only] The array of errors encountered while processing this operation.
error.errors[].code string [Output Only] The error type identifier for this error.
error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message string [Output Only] An optional, human-readable error message.
warnings[] list [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
warnings[].code string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warnings[].message string [Output Only] A human-readable description of the warning code.
warnings[].data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[].key string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warnings[].data[].value string [Output Only] A warning data value corresponding to the key.
httpErrorStatusCode integer [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
httpErrorMessage string [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
region string [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
description string [Output Only] A textual description of the operation, which is set when the operation is created.

Send feedback about...

Compute Engine