REST Resource: images

Resource: Image

Represents an Image resource.

You can use images to create boot disks for your VM instances. For more information, read Images.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "sourceType": enum (ImageType),
  "rawDisk": {
    "source": string,
    "sha1Checksum": string,
    "containerType": enum
  },
  "deprecated": {
    object (DeprecationStatus)
  },
  "status": enum (Status),
  "archiveSizeBytes": string,
  "diskSizeGb": string,
  "sourceDisk": string,
  "sourceDiskId": string,
  "licenses": [
    string
  ],
  "family": string,
  "imageEncryptionKey": {
    object (CustomerEncryptionKey)
  },
  "sourceDiskEncryptionKey": {
    object (CustomerEncryptionKey)
  },
  "selfLink": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "guestOsFeatures": [
    {
      object (GuestOsFeature)
    }
  ],
  "licenseCodes": [
    string
  ],
  "sourceImage": string,
  "sourceImageId": string,
  "sourceImageEncryptionKey": {
    object (CustomerEncryptionKey)
  },
  "sourceSnapshot": string,
  "sourceSnapshotId": string,
  "sourceSnapshotEncryptionKey": {
    object (CustomerEncryptionKey)
  },
  "storageLocations": [
    string
  ],
  "shieldedInstanceInitialState": {
    object (InitialStateConfig)
  },
  "satisfiesPzs": boolean,
  "architecture": enum (Architecture),
  "enableConfidentialCompute": boolean,
  "satisfiesPzi": boolean
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#image

for images.
id

string (uint64 format)

[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.
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.
sourceType

enum (ImageType)

The type of the image used to create this disk. The default and only valid value is

RAW

.
rawDisk

object

The parameters of the raw disk image.
rawDisk.source

string

The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The

    rawDisk.source

    URL

  • The

    sourceDisk

    URL

  • The

    sourceImage

    URL

  • The

    sourceSnapshot

    URL

rawDisk.sha1Checksum
(deprecated)

string

[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
rawDisk.containerType

enum

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

object (DeprecationStatus)

The deprecation status associated with this image.
status

enum (Status)

[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

.
archiveSizeBytes

string (int64 format)

Size of the image

tar.gz

archive stored in Google Cloud Storage (in bytes).
diskSizeGb

string (int64 format)

Size of the image when restored onto a persistent disk (in GB).
sourceDisk

string

URL of the source disk used to create this image. For example, the following are valid values:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The

    rawDisk.source

    URL

  • The

    sourceDisk

    URL

  • The

    sourceImage

    URL

  • The

    sourceSnapshot

    URL

sourceDiskId

string

[Output Only] 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.
licenses[]

string

Any applicable license URI.
family

string

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example,

centos-stream-9

is a publicly available image family. For more information, see Image family best practices.

When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
imageEncryptionKey

object (CustomerEncryptionKey)

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

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
labels

map (key: string, value: string)

Labels to apply to this image. These can be later modified by the

setLabels

method.
labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this image, which is essentially a hash of the labels 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, otherwise the request will fail with error

412 conditionNotMet

.

To see the latest fingerprint, make a

get()

request to retrieve an image.

A base64-encoded string.
guestOsFeatures[]

object (GuestOsFeature)

A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the

guestOSfeatures[].type

parameter.
licenseCodes[]

string (int64 format)

Integer license codes indicating which licenses are attached to this image.
sourceImage

string

URL of the source image used to create this image. The following are valid formats for the URL:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The

    rawDisk.source

    URL

  • The

    sourceDisk

    URL

  • The

    sourceImage

    URL

  • The

    sourceSnapshot

    URL

sourceImageId

string

[Output Only] The ID value of the image 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 image name.
sourceImageEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
sourceSnapshot

string

URL of the source snapshot used to create this image. The following are valid formats for the URL:

In order to create an image, you must provide the full or partial URL of one of the following:

  • The

    rawDisk.source

    URL

  • The

    sourceDisk

    URL

  • The

    sourceImage

    URL

  • The

    sourceSnapshot

    URL

sourceSnapshotId

string

[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.
sourceSnapshotEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
storageLocations[]

string

Cloud Storage bucket storage location of the image (regional or multi-regional).
shieldedInstanceInitialState

object (InitialStateConfig)

Set the secure boot keys of shielded instance.
satisfiesPzs

boolean

[Output Only] Reserved for future use.
architecture

enum (Architecture)

The architecture of the image. Valid values are ARM64 or X86_64.
enableConfidentialCompute

boolean

Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
satisfiesPzi

boolean

Output only. Reserved for future use.

ImageType

Enums
RAW

Status

Enums
PENDING Image hasn't been created as yet.
READY Image has been successfully created.
FAILED Image creation failed due to an error.
DELETING Image is deleting.

Methods

delete

 The method compute.v1.ImagesService.Delete is not available in this (s3nsapis.fr) universe.

deprecate

 The method compute.v1.ImagesService.Deprecate is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.ImagesService.Get is not available in this (s3nsapis.fr) universe.

getFromFamily

 The method compute.v1.ImagesService.GetFromFamily is not available in this (s3nsapis.fr) universe.

getIamPolicy

 The method compute.v1.ImagesService.GetPolicy is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.ImagesService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.ImagesService.List is not available in this (s3nsapis.fr) universe.

patch

 The method compute.v1.ImagesService.Patch is not available in this (s3nsapis.fr) universe.

setIamPolicy

 The method compute.v1.ImagesService.SetPolicy is not available in this (s3nsapis.fr) universe.

setLabels

 The method compute.v1.ImagesService.SetLabels is not available in this (s3nsapis.fr) universe.

testIamPermissions

 The method compute.v1.ImagesService.TestPermissions is not available in this (s3nsapis.fr) universe.