Contact UsGet started

Compute Cloud API, REST: Image.GetLatestByFamily

Written by
Updated at December 17, 2024

Returns the latest image that is part of an image family.

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/images:latestByFamily

Query parameters

Field

Description

folderId

string

Required field. ID of the folder to get the image from.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

family

string

Name of the image family to search for.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "family": "string",
  "storageSize": "string",
  "minDiskSize": "string",
  "productIds": [
    "string"
  ],
  "status": "string",
  "os": {
    "type": "string"
  },
  "pooled": "boolean",
  "hardwareGeneration": {
    // Includes only one of the fields `legacyFeatures`, `generation2Features`
    "legacyFeatures": {
      "pciTopology": "string"
    },
    "generation2Features": "object"
    // end of the list of possible fields
  },
  "kmsKey": {
    "keyId": "string",
    "versionId": "string"
  }
}

An Image resource.

Field

Description

id

string

ID of the image.

folderId

string

ID of the folder that the image belongs to.

createdAt

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the image. 1-63 characters long.

description

string

Description of the image. 0-256 characters long.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

family

string

The name of the image family to which this image belongs.

You can get the most recent image from a family by using
the yandex.cloud.compute.v1.ImageService.GetLatestByFamily request
and create the disk from this image.

storageSize

string (int64)

The size of the image, specified in bytes.

minDiskSize

string (int64)

Minimum size of the disk which will be created from this image.

productIds[]

string

License IDs that indicate which licenses are attached to this resource.
License IDs are used to calculate additional charges for the use of the virtual machine.

The correct license ID is generated by the platform. IDs are inherited by new resources created from this resource.

If you know the license IDs, specify them when you create the image.
For example, if you create a disk image using a third-party utility and load it into Object Storage, the license IDs will be lost.
You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.

status

enum (Status)

Current status of the image.

  • STATUS_UNSPECIFIED
  • CREATING: Image is being created.
  • READY: Image is ready to use.
  • ERROR: Image encountered a problem and cannot operate.
  • DELETING: Image is being deleted.

os

Os

Operating system that is contained in the image.

pooled

boolean

When true, indicates there is an image pool for fast creation disks from the image.

hardwareGeneration

HardwareGeneration

If specified, forces the same HardwareGeneration features to be applied to the instance
created using this image as a source for the boot disk. Otherwise the current default will be used.

kmsKey

KMSKey

Key encryption key info.

Os

Field

Description

type

enum (Type)

Operating system type. The default is LINUX.

This field is used to correctly emulate a vCPU and calculate the cost of using an instance.

  • TYPE_UNSPECIFIED
  • LINUX: Linux operating system.
  • WINDOWS: Windows operating system.

HardwareGeneration

A set of features, specific to a particular Compute hardware generation.
They are not necessary supported by every host OS or distro, thus they are fixed to an image
and are applied to all instances created with it as their boot disk image.
These features significantly determine how the instance is created, thus cannot be changed after the fact.

Field

Description

legacyFeatures

LegacyHardwareFeatures

Includes only one of the fields legacyFeatures, generation2Features.

generation2Features

object

Includes only one of the fields legacyFeatures, generation2Features.

LegacyHardwareFeatures

A first hardware generation, by default compatible with all legacy images.
Allows switching to PCI_TOPOLOGY_V2 and back.

Field

Description

pciTopology

enum (PCITopology)

  • PCI_TOPOLOGY_UNSPECIFIED
  • PCI_TOPOLOGY_V1
  • PCI_TOPOLOGY_V2

KMSKey

Field

Description

keyId

string

ID of KMS symmetric key

versionId

string

Version of KMS symmetric key
Previous
Get
Next
List