Compute Cloud API, REST: PlacementGroup.Get
Returns the specified placement group.
To get the list of all available placement groups, make a List request.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/placementGroups/{placementGroupId}
Path parameters
|
Field |
Description |
|
placementGroupId |
string Required field. ID of the placement group to return. To get a placement group ID make a PlacementGroupService.List request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
// Includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
"spreadPlacementStrategy": "object",
"partitionPlacementStrategy": {
"partitions": "string"
}
// end of the list of possible fields
}
|
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 text format. The range of possible values is from 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 |
object (map<string, 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) |