Compute Cloud API, REST: DiskPlacementGroup.listDisks
Lists disks for the specified placement group.
HTTP request
GET https://compute.api.il.nebius.cloud/compute/v1/diskPlacementGroups/{diskPlacementGroupId}/disks
Path parameters
| Parameter | Description |
|---|---|
| diskPlacementGroupId | Required. ID of the placement group to list disks for. To get the placement group ID, use list request. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| 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. |
Response
HTTP Code: 200 - OK
{
"disks": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"typeId": "string",
"zoneId": "string",
"size": "string",
"blockSize": "string",
"productIds": [
"string"
],
"status": "string",
"instanceIds": [
"string"
],
"diskPlacementPolicy": {
"placementGroupId": "string",
"placementGroupPartition": "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 Lists disks for the specified placement group. |
| 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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
| 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 |
| 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[]. blockSize |
string (int64) Block 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 the platform. 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 Object Storage, the license IDs will be lost. You can specify them in the create request. |
| disks[]. status |
string Current status of the disk.
|
| disks[]. instanceIds[] |
string Array of instances to which the disk is attached. |
| disks[]. diskPlacementPolicy |
object Placement policy configuration. |
| disks[]. diskPlacementPolicy. placementGroupId |
string Placement group ID. |
| disks[]. diskPlacementPolicy. placementGroupPartition |
string (int64) |
| disks[]. sourceImageId |
string disks[] includes only one of the fields sourceImageId, sourceSnapshotIdID of the image that was used for disk creation. |
| disks[]. sourceSnapshotId |
string disks[] includes only one of the fields sourceImageId, sourceSnapshotIdID 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 more than pageSize, use 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. |