Compute Cloud API, gRPC: PlacementGroupService.List

Field

Description

folder_id

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.

The maximum string length in characters is 50.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListPlacementGroupsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.

page_token

string

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

The maximum string length in characters is 100.

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

The maximum string length in characters is 1000.

order_by

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

The maximum string length in characters is 100.

Field

Description

placement_groups[]

PlacementGroup

Lists placement groups in the specified folder.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListPlacementGroupsRequest.page_size, use next_page_token as the value
for the ListPlacementGroupsRequest.page_token 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.

folder_id

string

ID of the folder that the placement group belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

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 (map<string, string>)

Placement group labels as key:value pairs.

spread_placement_strategy

SpreadPlacementStrategy

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

Includes only one of the fields spread_placement_strategy, partition_placement_strategy.

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

partition_placement_strategy

PartitionPlacementStrategy

Includes only one of the fields spread_placement_strategy, partition_placement_strategy.

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

Field

Description

Empty

Field

Description

partitions

int64

Acceptable values are 2 to 5, inclusive.