Cloud Desktop API, gRPC: DesktopService

A set of methods for managing desktop resources.

Call	Description
Get	Returns the specified desktop resource.
GetRdpFile	Returns a RDP file for the specified desktop.
List	Retrieves the list of desktop resources.
ListOperations	Returns list of the operations for the specified desktop.
Create	Creates desktop in the specified folder.
Delete	Deletes the specified desktop.
ResetPassword	Reset password
Restart	Restart the specified desktop.

Calls DesktopServiceCalls DesktopService

GetGet

Returns the specified desktop resource.
To get the list of available desktops, make a List request.

rpc Get (GetDesktopRequest) returns (Desktop)

GetDesktopRequestGetDesktopRequest

Field	Description
desktop_id	string Required. ID of the desktop resource to return. To get the desktop ID use a DesktopService.List request. The maximum string length in characters is 50.

DesktopDesktop

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 use. DELETING: Desktop is being deleted.
name	string Name of the desktop.
resources	Resources Resources of the desktop.
network_interfaces[]	NetworkInterface
users[]	User

ResourcesResources

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.

NetworkInterfaceNetworkInterface

Field	Description
network_id	string Required. The maximum string length in characters is 50.
subnet_id	string Required. The maximum string length in characters is 50.

UserUser

Field	Description
subject_id	string Required. Identity of the access binding.

GetRdpFileGetRdpFile

Returns a RDP file for the specified desktop.

rpc GetRdpFile (GetRdpFileRequest) returns (RdpFileResponse)

GetRdpFileRequestGetRdpFileRequest

Field	Description
desktop_id	string Required. ID of the desktop resource to return. To get the desktop ID use a DesktopService.List request. The maximum string length in characters is 50.
user	User User of the desktop.

UserUser

Field	Description
subject_id	string Required. Identity of the access binding.

RdpFileResponseRdpFileResponse

Field	Description
headers	map<string,string> HTTP headers mapping.
content	string RDP file content.

ListList

Retrieves the list of desktop resources.

rpc List (ListDesktopsRequest) returns (ListDesktopsResponse)

ListDesktopsRequestListDesktopsRequest

Field	Description
folder_id	string Required. 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: The field name. Currently you can use filtering only on Desktop.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 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.

ListDesktopsResponseListDesktopsResponse

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.

DesktopDesktop

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 use. DELETING: Desktop is being deleted.
name	string Name of the desktop.
resources	Resources Resources of the desktop.
network_interfaces[]	NetworkInterface
users[]	User

ResourcesResources

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.

NetworkInterfaceNetworkInterface

Field	Description
network_id	string Required. The maximum string length in characters is 50.
subnet_id	string Required. The maximum string length in characters is 50.

UserUser

Field	Description
subject_id	string Required. Identity of the access binding.

ListOperationsListOperations

Returns list of the operations for the specified desktop.

rpc ListOperations (ListDesktopOperationsRequest) returns (ListDesktopOperationsResponse)

ListDesktopOperationsRequestListDesktopOperationsRequest

Field	Description
desktop_id	string Required. ID of the desktop. 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 ListDesktopOperationsResponse.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 ListDesktopOperationsResponse.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: The field name. Currently you can use filtering only on Desktop.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. Value or a list of values to compare against the values of the field. The maximum string length in characters is 1000.

ListDesktopOperationsResponseListDesktopOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified desktop.
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 ListDesktopOperationsRequest.page_size, use the next_page_token as the value for the ListDesktopOperationsRequest.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.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

CreateCreate

Creates desktop in the specified folder.

rpc Create (CreateDesktopRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateDesktopMetadata

    Operation.response:Desktop

CreateDesktopRequestCreateDesktopRequest

Field	Description
desktop_group_id	string Required. ID of the desktop group. The maximum string length in characters is 50.
users[]	User List of users. The number of elements must be greater than 0.

UserUser

Field	Description
subject_id	string Required. Identity of the access binding.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<CreateDesktopMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Desktop> if operation finished successfully.

CreateDesktopMetadataCreateDesktopMetadata

Field	Description
desktop_id	string ID of the desktop that is being created.

DesktopDesktop

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 use. DELETING: Desktop is being deleted.
name	string Name of the desktop.
resources	Resources Resources of the desktop.
network_interfaces[]	NetworkInterface
users[]	User

ResourcesResources

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.

NetworkInterfaceNetworkInterface

Field	Description
network_id	string Required. The maximum string length in characters is 50.
subnet_id	string Required. The maximum string length in characters is 50.

DeleteDelete

Deletes the specified desktop.

rpc Delete (DeleteDesktopRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteDesktopMetadata

    Operation.response:google.protobuf.Empty

DeleteDesktopRequestDeleteDesktopRequest

Field	Description
desktop_id	string Required. ID of the desktop to delete. The maximum string length in characters is 50.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteDesktopMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteDesktopMetadataDeleteDesktopMetadata

Field	Description
desktop_id	string ID of the desktop that is being deleted.

ResetPasswordResetPassword

Reset password

rpc ResetPassword (ResetPasswordRequest) returns (ResetPasswordResponse)

ResetPasswordRequestResetPasswordRequest

Field	Description
desktop_id	string Required. ID of the desktop. The maximum string length in characters is 50.
user	User Required. User of the desktop.

UserUser

Field	Description
subject_id	string Required. Identity of the access binding.

ResetPasswordResponseResetPasswordResponse

Field	Description
password	string Generated password

RestartRestart

Restart the specified desktop.

rpc Restart (RestartRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RestartDesktopMetadata

    Operation.response:Desktop

RestartRequestRestartRequest

Field	Description
desktop_id	string Required. ID of the desktop. The maximum string length in characters is 50.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<RestartDesktopMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Desktop> if operation finished successfully.

RestartDesktopMetadataRestartDesktopMetadata

Field	Description
desktop_id	string ID of the desktop.

DesktopDesktop

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 use. DELETING: Desktop is being deleted.
name	string Name of the desktop.
resources	Resources Resources of the desktop.
network_interfaces[]	NetworkInterface
users[]	User

ResourcesResources

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.

NetworkInterfaceNetworkInterface

Field	Description
network_id	string Required. The maximum string length in characters is 50.
subnet_id	string Required. The maximum string length in characters is 50.

UserUser

Field	Description
subject_id	string Required. Identity of the access binding.