Compute Cloud API, REST: PlacementGroup.list
Retrieves the list of placement groups in the specified folder.
HTTP request
GET https://compute.api.il.nebius.cloud/compute/v1/placementGroups
Query parameters
| Parameter | Description |
|---|---|
| folderId | Required. ID of the folder to list placement groups in. To get the folder ID make a 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. The expression consists of one or more conditions united by Each condition has the form
The maximum string length in characters is 1000. |
| orderBy | By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. The default sorting order is ascending The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"placementGroups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
// `placementGroups[]` includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
"spreadPlacementStrategy": {},
"partitionPlacementStrategy": {
"partitions": "string"
},
// end of the list of possible fields`placementGroups[]`
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| placementGroups[] | object Lists placement groups in the specified folder. |
| placementGroups[]. id |
string ID of the placement group. Generated at creation time. |
| placementGroups[]. folderId |
string ID of the folder that the placement group belongs to. |
| placementGroups[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
| placementGroups[]. name |
string Name of the placement group. The name is unique within the folder. |
| placementGroups[]. description |
string Description of the placement group. 0-256 characters long. |
| placementGroups[]. labels |
object Placement group labels as |
| placementGroups[]. spreadPlacementStrategy |
object Anti-affinity placement strategy ( spread). Instances are distributed over distinct failure domains. placementGroups[] includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy |
| placementGroups[]. partitionPlacementStrategy |
object placementGroups[] includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy |
| placementGroups[]. partitionPlacementStrategy. partitions |
string (int64) Acceptable values are 2 to 5, inclusive. |
| nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |