Image
A set of methods for managing Image resources.
JSON Representation
{
"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": true
}
| 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. |
| name | string Name of the image. 1-63 characters long. |
| description | string Description of the image. 0-256 characters long. |
| labels | object 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 the 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 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 the create request. |
| status | string Current status of the image.
|
| os | object Operating system that is contained in the image. |
| os. type |
string Operating system type. The default is This field is used to correctly emulate a vCPU and calculate the cost of using an instance.
|
| pooled | boolean (boolean) When true, indicates there is an image pool for fast creation disks from the image. |
Methods
| Method | Description |
|---|---|
| create | Creates an image in the specified folder. |
| delete | Deletes the specified image. |
| get | Returns the specified Image resource. |
| getLatestByFamily | Returns the latest image that is part of an image family. |
| list | Retrieves the list of Image resources in the specified folder. |
| listOperations | Lists operations for the specified image. |
| update | Updates the specified image. |