Yandex Cloud
Поиск
Связаться с намиПопробовать бесплатно
  • Истории успеха
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
  • Marketplace
    • Доступны в регионе
    • Инфраструктура и сеть
    • Платформа данных
    • Искусственный интеллект
    • Безопасность
    • Инструменты DevOps
    • Бессерверные вычисления
    • Управление ресурсами
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Партнёрская программа
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Калькулятор цен
    • Тарифы
    • Акции и free tier
  • Истории успеха
  • Документация
  • Блог
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex Cloud Desktop
  • Управление доступом
  • Правила тарификации
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • GetRdpFile
        • List
        • ListOperations
        • Create
        • UpdateProperties
        • Delete
        • ResetPassword
        • Restart
        • Update
        • Start
        • Stop
  • Аудитные логи Cloud Desktop
  • История изменений

В этой статье:

  • gRPC request
  • GetDesktopRequest
  • Desktop
  • Resources
  • NetworkInterface
  • User
  1. Справочник API
  2. gRPC (англ.)
  3. Desktop
  4. Get

Cloud Desktop API, gRPC: DesktopService.Get

Статья создана
Yandex Cloud
Обновлена 29 января 2026 г.
  • gRPC request
  • GetDesktopRequest
  • Desktop
  • Resources
  • NetworkInterface
  • User

Returns the specified desktop resource.

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

gRPC requestgRPC request

rpc Get (GetDesktopRequest) returns (Desktop)

GetDesktopRequestGetDesktopRequest

{
  "desktop_id": "string"
}

Field

Description

desktop_id

string

Required field. ID of the desktop resource to return.

To get the desktop ID use a DesktopService.List request.

The maximum string length in characters is 50.

DesktopDesktop

{
  "id": "string",
  "folder_id": "string",
  "desktop_group_id": "string",
  "created_at": "google.protobuf.Timestamp",
  "status": "Status",
  "name": "string",
  "resources": {
    "memory": "int64",
    "cores": "int64",
    "core_fraction": "int64"
  },
  "network_interfaces": [
    {
      "network_id": "string",
      "subnet_id": "string"
    }
  ],
  "users": [
    {
      "subject_id": "string",
      "subject_type": "string"
    }
  ],
  "labels": "map<string, string>"
}

A desktop resource.

Field

Description

id

string

Desktop ID.

folder_id

string

ID of the folder that the desktop belongs to.

desktop_group_id

string

ID of the desktop group that the desktop belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

status

enum Status

Status of the desktop.

  • CREATING: Desktop is being created.
  • ACTIVE: Desktop is ready to be used.
  • DELETING: Desktop is being deleted.
  • RESTARTING: Desktop is restarting.
  • UPDATING: Desktop is updating.
  • STARTING: Desktop is starting.
  • STOPPING: Desktop is stopping.
  • STOPPED: Desktop is stopped.
  • ERROR: Desktop did not manage start or restart.
  • CREATION_FAILED: Desktop did not manage to get created or updated.
  • HEALTH_CHECK: Desktop in the process of health check.

name

string

Name of the desktop.

resources

Resources

Resources of the desktop.

network_interfaces[]

NetworkInterface

users[]

User

labels

object (map<string, string>)

Labels of the desktop.

ResourcesResources

Field

Description

memory

int64

The minimum value is 1.

cores

int64

The minimum value is 1.

core_fraction

int64

Acceptable values are 0 to 100, inclusive.

NetworkInterfaceNetworkInterface

Field

Description

network_id

string

Required field.

The maximum string length in characters is 50.

subnet_id

string

Required field.

The maximum string length in characters is 50.

UserUser

Field

Description

subject_id

string

Required field. Identity of the access binding.

The maximum string length in characters is 100.

subject_type

string

Required field. Type of the access binding, e.g. userAccount, serviceAccount, system.

The maximum string length in characters is 100.

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

Предыдущая
Overview
Следующая
GetRdpFile
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»