Method get

Статья создана

HTTP request
Path parameters
Response

Returns the specified Image resource.

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

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/images/{imageId}

Path parameters

Parameter	Description
imageId	Required. ID of the Image resource to return. To get the image ID, use a list request. The maximum string length in characters is 50.

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

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.
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 `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 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. 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	object Operating system that is contained in the image.
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.