Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Cloud Desktop
  • Начало работы
  • Управление доступом
  • Правила тарификации
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • GetRdpFile
        • List
        • ListOperations
        • Create
        • UpdateProperties
        • Delete
        • ResetPassword
        • Restart
  • Аудитные логи 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
Обновлена 24 апреля 2025 г.
  • 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.

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.

  • STATUS_UNSPECIFIED
  • 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.

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

cores

int64

core_fraction

int64

NetworkInterfaceNetworkInterface

Field

Description

network_id

string

Required field.

subnet_id

string

Required field.

UserUser

Field

Description

subject_id

string

Required field. Identity of the access binding.

subject_type

string

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

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

Предыдущая
Overview
Следующая
GetRdpFile
Проект Яндекса
© 2025 ООО «Яндекс.Облако»