文档

GetConnectionTicket - 获取桌面连接凭证

获取桌面连接凭证。

接口说明

首次调用该接口时,将返回TaskID,使用该TaskID继续调用该接口,直到TaskStatus的值变为 FINISHED 或者 FAILED。TaskStatus为 FINISHED 时,Ticket的值即为客户端连接桌面的 Ticket。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云桌面支持的地域列表。

cn-hangzhou
ClientIdstring

客户端生成的唯一 ID。

f4a0dc8e-1702-4728-9a60-95b27a35****
SessionIdstring

会话 ID。调用 GetLoginToken 获取

cd45e873-650d-4d70-acb9-f996187a****
LoginTokenstring

登录凭证。调用 GetLoginToken 获取

v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
TaskIdstring

桌面连接任务 ID。
首次调用本接口时无需配置,后续调用本接口时配置为上一次调用本接口返回的TaskId

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

云桌面 ID。

ecd-gx2x1dhsmucyy****
ClientOSstring

客户端操作系统。

Windows_NT 10.0.18363 x64
ClientVersionstring

客户端版本。

2.1.0-R-20210731.151756
ClientTypestring

客户端类型。取值范围:

  • windows
  • linux
  • mac
  • ios
  • android
windows
CommandContentstring

当前参数可以配置自定义用户态应用,当成功获取凭证后,自动执行应用。

  • appPath:String 类型,应用启动文件路径,例如:"C:\\Program Files (x86)\\000\\000.exe",注意路径分隔符要用双斜杠(\\)。
  • appParameter:String 类型,应用启动参数,例如:"meetingid 000 meetingname aaa",注意参数与参数之间直接用空格。
{ "startApplication": { "startApplicationList": [ { "sessionName": "", "appList": [ { "appPath": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", "appParameter": "www.example.com www.example1.com" } ] } ] } }
Uuidstring

客户端唯一标识。若使用无影客户端,可在客户端登录界面的关于对话框中查看该参数。

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

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

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

任务状态。

枚举值:
  • FAILED失败
  • RUNNING运行中
  • FINISHED已完成
FINISHED
Ticketstring

桌面连接凭证。

W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
TaskIdstring

桌面连接任务 ID。

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

用于连接用户实例的 Ticket,使用时需要先将其内容执行 base64 的解码,并保存为 xxx.ica 文件,然后打开这个文件。Python 代码示例:

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

云电脑连接任务 ID。

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

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)