使用GetConnectionTicket获取云电脑连接凭证-无影云电脑企业版-阿里云-阿里云帮助中心

获取云电脑连接凭证。

接口说明

云电脑的状态必须为运行中（Running），使用该接口获取的 Ticket 过期时间为 10 分钟。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecd:GetConnectionTicket	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
EndUserId	string	否	云电脑授权用户的用户名。必须传入云电脑现有的授权用户才能成功生成凭证。	alice
Password	string	否	云电脑授权用户的密码。	Ab123456
TaskId	string	否	云电脑连接任务 ID。	2afbad19-778a-4fc5-9674-1f19c638****
DesktopId	string	否	需生成连接凭证的云电脑 ID。必须传入该字段才能成功生成凭证。	ecd-gx2x1dhsmucyy****
Uuid	string	否	客户端唯一标识。若使用无影客户端，可在客户端登录界面的关于对话框中查看该参数。	28c80e90-f71e-4c23-93d6-1225329cf949
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" } ] } ] } }

返回参数

名称	类型	描述	示例值
	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-1f19c638****
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****
DesktopId	string	云电脑 ID。	ecd-gx2x1dhsmucyy****

示例

正常返回示例

JSON格式

{
  "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****"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-13	OpenAPI 返回结构发生变更	查看变更详情
2022-09-28	OpenAPI 入参发生变更	查看变更详情