Obtains the credential that is used to connect the client to a cloud desktop.

Description

The first time you call this operation, a task ID that is specified by the TaskID parameter is returned. You can use the task ID to continue to call this operation until the value of the TaskStatus parameter changes to FINISHED or FAILED. If the value of the TaskStatus parameter is FINISHED, the value of the Ticket parameter is the credential that is used to connect the client to a cloud desktop.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No GetConnectionTicket

The operation that you want to perform. Set the value to GetConnectionTicket.

ClientId String Yes f4a0dc8e-1702-4728-9a60-95b27a35****

The ID of the client.

LoginToken String Yes v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

The logon credential.

RegionId String Yes cn-hangzhou

The ID of the region.

SessionId String Yes cd45e873-650d-4d70-acb9-f996187a****

The ID of the session.

TaskId String No 2afbad19-778a-4fc5-9674-1f19c638****

The ID of the desktop connection task.

The first time you call this operation, you do not need to specify the task ID. In other cases, you need to set the value to the task ID that is returned by the first call.

DesktopId String No ecd-gx2x1dhsmucyy****

The ID of the cloud desktop.

ClientOS String No Windows_NT 10.0.18363 x64

The OS used by the client.

ClientVersion String No 2.1.0-R-20210731.151756

The version of the client.

ClientType String No windows

The type of the client. Valid values:

  • windows
  • linux
  • mac
  • ios
  • android

Response parameters

Parameter Type Example Description
RequestId String 484256DA-D816-44D2-9D86-B6EE4D5BA78C

The ID of the request.

TaskId String 2afbad19-778a-4fc5-9674-1f19c63862da

The ID of the desktop connection task.

TaskStatus String FINISHED

The status of the task. The valid values include:

  • RUNNING
  • FINISHED
  • FAILED
Ticket String W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********

The credential that was used to connect the client to the cloud desktop.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=GetConnectionTicket
&ClientId=f4a0dc8e-1702-4728-9a60-95b27a35****
&LoginToken=v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
&RegionId=cn-hangzhou
&SessionId=cd45e873-650d-4d70-acb9-f996187a****
&<Common request parameters>|

Sample success responses

XML format

<GetConnectionTicketResponse>
      <Ticket>W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********</Ticket>
      <TaskId>2afbad19-778a-4fc5-9674-1f19c63862da</TaskId>
      <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>
      <TaskStatus>Finished</TaskStatus>
</GetConnectionTicketResponse>

JSON format

{
    "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
    "TaskId": "2afbad19-778a-4fc5-9674-1f19c63862da",
    "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
    "TaskStatus": "Finished"
}