- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
Retrieves 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
.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/images
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example, |
orderBy |
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 Currently, only sorting by |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "sourceType": enum, "rawDisk": { "source": string, "sha1Checksum": string, "containerType": enum }, "deprecated": { "state": enum, "replacement": string, "deprecated": string, "obsolete": string, "deleted": string }, "status": enum, "archiveSizeBytes": string, "diskSizeGb": string, "sourceDisk": string, "sourceDiskId": string, "licenses": [ string ], "family": string, "imageEncryptionKey": { "sha256": string, "rawKey": string, "kmsKeyName": string }, "sourceDiskEncryptionKey": { "sha256": string, "rawKey": string, "kmsKeyName": string }, "selfLink": string, "labels": { object }, "labelFingerprint": string, "guestOsFeatures": [ { "type": enum } ], "licenseCodes": [ string ], "sourceImage": string, "sourceImageId": string, "sourceImageEncryptionKey": { "sha256": string, "rawKey": string, "kmsKeyName": string }, "sourceSnapshot": string, "sourceSnapshotId": string, "sourceSnapshotEncryptionKey": { "sha256": string, "rawKey": string, "kmsKeyName": string }, "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of Image resources. |
items[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].name |
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 |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].sourceType |
The type of the image used to create this disk. The default and only value is |
items[].rawDisk |
The parameters of the raw disk image. |
items[].rawDisk.source |
The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the |
items[].rawDisk.sha1Checksum |
[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.containerType |
The format used to encode and transmit the block device, which should be |
items[].deprecated |
The deprecation status associated with this image. |
items[].deprecated.state |
The deprecation state of this resource. This can be |
items[].deprecated.replacement |
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.deprecated |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
items[].deprecated.obsolete |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
items[].deprecated.deleted |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
items[].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 |
items[].archiveSizeBytes |
Size of the image |
items[].diskSizeGb |
Size of the image when restored onto a persistent disk (in GB). |
items[].sourceDisk |
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
|
items[].sourceDiskId |
[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[].licenses[] |
Any applicable license URI. |
items[].family |
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[].imageEncryptionKey |
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. |
items[].imageEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].imageEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].imageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].sourceDiskEncryptionKey |
The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. |
items[].sourceDiskEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].sourceDiskEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].sourceDiskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].labels |
Labels to apply to this image. These can be later modified by the An object containing a list of |
items[].labelFingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
items[].guestOsFeatures[] |
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
items[].guestOsFeatures[].type |
The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
items[].licenseCodes[] |
Integer license codes indicating which licenses are attached to this image. |
items[].sourceImage |
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:
|
items[].sourceImageId |
[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[].sourceImageEncryptionKey |
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
items[].sourceImageEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].sourceImageEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].sourceImageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].sourceSnapshot |
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:
|
items[].sourceSnapshotId |
[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[].sourceSnapshotEncryptionKey |
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. |
items[].sourceSnapshotEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].sourceSnapshotEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].sourceSnapshotEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].kind |
[Output Only] Type of the resource. Always |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
kind |
Type of resource. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:
compute.images.list