Contact UsGet started

Cloud Desktop API, gRPC: DesktopGroupService.List

Written by
Updated at April 24, 2025

Retrieves the list of desktop group resources.

gRPC request

rpc List (ListDesktopGroupsRequest) returns (ListDesktopGroupsResponse)

ListDesktopGroupsRequest

{
  "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 desktop groups in.

To get the folder ID use 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 ListDesktopGroupsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

page_token

string

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

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can use filtering only on DesktopGroup.name field.
  2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
  3. Value or a list of values to compare against the values of the field.

order_by

string

Sorting the list by DesktopGroup.name, DesktopGroup.created_at and DesktopGroup.status fields.
The default sorting order is ascending.

ListDesktopGroupsResponse

{
  "desktop_groups": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "status": "Status",
      "name": "string",
      "description": "string",
      "resources_spec": {
        "memory": "int64",
        "cores": "int64",
        "core_fraction": "int64"
      },
      "network_interface_spec": {
        "network_id": "string",
        "subnet_ids": [
          "string"
        ]
      },
      "labels": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

desktop_groups[]

DesktopGroup

List of desktop groups.

next_page_token

string

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

DesktopGroup

A desktop group resource.

Field

Description

id

string

Desktop group ID.

folder_id

string

ID of the folder that the desktop group belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

status

enum Status

Status of the desktop group.

  • STATUS_UNSPECIFIED
  • CREATING: Desktop group is being created.
  • ACTIVE: Desktop group is ready to use.
  • DELETING: Desktop group is being deleted.

name

string

Name of the desktop group.

description

string

Description of the desktop group.

resources_spec

ResourcesSpec

Resource specification of the desktop group.

network_interface_spec

NetworkInterfaceSpec

Network interface specification of the desktop group.

labels

object (map<string, string>)

Labels of the desktop group.

ResourcesSpec

Field

Description

memory

int64

RAM volume, in bytes.

cores

int64

Number of CPU cores.

core_fraction

int64

Baseline level of CPU performance with the ability to burst performance above that baseline level.
This field sets baseline performance for each core.

NetworkInterfaceSpec

Field

Description

network_id

string

Required field. ID of the network interface specification.

subnet_ids[]

string

List of subnet IDs.
Previous
Get
Next
ListDesktops