Contact UsGet started

Cloud Desktop API, REST: DesktopGroup.ListDesktops

Written by
Updated at December 17, 2024

Retrieves the list of desktops resources.

HTTP request

GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktopGroups/{desktopGroupId}/desktops

Path parameters

Field

Description

desktopGroupId

string

Required field. ID of the desktop group.

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListDesktopGroupDesktopsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListDesktopGroupDesktopsResponse.nextPageToken returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can use filtering only on Desktop.name field.
  2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
  3. Value or a list of values to compare against the values of the field.

orderBy

string

Sorting the list by Desktop.name, Desktop.createdAt and Desktop.status fields.
The default sorting order is ascending.

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",
          "subjectType": "string"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Field

Description

desktops[]

Desktop

List of desktops.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListDesktopGroupDesktopsRequest.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.

Desktop

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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

enum (Status)

Status of the desktop.

  • STATUS_UNSPECIFIED
  • CREATING: Desktop is being created.
  • ACTIVE: Desktop is ready to be used.
  • DELETING: Desktop is being deleted.
  • RESTARTING: Desktop is restarting.
  • UPDATING: Desktop is updating.
  • STARTING: Desktop is starting.
  • STOPPING: Desktop is stopping.
  • STOPPED: Desktop is stopped.
  • ERROR: Desktop did not manage start or restart.
  • CREATION_FAILED: Desktop did not manage to get created or updated.

name

string

Name of the desktop.

resources

Resources

Resources of the desktop.

networkInterfaces[]

NetworkInterface

users[]

User

Resources

Field

Description

memory

string (int64)

cores

string (int64)

coreFraction

string (int64)

NetworkInterface

Field

Description

networkId

string

Required field.

subnetId

string

Required field.

User

Field

Description

subjectId

string

Required field. Identity of the access binding.

subjectType

string

Required field. Type of the access binding, e.g. userAccount, serviceAccount, system.
Previous
List
Next
ListOperations