Связаться с намиПодключиться

Cloud Desktop API, gRPC: DesktopGroupService.Get

Статья создана
Обновлена 3 октября 2025 г.

Returns the specified desktop group resource.

To get the list of available desktop groups, make a List request.

gRPC request

rpc Get (GetDesktopGroupRequest) returns (DesktopGroup)

GetDesktopGroupRequest

{
  "desktop_group_id": "string"
}

Field

Description

desktop_group_id

string

Required field. ID of the desktop group resource to return.

To get the desktop group ID use a DesktopGroupService.List request.

DesktopGroup

{
  "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
}

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

id

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 . 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 . 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
Предыдущая
Overview
Следующая
List