Compute Cloud API, REST: PlacementGroup.List

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
results is larger than pageSize,
the service returns a ListPlacementGroupsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results,
set pageToken to the ListPlacementGroupsResponse.nextPageToken
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].

Each condition has the form <field> <operator> <value>, where:

1. <field> is the field name. Currently you can use filtering only on the limited number of fields.
2. <operator> is a logical operator, one of =, !=, IN, NOT IN.
3. <value> represents a value.
   String values should be written in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash).

orderBy

string

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

Field

Description

placementGroups[]

PlacementGroup

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
the specified ListPlacementGroupsRequest.pageSize, use next_page_token as the value
for the ListPlacementGroupsRequest.pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

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

string

Placement group labels as key:value pairs.

spreadPlacementStrategy

object

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

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy. To specify a placement strategy, send the corresponding
field containing approriate structure.

partitionPlacementStrategy

PartitionPlacementStrategy

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy. To specify a placement strategy, send the corresponding
field containing approriate structure.

Field

Description

partitions

string (int64)