GetConnectionTicket - Elastic Desktop Service - Alibaba Cloud Documentation Center

Retrieves the credential that is used to connect to a cloud computer.

Operation description

The first time you call this operation, the system returns a task ID in the TaskID parameter. Use the task ID indicated in the TaskID parameter to continue calling this operation until the value of the TaskStatus parameter becomes FINISHED or FAILED. When TaskStatus becomes FINISHED, the value of the Ticket parameter is the ticket that is used to connect the client to the cloud computer.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.	cn-hangzhou
TaskId	string	No	The ID of the cloud computer connection task. The first time you call the GetConnectionTicket operation, you do not need to configure this parameter. When you call the GetConnectionTicket operation later, set this parameter to the value of the `TaskId` parameter returned from the previous invocation.	2afbad19-778a-4fc5-9674-1f19c638****
DesktopId	string	No	The cloud compute ID.	ecd-gx2x1dhsmucyy****
ClientType	string	No	The type of the client. Valid values: html5: web client Linux: self-developed hardware terminal android: Android client windows: Windows client ios: iOS client macos: macOS client	windows
Tag	array<object>	No	The tags. You can specify 1 to 20 tags.
	object	No	The tag.
Key	string	No	The tag key. If you specify the `Tag` parameter, you must also specify the `Key` parameter. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun` and contain only spaces.	TestKey
Value	string	No	The tag value. You can specify an empty string as a tag value. A tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.	TestValue

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Ticket	string	The credentials for connecting to the cloud computer.	W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
TaskId	string	The ID of the task to connect to the cloud computer.	2afbad19-778a-4fc5-9674-1f19c63862da

Examples

Sample success responses

JSONformat

{
  "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": ""
}

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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-10-17	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-11-24	The Error code has changed. The request parameters of the API has changed	View Change Details