Cloud Desktop API, gRPC: DesktopService.List

Field

Description

folder_id

string

Required field. ID of the folder to create a DesktopGroup in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

The maximum string length in characters is 50.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListDesktopsResponse.next_page_token
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.

page_token

string

Page token. To get the next page of results, set page_token to the
ListDesktopsResponse.next_page_token returned by a previous list request.

The maximum string length in characters is 100.

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.

The maximum string length in characters is 1000.

order_by

string

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

The maximum string length in characters is 100.

Field

Description

desktops[]

Desktop

List of desktops.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListDesktopsRequest.page_size, use
the next_page_token as the value
for the ListDesktopsRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

Field

Description

id

string

Desktop ID.

folder_id

string

ID of the folder that the desktop belongs to.

desktop_group_id

string

ID of the desktop group that the desktop belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

status

enum Status

Status of the desktop.

• 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.
• HEALTH_CHECK: Desktop in the process of health check.

name

string

Name of the desktop.

resources

Resources

Resources of the desktop.

network_interfaces[]

NetworkInterface

users[]

User

labels

object (map<string, string>)

Labels of the desktop.

Field

Description

memory

int64

The minimum value is 1.

cores

int64

The minimum value is 1.

core_fraction

int64

Acceptable values are 0 to 100, inclusive.

Field

Description

network_id

string

Required field.

The maximum string length in characters is 50.

subnet_id

string

Required field.

The maximum string length in characters is 50.

Field

Description

subject_id

string

Required field. Identity of the access binding.

The maximum string length in characters is 100.

subject_type

string

Required field. Type of the access binding, e.g. userAccount, serviceAccount, system.

The maximum string length in characters is 100.