Cloud Desktop API, gRPC: DesktopService.Get
Returns the specified desktop resource.
To get the list of available desktops, make a List request.
gRPC request
rpc Get (GetDesktopRequest) returns (Desktop)
GetDesktopRequest
{
"desktop_id": "string"
}
|
Field |
Description |
|
desktop_id |
string Required field. ID of the desktop resource to return. The maximum string length in characters is 50. |
Desktop
{
"id": "string",
"folder_id": "string",
"desktop_group_id": "string",
"created_at": "google.protobuf.Timestamp",
"status": "Status",
"name": "string",
"labels": "map<string, string>",
"description": "string",
"resources": {
"memory": "int64",
"cores": "int64",
"core_fraction": "int64"
},
"network_interfaces": [
{
"network_id": "string",
"subnet_id": "string"
}
],
"users": [
{
"subject_id": "string",
"subject_type": "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 |
Creation timestamp in RFC3339 text format. |
|
status |
enum Status Status of the desktop.
|
|
name |
string Name of the desktop. |
|
labels |
object (map<string, string>) Labels of the desktop. |
|
description |
string Description of the desktop. |
|
resources |
Resources of the desktop. |
|
network_interfaces[] |
Network interfaces of the desktop. |
|
users[] |
Users of the desktop. |
Resources
|
Field |
Description |
|
memory |
int64 The amount of memory available to the desktop, specified in bytes. The minimum value is 1. |
|
cores |
int64 The number of cores available to the desktop. The minimum value is 1. |
|
core_fraction |
int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. Acceptable values are 0 to 100, inclusive. |
NetworkInterface
|
Field |
Description |
|
network_id |
string Required field. ID of the network. The maximum string length in characters is 50. |
|
subnet_id |
string Required field. ID of the subnet. The maximum string length in characters is 50. |
User
|
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. |