Skip to main content

images

Overview

Nameimages
TypeResource
Idgoogle.compute.images

Fields

NameDatatypeDescription
idstring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName 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.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
selfLinkstring[Output Only] Server-defined URL for the resource.
sourceImagestringURL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name 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
sourceImageIdstring[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.
guestOsFeaturesarrayA 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.
kindstring[Output Only] Type of the resource. Always compute#image for images.
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
sourceImageEncryptionKeyobject
statusstring[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.
sourceSnapshotEncryptionKeyobject
licenseCodesarrayInteger license codes indicating which licenses are attached to this image.
architecturestringThe architecture of the image. Valid values are ARM64 or X86_64.
diskSizeGbstringSize of the image when restored onto a persistent disk (in GB).
sourceSnapshotstringURL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name 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
licensesarrayAny applicable license URI.
shieldedInstanceInitialStateobjectInitial State for shielded instance, these are public keys which are safe to store in public
rawDiskobjectThe parameters of the raw disk image.
satisfiesPzsboolean[Output Only] Reserved for future use.
labelsobjectLabels to apply to this image. These can be later modified by the setLabels method.
sourceDiskIdstring[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.
imageEncryptionKeyobject
storageLocationsarrayCloud Storage bucket storage location of the image (regional or multi-regional).
sourceDiskEncryptionKeyobject
deprecatedobjectDeprecation status for a public resource.
familystringThe 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.
sourceTypestringThe type of the image used to create this disk. The default and only valid value is RAW.
sourceDiskstringURL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk 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
archiveSizeBytesstringSize of the image tar.gz archive stored in Google Cloud Storage (in bytes).
sourceSnapshotIdstring[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.
labelFingerprintstringA 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.

Methods

NameAccessible byRequired ParamsDescription
getSELECTimage, projectReturns the specified image.
listSELECTprojectRetrieves the list of custom images available to the specified project. Custom 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.
insertINSERTprojectCreates an image in the specified project using the data included in the request.
deleteDELETEimage, projectDeletes the specified image.
deprecateEXECimage, projectSets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
patchEXECimage, projectPatches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
set_labelsEXECproject, resourceSets the labels on an image. To learn more about labels, read the Labeling Resources documentation.