Skip to main content

Get

Returns the specified Image resource.

To get the list of available Image resources, make a List request.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetImageRequest = cloudApi.compute.image_service.GetImageRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ImageServiceClient);

  const result = await client.get(
    GetImageRequest.fromPartial({
      imageId: "imageId",
    })
  );
  console.log(result);
})();

GetImageRequest​

imageId : string​

ID of the Image resource to return. To get the image ID, use a ImageService.List request.

Image​

An Image resource.

Status​

  • 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.

id : string​

ID of the image.

folderId : string​

ID of the folder that the image belongs to.

createdAt : google.protobuf.Timestamp​
name : string​

Name of the image. 1-63 characters long.

description : string​

Description of the image. 0-256 characters long.

labels : 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 : int64​

The size of the image, specified in bytes.

minDiskSize : 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 : Status​

Current status of the image.

os : Os​

Operating system that is contained in the image.

pooled : bool​

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​

Type​
  • TYPE_UNSPECIFIED

  • LINUX

    Linux operating system.

  • WINDOWS

    Windows operating system.

type : 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.

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.

One of features​

  • legacyFeatures : LegacyHardwareFeatures​
  • generation2Features : Generation2HardwareFeatures​

KMSKey​

keyId : string​

ID of KMS symmetric key

versionId : string​

Version of KMS symmetric key

LegacyHardwareFeatures​

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

pciTopology : PCITopology​

Generation2HardwareFeatures​

A second hardware generation, which by default assumes PCI_TOPOLOGY_V2 and UEFI boot (with UEFI related features).