Method create

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": "object",
  "family": "string",
  "minDiskSize": "string",
  "productIds": [
    "string"
  ],
  "os": {
    "type": "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

}
Field Description
folderId string

Required. ID of the folder to create an image in. To get the folder ID, use a list request.

The maximum string length in characters is 50.

name string

Name of the image.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].

description string

Description of the image.

The maximum string length in characters is 256.

labels object

Resource labels as key:value pairs.

No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z].

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 getLatestByFamily request.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].

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.

Acceptable values are 4194304 to 4398046511104, inclusive.

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 Yandex.Cloud. 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 Yandex Object Storage, the license IDs will be lost. You can specify them in this request.

The maximum string length in characters for each value is 50.

os object
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.
os.
type
string

Operating system type. The default is LINUX.

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

  • LINUX: Linux operating system.
  • WINDOWS: Windows operating system.
imageId string
includes only one of the fields imageId, diskId, snapshotId, uri

ID of the source image to create the new image from.

The maximum string length in characters is 50.

diskId string
includes only one of the fields imageId, diskId, snapshotId, uri

ID of the disk to create the image from.

The maximum string length in characters is 50.

snapshotId string
includes only one of the fields imageId, diskId, snapshotId, uri

ID of the snapshot to create the image from.

The maximum string length in characters is 50.

uri string
includes only one of the fields imageId, diskId, snapshotId, uri

URI of the source image to create the new image from. Currently only supports links to images that are stored in Yandex Object Storage. Currently only supports Qcow2, VMDK, and VHD formats.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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.

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.

done boolean (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 object

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 object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response

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

error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

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.