All Products
Search

This Product

    Elastic Desktop Service:GetConnectionTicket

    Document Center

    Elastic Desktop Service:GetConnectionTicket

    Last Updated:Jan 05, 2026

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

    Operation description

    The cloud computer must be in the Running state. The ticket obtained by calling this operation will expire in 10 minutes.

    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.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ecd:GetConnectionTicketget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    EndUserIdstringNo

    The ID of the end user of the cloud computer. The end user must be the current end user of the cloud computer.

    		Alice
    PasswordstringNo

    The password of the current end user of the cloud computer.

    		Ab123456
    TaskIdstringNo

    The ID of the cloud computer connection task.

    		2afbad19-778a-4fc5-9674-1f19c63862da
    DesktopIdstringNo

    The ID of the cloud computer for which you want to generate a connection credential. This parameter is required.

    		ecd-gx2x1dhsmucyy****
    UuidstringNo

    The unique identifier of the client. If you use an Alibaba Cloud Workspace client, click About on the client logon page to view the identifier of the client.

    		28c80e90-f71e-4c23-93d6-1225329cf949
    CommandContentstringNo

    The command that you want to run to configure a custom application in user mode. After you obtain the credential, the application is automatically started. Parameter description in the command:

    • appPath: the path of the application startup file. Example: "C:\\Program Files (x86)\\000\\000.exe". Use double slashes (\) as the delimiter. Type of the parameter value: string.
    • appParameter: the startup arguments of the application. Example: "meetingid 000 meetingname aaa". Separate multiple arguments with spaces. Type of the parameter value: string.
    		{ "startApplication": { "startApplicationList": [ { "sessionName": "", "appList": [ { "appPath": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", "appParameter": "www.example.com www.example1.com" } ] } ] } }

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    TaskStatusstring

    The task status.

    Valid values:

    • FAILED: The credential fails to be obtained.

    • RUNNING: The credential is being obtained.

    • FINISHED: The credential is obtained.

    		FINISHED
    Ticketstring

    The credentials for connecting to the cloud computer.

    		W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
    TaskIdstring

    The ID of the cloud computer connection task.

    		2afbad19-778a-4fc5-9674-1f19c638****
    TaskCodestring

    Before you use the credential, you must Base64 decode the content of the credential, save the credential as an xxx.ica file, and then open the file. Python sample code:

    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********
    TaskMessagestring

    The ID of the connection task.

    		2afbad19-778a-4fc5-9674-1f19c638****
    DesktopIdstring

    The ID of the cloud computer.

    		ecd-gx2x1dhsmucyy****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-11-13The response structure of the API has changedView Change Details
    2022-09-28The request parameters of the API has changedView Change Details