获取连接实例所需要的 token

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetConnectTicket

系统规定参数。取值:GetConnectTicket。

InstanceId String i-xxx

实例 id

AppName String app-xxx
说明 WorkModeDesktop(桌面模式)时,不要指定此参数。
说明 WorkModeApplication(应用模式)时,必需指定此参数

应用名称。

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

域用户名。

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

域用户名的密码。

TaskId String t-xxx
说明 此值只在 AsyncModetrue 时有效

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

AsyncMode Boolean true

异步模式调用:

  • false(默认):命令执行完成后,api 才会返回
  • true:api 立即返回
    • TaskId 为空:查询命令在后台异步执行。调用方需使用返回值中的 TaskId,继续调用此 api 来获得查询命令的结果。
    • TaskId 不为空:获得查询命令的结果

返回数据

名称 类型 示例值 描述
RequestId String XXX-XXX

请求 id

TaskFinished Boolean true

当前调用的运行状态

  • false:还未完成。
  • true:已完成。
TaskId String t-xxx

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

Ticket String XXXXXXXXX

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


import base64
response = {
    "Ticket": "XXXX",
    "RequestId": "XXXX",
}
f = open ('xxx.ica', 'w')
out = base64.b64decode(response['Ticket'])
f.write(out)
f.close()

示例

请求示例

http(s)://[Endpoint]/?Action=GetConnectTicket
&InstanceId=i-xxx
&<公共请求参数>

正常返回示例

XML 格式

<Ticket>XXXXXXXXX</Ticket>
<TaskId>t-xxx</TaskId>
<RequestId>XXX-XXX</RequestId>
<TaskFinished>true</TaskFinished>

JSON 格式

{"Ticket":"XXXXXXXXX","TaskId":"t-xxx","RequestId":"XXX-XXX","TaskFinished":"true"}

错误码

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