Cloud Desktop API, REST: DesktopGroup.listDesktops
Retrieves the list of desktops resources.
HTTP request
GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktopGroups/{desktopGroupId}/desktops
Path parameters
| Parameter | Description |
|---|---|
| desktopGroupId | Required. ID of the desktop group. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| 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 Desktop.name, Desktop.createdAt and Desktop.status fields. The default sorting order is ascending. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"desktops": [
{
"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"
}
]
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| desktops[] | object List of desktops. |
| desktops[]. id |
string Desktop ID. |
| desktops[]. folderId |
string ID of the folder that the desktop belongs to. |
| desktops[]. desktopGroupId |
string ID of the desktop group that the desktop belongs to. |
| desktops[]. 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). |
| desktops[]. status |
string Status of the desktop.
|
| desktops[]. name |
string Name of the desktop. |
| desktops[]. resources |
object Resources of the desktop. |
| desktops[]. resources. memory |
string (int64) The minimum value is 1. |
| desktops[]. resources. cores |
string (int64) The minimum value is 1. |
| desktops[]. resources. coreFraction |
string (int64) Acceptable values are 0 to 100, inclusive. |
| desktops[]. networkInterfaces[] |
object |
| desktops[]. networkInterfaces[]. networkId |
string Required. The maximum string length in characters is 50. |
| desktops[]. networkInterfaces[]. subnetId |
string Required. The maximum string length in characters is 50. |
| desktops[]. users[] |
object |
| desktops[]. users[]. subjectId |
string Required. Identity of the access binding. |
| 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 [ListDesktopsDGS Request.page_token] query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |