GetConnectionTicket - Elastic Desktop Service - Alibaba Cloud Documentation Center

Obtains a connection ticket for a cloud computer.

Operation description

The first time you call this operation, it returns a TaskID. You can use this TaskID to call the operation again until TaskStatus changes to FINISHED or FAILED. If TaskStatus is FINISHED, the Ticket value is the connection ticket that the client uses to connect to the cloud computer.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to get a list of regions that Elastic Desktop Service (EDS) supports.	cn-hangzhou
ClientId	string	Yes	A unique ID generated by the client.	f4a0dc8e-1702-4728-9a60-95b27a35****
SessionId	string	No	The session ID. Call GetLoginToken to obtain this ID.	cd45e873-650d-4d70-acb9-f996187a****
LoginToken	string	Yes	The logon credential. Call GetLoginToken to obtain this credential.	v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
TaskId	string	No	The ID of the cloud computer connection task. Do not specify this parameter in your first call. For subsequent calls, set this parameter to the `TaskId` returned from the previous call.	2afbad19-778a-4fc5-9674-1f19c638****
DesktopId	string	No	The cloud computer ID.	ecd-gx2x1dhsmucyy****
ClientOS	string	No	The client operating system.	Windows_NT 10.0.18363 x64
ClientVersion	string	No	The client version.	2.1.0-R-20210731.151756
ClientType	string	No	The client type. Valid values: html5 : Web client linux : Alibaba Cloud Workspace-developed hardware terminal android : Android client windows : Windows client ios : iOS client macos : macOS client	windows
CommandContent	string	No	This parameter lets you configure a custom user-mode application. After a ticket is obtained, the application is automatically run. appPath: A string that specifies the path of the application startup file. For example, `"C:\Program Files (x86)\000\000.exe"`. Note: Use double backslashes (\) as separators. appParameter: A string that specifies the startup parameters of the application. For example, `"meetingid 000 meetingname aaa"`. Note: Use spaces to separate parameters.	{ "startApplication": { "startApplicationList": [ { "sessionName": "", "appList": [ { "appPath": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", "appParameter": "www.example.com www.example1.com" } ] } ] } }
Uuid	string	No	The unique identifier of the client. If you use a Alibaba Cloud Workspace client, find this parameter in the About dialog box on the logon screen.	28c80e90-f71e-4c23-93d6-1225329cf949
Tag	array<object>	No	A list of tags. You can include 1 to 20 tags.
	object	No	A tag.
Key	string	No	The tag key. If you specify `Tag`, `Key` is required. The key cannot exceed 128 characters in length. It cannot start with `aliyun` or `acs:`, contain `http://` or `https://`, or consist of only spaces.	TestKey
Value	string	No	The tag value. The value can be an empty string. It can be up to 128 characters in length. It cannot start with `acs:` or contain `http://` or `https://`.	TestValue
AccessType	string	No
TicketBlackList	array	No
	string	No

Response elements

Element	Type	Description	Example
	object	The response information.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TaskStatus	string	The task status. Valid values: FAILED : The task failed. RUNNING : The task is running. FINISHED : The task is complete.	FINISHED
Ticket	string	The connection ticket for the cloud computer.	W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
TaskId	string	The ID of the cloud computer connection task.	2afbad19-778a-4fc5-9674-1f19c63862da
TaskCode	string	The ticket used to connect to the user instance. Before you use the ticket, decode its content from Base64, save it as an .ica file, and then open the file. The following code provides a Python example: `import base64 response = { "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V******", "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F**", } f = open ('xxx.ica', 'w') out = base64.b64decode(response['Ticket']) f.write(out) f.close()`	W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
TaskMessage	string	The ID of the cloud computer connection task.	2afbad19-778a-4fc5-9674-1f19c638****
P2PToken	string
DesktopId	string

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TaskStatus": "FINISHED",
  "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
  "TaskId": "2afbad19-778a-4fc5-9674-1f19c63862da",
  "TaskCode": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
  "TaskMessage": "2afbad19-778a-4fc5-9674-1f19c638****",
  "P2PToken": "",
  "DesktopId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	DesktopMemoryHighLoad%s	The specified desktop memory high load.	A time out error occurred when connecting to this cloud computer because the memory usage of it is too high. The app consuming the most memory is %s. Please reconnect or restart the cloud computer. If the issue persists, please contact your IT administrator.
400	DesktopCpuHighLoad%s	The specified desktop cpu high load.	The CPU usage of this cloud computer is too high, causing the connection to time out. The application with the highest CPU usage is% s. Please reconnect or restart the cloud computer. If the connection failure still occurs, contact your IT administrator.
400	InvalidClientIp.Policy	Client ip %s is not in white list.	The IT administrator has set an IP whitelist policy that prevents you from connecting to this cloud computer under your current IP environment (%s). Please contact the IT administrator.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.