Cloud Desktop API, REST: Desktop methods
A set of methods for managing desktop resources.
JSON Representation
{
"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"
}
]
}
| 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
| status | string Status of the desktop.
|
| name | string Name of the desktop. |
| resources | object Resources of the desktop. |
| resources. memory |
string (int64) The minimum value is 1. |
| resources. cores |
string (int64) The minimum value is 1. |
| resources. coreFraction |
string (int64) Acceptable values are 0 to 100, inclusive. |
| networkInterfaces[] | object |
| networkInterfaces[]. networkId |
string Required. The maximum string length in characters is 50. |
| networkInterfaces[]. subnetId |
string Required. The maximum string length in characters is 50. |
| users[] | object |
| users[]. subjectId |
string Required. Identity of the access binding. |
Methods
| Method | Description |
|---|---|
| create | Creates desktop in the specified folder. |
| delete | Deletes the specified desktop. |
| get | Returns the specified desktop resource. |
| getRdpFile | Returns a RDP file for the specified desktop. |
| list | Retrieves the list of desktop resources. |
| listOperations | Returns list of the operations for the specified desktop. |
| resetPassword | Reset password |