Compute Cloud API, REST: Image.Create

Written by

Yandex Cloud

Improved by

amatol

Updated at October 28, 2024

HTTP request
Body parameters
Os
HardwareGeneration
LegacyHardwareFeatures
Response
CreateImageMetadata
Status
Image
Os
HardwareGeneration
LegacyHardwareFeatures
KMSKey

Creates an image in the specified folder.

You can create an image from a disk, snapshot, other image or URI.
Method starts an asynchronous operation that can be cancelled while it is in progress.

HTTP request

POST https://compute.api.cloud.yandex.net/compute/v1/images

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "family": "string",
  "minDiskSize": "string",
  "productIds": [
    "string"
  ],
  // Includes only one of the fields `imageId`, `diskId`, `snapshotId`, `uri`
  "imageId": "string",
  "diskId": "string",
  "snapshotId": "string",
  "uri": "string",
  // end of the list of possible fields
  "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
  }
}

Field	Description
folderId	string Required field. ID of the folder to create an image in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the image.
description	string Description of the image.
labels	string Resource labels as `key:value` pairs.
family	string The name of the image family to which this image belongs. For more information, see Image family. To get an information about the most recent image from a family, use a ImageService.GetLatestByFamily request.
minDiskSize	string (int64) Minimum size of the disk that will be created from this image. Specified in bytes. Should be more than the volume of source data.
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 this request.
imageId	string ID of the source image to create the new image from. Includes only one of the fields `imageId`, `diskId`, `snapshotId`, `uri`.
diskId	string ID of the disk to create the image from. Includes only one of the fields `imageId`, `diskId`, `snapshotId`, `uri`.
snapshotId	string ID of the snapshot to create the image from. Includes only one of the fields `imageId`, `diskId`, `snapshotId`, `uri`.
uri	string URI of the source image to create the new image from. Currently only supports links to images that are stored in Object Storage. Currently only supports Qcow2, VMDK, and RAW formats. Includes only one of the fields `imageId`, `diskId`, `snapshotId`, `uri`.
os	Os Operating system that is contained in the image. If not specified and you used the `image_id` or `disk_id` field to set the source, then the value can be inherited from the source resource.
pooled	boolean When true, an image pool will be created for fast creation disks from the image.
hardwareGeneration	HardwareGeneration Specify the overrides to hardware_generation of a source disk, image or snapshot, or to the default values if the source does not define it.

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.

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

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "imageId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "string",
    "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"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. 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).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. 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).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CreateImageMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Image The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CreateImageMetadata

Field

Description

imageId

string

ID of the image that is being created.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Image

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

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

Compute Cloud API, REST: Image.Create

HTTP requestHTTP request

Body parametersBody parameters

OsOs

HardwareGenerationHardwareGeneration

LegacyHardwareFeaturesLegacyHardwareFeatures

ResponseResponse

CreateImageMetadataCreateImageMetadata

StatusStatus

ImageImage

OsOs

HardwareGenerationHardwareGeneration

LegacyHardwareFeaturesLegacyHardwareFeatures

KMSKeyKMSKey

Was the article helpful?

HTTP request

Body parameters

Os

HardwareGeneration

LegacyHardwareFeatures

Response

CreateImageMetadata

Status

Image

Os

HardwareGeneration

LegacyHardwareFeatures

KMSKey