project STRING Required

Project ID for this request

filter STRING

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

maxResults INTEGER

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

orderBy STRING

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported

pageToken STRING

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results

id STRING

[Output Only] Unique identifier for the resource; defined by the server

items[] OBJECT

Represents an Image resource.

You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==)

items[].archiveSizeBytes INTEGER

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes)

items[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items[].deprecated OBJECT

Deprecation status for a public resource

items[].deprecated.deleted STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it

items[].deprecated.deprecated STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it

items[].deprecated.obsolete STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it

items[].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

items[].deprecated.state ENUMERATION

The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. 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

items[].description STRING

An optional description of this resource. Provide this property when you create the resource

items[].diskSizeGb INTEGER

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

items[].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. The name of the image family must comply with RFC1035

items[].guestOsFeatures[] OBJECT

Guest OS features

items[].guestOsFeatures[].type ENUMERATION

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options

items[].id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

items[].imageEncryptionKey OBJECT

Represents a customer-supplied encryption key

items[].imageEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

items[].imageEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

items[].imageEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

items[].kind STRING

[Output Only] Type of the resource. Always compute#image for images

items[].labelFingerprint BINARY

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

items[].labels OBJECT

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

items[].labels.customKey.value STRING

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

items[].licenseCodes[] INTEGER

items[].licenses[] STRING

items[].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

items[].rawDisk OBJECT

The parameters of the raw disk image

items[].rawDisk.containerType ENUMERATION

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

items[].rawDisk.sha1Checksum 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

items[].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

items[].selfLink STRING

[Output Only] Server-defined URL for the resource

items[].sourceDisk STRING

URL of 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/disks/disk
• projects/project/zones/zone/disks/disk
• zones/zone/disks/disk

items[].sourceDiskEncryptionKey OBJECT

Represents a customer-supplied encryption key

items[].sourceDiskEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

items[].sourceDiskEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

items[].sourceDiskEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

items[].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

items[].sourceImage STRING

URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

• this property, or
• the rawDisk.source property, or
• the sourceDisk property in order to create an image.

items[].sourceImageEncryptionKey OBJECT

Represents a customer-supplied encryption key

items[].sourceImageEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

items[].sourceImageEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

items[].sourceImageEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

items[].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

items[].sourceSnapshot STRING

URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

• this property, or
• the sourceImage property, or
• the rawDisk.source property, or
• the sourceDisk property in order to create an image.

items[].sourceSnapshotEncryptionKey OBJECT

Represents a customer-supplied encryption key

items[].sourceSnapshotEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

items[].sourceSnapshotEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

items[].sourceSnapshotEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

items[].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

items[].sourceType ENUMERATION

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

items[].status ENUMERATION

[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

kind STRING

Type of resource

nextPageToken STRING

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warning.data[] OBJECT

warning.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)

warning.data[].value STRING

[Output Only] A warning data value corresponding to the key

warning.message STRING

[Output Only] A human-readable description of the warning code