调用GetConnectionTicket获取云电脑连接凭证-无影云电脑企业版-阿里云

获取云电脑连接凭证。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
ClientId	string	是	客户端生成的唯一 ID。	f4a0dc8e-1702-4728-9a60-95b27a35****
SessionId	string	否	会话 ID。调用 GetLoginToken 获取	cd45e873-650d-4d70-acb9-f996187a****
LoginToken	string	是	登录凭证。调用 GetLoginToken 获取	v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
TaskId	string	否	云电脑连接任务 ID。首次调用本接口时无需配置，后续调用本接口时配置为上一次调用本接口返回的`TaskId`。	2afbad19-778a-4fc5-9674-1f19c638****
DesktopId	string	否	云电脑 ID。	ecd-gx2x1dhsmucyy****
ClientOS	string	否	客户端操作系统。	Windows_NT 10.0.18363 x64
ClientVersion	string	否	客户端版本。	2.1.0-R-20210731.151756
ClientType	string	否	客户端类型。枚举值： html5 : Web 客户端 linux : 无影自研硬件终端 android : Android 客户端 windows : Windows 客户端 ios : iOS 客户端 macos : macOS 客户端	windows
CommandContent	string	否	当前参数可以配置自定义用户态应用，当成功获取凭证后，自动执行应用。 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" } ] } ] } }
Uuid	string	否	客户端唯一标识。若使用无影客户端，可在客户端登录界面的关于对话框中查看该参数。	28c80e90-f71e-4c23-93d6-1225329cf949
Tag	array<object>	否	标签列表。可包含 1~20 个。
	object	否	标签。
Key	string	否	标签键。如果传入`Tag`，则`Key`是必填的。不可超过 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或者`https://`，也不能仅包含空格。	TestKey
Value	string	否	标签值。可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	TestValue
AccessType	string	否
TicketBlackList	array	否
	string	否

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TaskStatus	string	任务状态。枚举值： FAILED : 失败 RUNNING : 运行中 FINISHED : 已完成	FINISHED
Ticket	string	云电脑连接凭证。	W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
TaskId	string	云电脑连接任务 ID。	2afbad19-778a-4fc5-9674-1f19c63862da
TaskCode	string	用于连接用户实例的 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********
TaskMessage	string	云电脑连接任务 ID。	2afbad19-778a-4fc5-9674-1f19c638****
P2PToken	string
DesktopId	string

示例

正常返回示例

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****",
  "P2PToken": "",
  "DesktopId": ""
}

错误码

HTTP status code	错误码	错误信息	描述
400	DesktopMemoryHighLoad%s	The specified desktop memory high load.	此台云电脑的内存使用率过高导致连接超时，占用内存最高的应用为%s。请重新连接或重启云电脑。如仍旧出现连接失败,请联系IT管理员.
400	DesktopCpuHighLoad%s	The specified desktop cpu high load.	此台云电脑的CPU使用率过高导致连接超时，占用CPU最高的应用为%s。请重新连接或重启云电脑。如仍旧出现连接失败,请联系IT管理员。
400	InvalidClientIp.Policy	Client ip %s is not in white list.	IT管理员设置了IP白名单策略导致无法在您目前的IP环境（%s）下连接此台云电脑，请联系IT管理员。

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

变更历史

更多信息，参考变更详情。