Contact UsGet started

Compute Cloud API, gRPC: DiskPlacementGroupService.List

Written by
Updated at October 17, 2024

Retrieves the list of placement groups in the specified folder.

gRPC request

rpc List (ListDiskPlacementGroupsRequest) returns (ListDiskPlacementGroupsResponse)

ListDiskPlacementGroupsRequest

{
  "folderId": "string",
  "pageSize": "int64",
  "pageToken": "string",
  "filter": "string",
  "orderBy": "string"
}

Field

Description

folderId

string

Required field. ID of the folder to list placement groups in.
To get the folder ID, use yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListDiskPlacementGroupsResponse.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 ListDiskPlacementGroupsResponse.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

ListDiskPlacementGroupsResponse

{
  "diskPlacementGroups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "string",
      "zoneId": "string",
      "status": "Status",
      // Includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
      "spreadPlacementStrategy": "DiskSpreadPlacementStrategy",
      "partitionPlacementStrategy": {
        "partitions": "int64"
      }
      // end of the list of possible fields
    }
  ],
  "nextPageToken": "string"
}

Field

Description

diskPlacementGroups[]

DiskPlacementGroup

Lists placement groups for the specified folder.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListDiskPlacementGroupsRequest.pageSize, use
nextPageToken as the value
for the ListDiskPlacementGroupsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

DiskPlacementGroup

Field

Description

id

string

ID of the placement group.

folderId

string

ID of the folder that the placement group belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp 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.

labels

string

Resource labels as key:value pairs.

zoneId

string

ID of the availability zone where the placement group resides.

status

enum Status

Current status of the placement group

  • STATUS_UNSPECIFIED
  • CREATING
  • READY
  • DELETING

spreadPlacementStrategy

DiskSpreadPlacementStrategy

Distribute disks over distinct failure domains.

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy.

partitionPlacementStrategy

DiskPartitionPlacementStrategy

Distribute disks over partitions.

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy.

DiskSpreadPlacementStrategy

Field

Description

Empty

DiskPartitionPlacementStrategy

Field

Description

partitions

int64
Previous
Get
Next
Create