文档

GetConnectionTicket - 获取连接凭证

获取桌面连接凭证。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:GetConnectionTicketRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
EndUserIdstring

用户名。

Alice
Passwordstring

用户名的密码。

Ab123456
TaskIdstring

桌面连接任务 ID。

2afbad19-778a-4fc5-9674-1f19c638****
DesktopIdstring

云桌面 ID。

ecd-gx2x1dhsmucyy****
Uuidstring

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

28c80e90-f71e-4c23-93d6-1225329cf949
CommandContentstring

当前参数可以配置自定义用户态应用,当成功获取 ticket 后,自动执行应用。

  • 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
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TaskStatusstring

任务状态。可能值:-running-finished-failed

枚举值:
  • FAILED获取Token失败
  • RUNNING获取Token中
  • FINISHED登录完成
FINISHED
Ticketstring

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

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

桌面连接任务 ID。

2afbad19-778a-4fc5-9674-1f19c638****

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TaskStatus": "FINISHED",
  "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
  "TaskId": "2afbad19-778a-4fc5-9674-1f19c638****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-28OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:CommandContent
  • 本页导读 (0)
文档反馈