GetConnectTicket_云桌面_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.

流控信息

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

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
InstanceIdstring

实例 id。

示例值:i-xxx参考取值来源:
    CreateInstance
    DescribeInstances
AppNamestring
说明 WorkModeDesktop(桌面模式)时,不要指定此参数。 WorkModeApplication(应用模式)时,必需指定此参数

应用名称。

示例值:app-xxx
UserNamestring
说明 DescribeInstances 返回字段的 DomainName 非空,且调用者身份为该实例的已分配用户时,需要此参数

域用户名。

示例值:user01
Passwordstring
说明 DescribeInstances 返回字段的 DomainName 非空,且调用者身份为该实例的已分配用户时,需要此参数

域用户名的密码。

示例值:***
TaskIdstring
说明 此值只在 AsyncModetrue 时有效

非空时用来获得之前调用的执行状态。

示例值:t-xxx
AsyncModeboolean

异步模式调用。展开详情

示例值:true
UsePrivateIpboolean

使用内网 IP 连接云桌面:展开详情

示例值:true

返回参数

字段名称字段详情
TaskFinishedboolean

当前调用的运行状态展开详情

示例值:true
RequestIdstring

请求 id

示例值:XXX-XXX
Ticketstring

用来连接用户实例 Ticket,使用时需要先将其内容做 base64 的 decode,保存为 xxx.ica 文件,然后打开这个文件。python 代码举例:展开详情

示例值:XXXXXXXXX
TaskIdstring

当前调用对应的任务 id。调用方可使用此值,继续调用此 API 来获取运行的结果。

示例值:t-xxx

返回示例

变更历史

暂无变更历史

相关示例