Images

Represents an Image resource. See the Images documentation for more information.

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

Resource representations

An Image resource.

{
  "kind": "compute#image",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "sourceType": string,
  "rawDisk": {
    "source": string,
    "sha1Checksum": string,
    "containerType": string
  },
  "deprecated": {
    "state": string,
    "replacement": string,
    "deprecated": string,
    "obsolete": string,
    "deleted": string
  },
  "status": string,
  "archiveSizeBytes": long,
  "diskSizeGb": long,
  "sourceDisk": string,
  "sourceDiskId": string,
  "licenses": [
    string
  ],
  "family": string,
  "imageEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "sha256": string
  },
  "sourceDiskEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "sha256": string
  },
  "selfLink": string
}
Property name Value Description Notes
archiveSizeBytes long Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
deprecated nested object The deprecation status associated with this image.
deprecated.deleted string An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
deprecated.deprecated string An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
deprecated.obsolete string An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
deprecated.replacement string The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
deprecated.state string The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
description string An optional description of this resource. Provide this property when you create the resource.
diskSizeGb long Size of the image when restored onto a persistent disk (in GB).
family string The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
imageEncryptionKey nested object Encrypts the image using a customer-supplied encryption key.

After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).

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

If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
imageEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in base64 to either encrypt or decrypt this resource.
imageEncryptionKey.rsaEncryptedKey string Specifies a 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 base64 encoding.
Get the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
imageEncryptionKey.sha256 string [Output only] The base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
kind string [Output Only] Type of the resource. Always compute#image for images.
licenses[] list Any applicable publicly visible licenses.
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.
rawDisk object The parameters of the raw disk image.
rawDisk.containerType string The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
rawDisk.sha1Checksum string An optional SHA1 checksum of the disk image before unpackaging. This is provided by the client when the disk image is created.
rawDisk.source string The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
sourceDisk string URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
  • projects/project/zones/zone/disk/disk
  • zones/zone/disks/disk
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 base64 to either encrypt or decrypt this resource.
sourceDiskEncryptionKey.rsaEncryptedKey string Specifies a 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 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 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceDiskId string The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
sourceType string The type of the image used to create this disk. The default and only value is RAW
status string [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

Methods

An Image resource has the following valid methods:

delete
Deletes the specified image.
deprecate
Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.
get
Returns the specified image. Get a list of available images by making a list() request.
getFromFamily
Returns the latest image that is part of an image family and is not deprecated.
insert
Creates an image in the specified project using the data included in the request.
list
Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Send feedback about...

Compute Engine