Method 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

Parameter Description
placementGroupId ID of the placement group to return. To get a placement group ID make a list request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "spreadPlacementStrategy": {}
}
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.

name string

Name of the placement group. The name is unique within the folder.

description string

Description of the placement group. 0-256 characters long.

labels object

Placement group labels as key:value pairs.

spreadPlacementStrategy object
Anti-affinity placement strategy (spread). Instances are distributed over distinct failure domains.

This is an empty structure that must be passed to explicitly specify the required placement strategy.