Cloud Desktop API, REST: Desktop.Get
Returns the specified desktop resource.
To get the list of available desktops, make a List request.
HTTP request
GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktops/{desktopId}
Path parameters
|
Field |
Description |
|
desktopId |
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. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"desktopGroupId": "string",
"createdAt": "string",
"status": "string",
"name": "string",
"resources": {
"memory": "string",
"cores": "string",
"coreFraction": "string"
},
"networkInterfaces": [
{
"networkId": "string",
"subnetId": "string"
}
],
"users": [
{
"subjectId": "string",
"subjectType": "string"
}
],
"labels": "object"
}
A desktop resource.
|
Field |
Description |
|
id |
string Desktop ID. |
|
folderId |
string ID of the folder that the desktop belongs to. |
|
desktopGroupId |
string ID of the desktop group that the desktop belongs to. |
|
createdAt |
string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
status |
enum (Status) Status of the desktop.
|
|
name |
string Name of the desktop. |
|
resources |
Resources of the desktop. |
|
networkInterfaces[] |
|
|
users[] |
|
|
labels |
object (map<string, string>) Labels of the desktop. |
Resources
|
Field |
Description |
|
memory |
string (int64) The minimum value is 1. |
|
cores |
string (int64) The minimum value is 1. |
|
coreFraction |
string (int64) Acceptable values are 0 to 100, inclusive. |
NetworkInterface
|
Field |
Description |
|
networkId |
string Required field. The maximum string length in characters is 50. |
|
subnetId |
string Required field. The maximum string length in characters is 50. |
User
|
Field |
Description |
|
subjectId |
string Required field. Identity of the access binding. The maximum string length in characters is 100. |
|
subjectType |
string Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. The maximum string length in characters is 100. |