调用GetConnectionTicket获取桌面连接凭证。
接口说明
首次调用该接口时,将返回TaskID,使用该TaskID继续调用该接口,直到TaskStatus的值变为FINISHED或者FAILED。TaskStatus为FINISHED时,Ticket的值即为客户端连接桌面的Ticket。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | GetConnectionTicket |
系统规定参数。取值:GetConnectionTicket。 |
ClientId | String | 是 | f4a0dc8e-1702-4728-9a60-95b27a35**** |
客户端生成的唯一ID。 |
LoginToken | String | 是 | v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
登录凭证。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
SessionId | String | 是 | cd45e873-650d-4d70-acb9-f996187a**** |
会话ID。 |
TaskId | String | 否 | 2afbad19-778a-4fc5-9674-1f19c638**** |
桌面连接任务ID。 首次调用本接口时无需配置,后续调用本接口时配置为上一次调用本接口返回的TaskId。 |
DesktopId | String | 否 | ecd-gx2x1dhsmucyy**** |
云桌面ID。 |
ClientOS | String | 否 | Windows_NT 10.0.18363 x64 |
客户端操作系统。 |
ClientVersion | String | 否 | 2.1.0-R-20210731.151756 |
客户端版本。 |
ClientType | String | 否 | windows |
客户端类型。取值范围:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 484256DA-D816-44D2-9D86-B6EE4D5BA78C |
请求ID。 |
TaskId | String | 2afbad19-778a-4fc5-9674-1f19c63862da |
桌面连接任务ID。 |
TaskStatus | String | FINISHED |
任务状态。可能值:
|
Ticket | String | W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V******** |
桌面连接凭证。 |
示例
请求示例
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****
&<公共请求参数>
正常返回示例
XML
格式
<GetConnectionTicketResponse>
<Ticket>W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********</Ticket>
<TaskId>2afbad19-778a-4fc5-9674-1f19c63862da</TaskId>
<RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>
<TaskStatus>Finished</TaskStatus>
</GetConnectionTicketResponse>
JSON
格式
{
"Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
"TaskId": "2afbad19-778a-4fc5-9674-1f19c63862da",
"RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
"TaskStatus": "Finished"
}