Method list

Retrieves the list of Disk resources in the specified folder.

HTTP request

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

Query parameters

Parameter Description
folderId Required. ID of the folder to list disks 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 Disk.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

{
  "disks": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "typeId": "string",
      "zoneId": "string",
      "size": "string",
      "productIds": [
        "string"
      ],
      "status": "string",
      "instanceIds": [
        "string"
      ],

      // `disks[]` includes only one of the fields `sourceImageId`, `sourceSnapshotId`
      "sourceImageId": "string",
      "sourceSnapshotId": "string",
      // end of the list of possible fields`disks[]`

    }
  ],
  "nextPageToken": "string"
}
Field Description
disks[] object

A Disk resource. For more information, see Disks.

disks[].
id
string

ID of the disk.

disks[].
folderId
string

ID of the folder that the disk belongs to.

disks[].
createdAt
string (date-time)

String in RFC3339 text format.

disks[].
name
string

Name of the disk. 1-63 characters long.

disks[].
description
string

Description of the disk. 0-256 characters long.

disks[].
labels
object

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

disks[].
typeId
string

ID of the disk type.

disks[].
zoneId
string

ID of the availability zone where the disk resides.

disks[].
size
string (int64)

Size of the disk, specified in bytes.

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

disks[].
status
string
Current status of the disk.
  • CREATING: Disk is being created.
  • READY: Disk is ready to use.
  • ERROR: Disk encountered a problem and cannot operate.
  • DELETING: Disk is being deleted.
disks[].
instanceIds[]
string

Array of instances to which the disk is attached.

disks[].
sourceImageId
string
disks[] includes only one of the fields sourceImageId, sourceSnapshotId

ID of the image that was used for disk creation.

disks[].
sourceSnapshotId
string
disks[] includes only one of the fields sourceImageId, sourceSnapshotId

ID of the snapshot that was used for disk creation.

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.