Compute Cloud API, REST: Image.GetLatestByFamily
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. |
|
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 To work with values in this field, use the APIs described in the |
|
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 |
|
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 |
|
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. 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. |
|
status |
enum (Status) Current status of the image.
|
|
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 |
If specified, forces the same HardwareGeneration features to be applied to the instance |
|
kmsKey |
Key encryption key info. |
Os
|
Field |
Description |
|
type |
enum (Type) Operating system type. The default is This field is used to correctly emulate a vCPU and calculate the cost of using an instance.
|
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 |
Includes only one of the fields |
|
generation2Features |
object Includes only one of the fields |
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)
|
KMSKey
|
Field |
Description |
|
keyId |
string ID of KMS symmetric key |
|
versionId |
string Version of KMS symmetric key |