Cloud Desktop API, gRPC: DesktopGroupService.List

Статья создана

Yandex Cloud

Обновлена 30 октября 2025 г.

gRPC request
ListDesktopGroupsRequest
ListDesktopGroupsResponse
DesktopGroup
ResourcesSpec
NetworkInterfaceSpec
DiskSpec
DesktopGroupConfiguration
Subject
AutoUpdatePolicy
ManualUpdatePolicy

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: The field name. Currently you can use filtering only on DesktopGroup.name field. An operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 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>",
      "boot_disk_spec": {
        "type": "Type",
        "size": "int64"
      },
      "data_disk_spec": {
        "type": "Type",
        "size": "int64"
      },
      "group_config": {
        "min_ready_desktops": "int64",
        "max_desktops_amount": "int64",
        "desktop_type": "DesktopType",
        "members": [
          {
            "id": "string",
            "type": "string"
          }
        ]
      },
      // Includes only one of the fields `auto_update_policy`, `manual_update_policy`
      "auto_update_policy": "AutoUpdatePolicy",
      "manual_update_policy": "ManualUpdatePolicy"
      // end of the list of possible fields
    }
  ],
  "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. `UPDATING`: Desktop group is updating.
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.
boot_disk_spec	DiskSpec Boot disk specification of the desktop group.
data_disk_spec	DiskSpec Data disk specification of the desktop group.
group_config	DesktopGroupConfiguration Desktop group configuration.
auto_update_policy	AutoUpdatePolicy Includes only one of the fields `auto_update_policy`, `manual_update_policy`. Desktop group update policy.
manual_update_policy	ManualUpdatePolicy Includes only one of the fields `auto_update_policy`, `manual_update_policy`. Desktop group update policy.

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.

DiskSpec

Disk specificaton.

Field

Description

type

enum Type

Required field. Type of disk.

TYPE_UNSPECIFIED: Disk type is not specified.
HDD: HDD disk type.
SSD: SSD disk type.

size

int64

Size of disk.

DesktopGroupConfiguration

Field	Description
min_ready_desktops	int64 Minimum number of ready desktops.
max_desktops_amount	int64 Maximum number of desktops.
desktop_type	enum DesktopType Type of the desktop. `DESKTOP_TYPE_UNSPECIFIED` `PERSISTENT` `NON_PERSISTENT`
members[]	Subject List of members of the desktop group.

Subject

Field

Description

string

Required field. ID of the subject.

It can contain one of the following values:

allAuthenticatedUsers: A special public group that represents anyone
who is authenticated. It can be used only if the type is system.
allUsers: A special public group that represents anyone. No authentication is required.
For example, you don't need to specify the IAM token in an API query.
It can be used only if the type is system.
group:organization:<id>:users: A special system group that represents all members of organization
with given <id>. It can be used only if the type is system.
group:federation:<id>:users: A special system group that represents all users of federation
with given <id>. It can be used only if the type is system.
<cloud generated id>: An identifier that represents a user account.
It can be used only if the type is userAccount, federatedUser or serviceAccount.

type

string

Required field. Type of the subject.

It can contain one of the following values:

userAccount: An account on Yandex or Yandex Connect, added to Yandex Cloud.
serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource.
federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.
system: System group. This type represents several accounts with a common system identifier.

For more information, see Subject to which the role is assigned.

AutoUpdatePolicy

Field	Description
Empty

ManualUpdatePolicy

Field	Description
Empty

Cloud Desktop API, gRPC: DesktopGroupService.List

gRPC requestgRPC request

ListDesktopGroupsRequestListDesktopGroupsRequest

ListDesktopGroupsResponseListDesktopGroupsResponse

DesktopGroupDesktopGroup

ResourcesSpecResourcesSpec

NetworkInterfaceSpecNetworkInterfaceSpec

DiskSpecDiskSpec

DesktopGroupConfigurationDesktopGroupConfiguration

SubjectSubject

AutoUpdatePolicyAutoUpdatePolicy

ManualUpdatePolicyManualUpdatePolicy

Была ли статья полезна?

gRPC request

ListDesktopGroupsRequest

ListDesktopGroupsResponse

DesktopGroup

ResourcesSpec

NetworkInterfaceSpec

DiskSpec

DesktopGroupConfiguration

Subject

AutoUpdatePolicy

ManualUpdatePolicy