Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



Snapshots

Represents a Persistent Disk Snapshot resource. See the Persistent Disk Snapshots documentation for more information.

For a list of methods for this resource, see the end of this page.

Resource representations

A Persistent Disk snapshot resource.

{
  "kind": "compute#snapshot",
  "selfLink": string,
  "id": unsigned long,
  "creationTimestamp": string,
  "status": string,
  "diskSizeGb": long,
  "sourceDisk": string,
  "name": string,
  "description": string,
  "sourceDiskId": string,
  "storageBytes": long,
  "storageBytesStatus": string,
  "licenses": [
    string
  ]
}
Property name Value Description Notes
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional textual description of the resource; provided by the client when the resource is created.
diskSizeGb long [Output Only] Size of the persistent disk snapshot, specified in GB.
id unsigned long [Output Only] Unique identifier for the resource, defined by the server.
kind string [Output Only] Type of the resource. Always compute#snapshot .
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).
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.
sourceDisk string [Output Only] The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
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.
status string [Output Only] The status of the persistent disk snapshot.

Acceptable values are:
  • " CREATING ": The snapshot is currently being created.
  • " DELETING ": The snapshot is being deleted.
  • " FAILED ":  Taking the snapshot has failed.
  • " READY ": The snapshot is ready to use.
  • " UPLOADING ": The snapshot is currently being uploaded.
storageBytes long [Output Only] A size of 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.

Acceptable values are:
  • " UPDATING ": The size of this snapshot is being updated.
  • " UP_TO_DATE ": The size of this snapshot is up-to-date.

Methods

The following are valid Snapshot resource methods:

delete
Deletes the specified persistent disk snapshot resource.
get
Returns the specified persistent disk snapshot resource.
list
Retrieves the list of persistent disk snapshot resources contained within the specified project.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.