Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Compute Cloud
  • Yandex Container Solution
  • Access management
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • ListInstances
        • ListOperations
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • gRPC request
  • ListPlacementGroupsRequest
  • ListPlacementGroupsResponse
  • PlacementGroup
  • SpreadPlacementStrategy
  • PartitionPlacementStrategy
  1. API reference
  2. gRPC
  3. PlacementGroup
  4. List

Compute Cloud API, gRPC: PlacementGroupService.List

Written by
Yandex Cloud
Updated at December 17, 2024
  • gRPC request
  • ListPlacementGroupsRequest
  • ListPlacementGroupsResponse
  • PlacementGroup
  • SpreadPlacementStrategy
  • PartitionPlacementStrategy

Retrieves the list of placement groups in the specified folder.

gRPC requestgRPC request

rpc List (ListPlacementGroupsRequest) returns (ListPlacementGroupsResponse)

ListPlacementGroupsRequestListPlacementGroupsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "order_by": "string"
}

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.

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.

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.

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

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

ListPlacementGroupsResponseListPlacementGroupsResponse

{
  "placement_groups": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      // Includes only one of the fields `spread_placement_strategy`, `partition_placement_strategy`
      "spread_placement_strategy": "SpreadPlacementStrategy",
      "partition_placement_strategy": {
        "partitions": "int64"
      }
      // end of the list of possible fields
    }
  ],
  "next_page_token": "string"
}

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.

PlacementGroupPlacementGroup

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.

SpreadPlacementStrategySpreadPlacementStrategy

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

Field

Description

Empty

PartitionPlacementStrategyPartitionPlacementStrategy

Field

Description

partitions

int64

Was the article helpful?

Previous
Get
Next
Create
Yandex project
© 2025 Yandex.Cloud LLC