Get started
Yandex Compute Cloud

Method list

Written by

Retrieves the list of placement groups in the specified folder.

HTTP request

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

Query parameters

Parameter Description
folderId Required. ID of the folder to list placement groups in. To get the folder ID, use 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. Currently you can use filtering only on the DiskPlacementGroup.name field. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "diskPlacementGroups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "zoneId": "string",
      "status": "string",
      "spreadPlacementStrategy": {}
    }
  ],
  "nextPageToken": "string"
}
Field Description
diskPlacementGroups[] object

Lists placement groups for the specified folder.
diskPlacementGroups[].
id		 string

ID of the placement group.
diskPlacementGroups[].
folderId		 string

ID of the folder that the placement group belongs to.
diskPlacementGroups[].
createdAt		 string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format.
diskPlacementGroups[].
name		 string

Name of the placement group. The name is unique within the folder.
diskPlacementGroups[].
description		 string

Description of the placement group.
diskPlacementGroups[].
labels		 object

Resource labels as key:value pairs.
diskPlacementGroups[].
zoneId		 string

ID of the availability zone where the placement group resides.
diskPlacementGroups[].
status		 string
Current status of the placement group
diskPlacementGroups[].
spreadPlacementStrategy		 object
Distribute instances over distinct failure domains.
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 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.
In this article: