GetConnectionTicket_无影云电脑_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou
EndUserIdstring

云电脑授权用户的用户名。必须传入云电脑现有的授权用户才能成功生成凭证。

示例值:alice参考取值来源:
    DescribeUsersInGroup
Passwordstring

云电脑授权用户的密码。

示例值:Ab123456
TaskIdstring

云电脑连接任务 ID。

示例值:2afbad19-778a-4fc5-9674-1f19c638****
DesktopIdstring

需生成连接凭证的云电脑 ID。必须传入该字段才能成功生成凭证。

示例值:ecd-gx2x1dhsmucyy****参考取值来源:
    RebuildDesktops
    CreateDesktops
    ModifyDesktopTimer
    DescribeDesktopInfo
    DisconnectDesktopSessions
Uuidstring

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

示例值:28c80e90-f71e-4c23-93d6-1225329cf949
CommandContentstring

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

示例值:{ "startApplication": { "startApplicationList": [ { "sessionName": "", "appList": [ { "appPath": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", "appParameter": "www.example.com www.example1.com" } ] } ] } }

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TaskStatusstring

任务状态。

示例值:FINISHED枚举值:FAILEDRUNNINGFINISHED
Ticketstring

云电脑连接凭证。

示例值:W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
TaskIdstring

云电脑连接任务 ID。

示例值:2afbad19-778a-4fc5-9674-1f19c638****
TaskCodestring

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

示例值:W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
TaskMessagestring

云电脑连接任务 ID。

示例值:2afbad19-778a-4fc5-9674-1f19c638****
DesktopIdstring

云电脑 ID。

示例值:ecd-gx2x1dhsmucyy****

返回示例

变更历史

变更时间变更内容概要操作
2024-11-13
变更返回参数
2022-09-28
新增请求参数CommandContent
2021-12-23
新增OpenAPI,获取连接凭证

相关示例