GOgoogle
images

GET /projects/{project}/global/images/family/{family}

Changed on

Returns the latest image that is part of an image family and is not deprecated. For more information on image families, seePublic image families documentation.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/global/images/family/{family}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute.readonly

Path parameters

projectstring required

The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project.

familystring required

Name of the image family to search for.

Response

Successful response

architecture'ARCHITECTURE_UNSPECIFIED' | 'ARM64' | 'X86_64'

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

archiveSizeBytesstring int64

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

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

descriptionstring

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

diskSizeGbstring int64

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

enableConfidentialComputeboolean

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

familystring

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.

idstring uint64

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

kindstring

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

labelFingerprintstring byte

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an image.

labelsobject

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

licenseCodesstring[]

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

licensesstring[]

Any applicable license URI.

namestring

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. [Output Only] Reserved for future use.

selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

sourceDiskstring

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
sourceDiskIdstring

Output only. [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.

sourceImagestring

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
sourceImageIdstring

Output only. [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.

sourceSnapshotstring

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
sourceSnapshotIdstring

Output only. [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.

sourceType'RAW'

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

status'DELETING' | 'FAILED' | 'PENDING' | 'READY'

Output only. [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, orREADY.

storageLocationsstring[]

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

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c