Compute Cloud API, REST: PlacementGroup.List
Retrieves the list of placement groups in the specified folder.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/placementGroups
Query parameters
Field |
Description |
folderId |
string Required field. ID of the folder to list placement groups in. To get the folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, |
filter |
string A filter expression that filters resources listed in the response. Each condition has the form
|
orderBy |
string By which column the listing should be ordered and in which direction, |
Response
HTTP Code: 200 - OK
{
"placementGroups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
// Includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
"spreadPlacementStrategy": "object",
"partitionPlacementStrategy": {
"partitions": "string"
}
// end of the list of possible fields
}
],
"nextPageToken": "string"
}
Field |
Description |
placementGroups[] |
Lists placement groups in the specified folder. |
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
PlacementGroup
Field |
Description |
id |
string ID of the placement group. Generated at creation time. |
folderId |
string ID of the folder that the placement group belongs to. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the placement group. |
description |
string Description of the placement group. 0-256 characters long. |
labels |
string Placement group labels as |
spreadPlacementStrategy |
object Anti-affinity placement strategy ( Includes only one of the fields Placement strategy. To specify a placement strategy, send the corresponding |
partitionPlacementStrategy |
Includes only one of the fields Placement strategy. To specify a placement strategy, send the corresponding |
PartitionPlacementStrategy
Field |
Description |
partitions |
string (int64) |