Cloud Desktop API, REST: DesktopGroup.get
Returns the specified desktop group resource.
To get the list of available desktop groups, make a list request.
HTTP request
GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktopGroups/{desktopGroupId}
Path parameters
| Parameter | Description |
|---|---|
| desktopGroupId | Required. ID of the desktop group resource to return. To get the desktop group ID use a list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"status": "string",
"name": "string",
"description": "string",
"resourcesSpec": {
"memory": "string",
"cores": "string",
"coreFraction": "string"
},
"networkInterfaceSpec": {
"networkId": "string",
"subnetIds": [
"string"
]
}
}
A desktop group resource.
| Field | Description |
|---|---|
| id | string Desktop group ID. |
| folderId | string ID of the folder that the desktop group 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 group.
|
| name | string Name of the desktop group. |
| description | string Description of the desktop group. |
| resourcesSpec | object Resource specification of the desktop group. |
| resourcesSpec. memory |
string (int64) RAM volume, in bytes. The minimum value is 1. |
| resourcesSpec. cores |
string (int64) Number of CPU cores. The minimum value is 1. |
| resourcesSpec. coreFraction |
string (int64) Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. Acceptable values are 0 to 100, inclusive. |
| networkInterfaceSpec | object Network interface specification of the desktop group. |
| networkInterfaceSpec. networkId |
string Required. ID of the network interface specification. The maximum string length in characters is 50. |
| networkInterfaceSpec. subnetIds[] |
string Required. List of subnet IDs. Must contain at least one element. The maximum string length in characters for each value is 50. |