Cloud Desktop API, REST: DesktopGroup.list
Retrieves the list of desktop group resources.
HTTP request
GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktopGroups
Query parameters
| Parameter | Description |
|---|---|
| folderId | Required. ID of the folder to list desktop groups in. To get the folder ID use a list request. The maximum string length in characters is 50. |
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
| pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
| filter | A filter expression that filters resources listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
| orderBy | Sorting the list by DesktopGroup.name, DesktopGroup.createdAt and DesktopGroup.status fields. The default sorting order is ascending. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"desktopGroups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"status": "string",
"name": "string",
"description": "string",
"resourcesSpec": {
"memory": "string",
"cores": "string",
"coreFraction": "string"
},
"networkInterfaceSpec": {
"networkId": "string",
"subnetIds": [
"string"
]
}
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| desktopGroups[] | object List of desktop groups. |
| desktopGroups[]. id |
string Desktop group ID. |
| desktopGroups[]. folderId |
string ID of the folder that the desktop group belongs to. |
| desktopGroups[]. 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). |
| desktopGroups[]. status |
string Status of the desktop group.
|
| desktopGroups[]. name |
string Name of the desktop group. |
| desktopGroups[]. description |
string Description of the desktop group. |
| desktopGroups[]. resourcesSpec |
object Resource specification of the desktop group. |
| desktopGroups[]. resourcesSpec. memory |
string (int64) RAM volume, in bytes. The minimum value is 1. |
| desktopGroups[]. resourcesSpec. cores |
string (int64) Number of CPU cores. The minimum value is 1. |
| desktopGroups[]. 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. |
| desktopGroups[]. networkInterfaceSpec |
object Network interface specification of the desktop group. |
| desktopGroups[]. networkInterfaceSpec. networkId |
string Required. ID of the network interface specification. The maximum string length in characters is 50. |
| desktopGroups[]. 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. |
| nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |