Method list

Retrieves the list of Image resources in the specified folder.

HTTP request

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

Query parameters

Parameter Description
folderId Required. ID of the folder to list images in. To get the folder ID, use a list request. The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter A filter expression that filters resources listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on the Image.name field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Must be 3-63 characters long and match the regular expression ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "images": [
    {
      "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"
      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
images[] object

An Image resource.

images[].
id
string

ID of the image.

images[].
folderId
string

ID of the folder that the image belongs to.

images[].
createdAt
string (date-time)

String in RFC3339 text format.

images[].
name
string

Name of the image. 1-63 characters long.

images[].
description
string

Description of the image. 0-256 characters long.

images[].
labels
object

Resource labels as key:value pairs. Maximum of 64 per resource.

images[].
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.

images[].
storageSize
string (int64)

The size of the image, specified in bytes.

images[].
minDiskSize
string (int64)

Minimum size of the disk which will be created from this image.

images[].
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.

images[].
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.
images[].
os
object

Operating system that is contained in the image.

images[].
os.
type
string

Operating system type.

  • LINUX: Linux operating system.
  • WINDOWS: Windows operating system.
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.