GetConnectionTicket
获取云应用连接凭证
服务地址：
华东2（上海）
输入参数
只看必填
ProductType产品类型
EndUserId用户名称
BizRegionId地域ID
TaskId任务ID
AppId应用ID
AppVersion应用版本
AppStartParam应用启动参数
AppInstanceGroupIdList交付组列表
0交付组ID
添加
AppInstancePersistentId持久会话ID
AppInstanceId应用实例ID
AccessType接入类型
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
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
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

本接口需要多次调用（至少两次）才能最终获得连接凭证。

第一次调用，会为指定的便捷账号分配应用实例，并启动应用。返回启动任务 ID（TaskID）。

后续调用，需要在请求参数中传入TaskID参数，查询任务是否结束，当返回的任务状态（TaskStatus）为已完成（Finished）时，会同时返回连接凭证（Ticket）。

请求参数

字段名称字段详情
ProductTypestring

产品类型。

示例值:CloudApp枚举值:CloudAppAndroidCloud
EndUserIdstring

用户名称。

示例值:alice
BizRegionIdstring

地域 ID。展开详情

示例值:cn-hangzhou枚举值:cn-shenzhencn-beijingcn-shanghaicn-zhangjiakoucn-hangzhou
TaskIdstring

任务 ID。展开详情

示例值:28778acb-a469-4bc0-8e0f****参考取值来源:
    ListOtaTask
AppIdstring

应用 ID。展开详情

示例值:ca-e4s0puhmwi7v****
AppVersionstring

应用版本。传入本参数时，仅会打开参数所指定版本的应用。如果不传入本参数，则会打开已授权的任意版本的应用。

示例值:1.0.0参考取值来源:
    ListAppInstanceGroup
    GetAppInstanceGroup
AppStartParamstring

应用启动参数。关于启动参数的获取方法，请参见如何获取应用安装参数与启动参数。

示例值:/q /n
AppInstanceGroupIdListarray<string>

交付组列表。展开详情

子级条数 <= 100
AppInstancePersistentIdstring

持久会话 ID。

示例值:p-0bxls9m3cl7s****参考取值来源:
    ListPersistentAppInstances
AppInstanceIdstring

应用实例 ID。展开详情

示例值:ai-1rznfnrvsa99d****参考取值来源:
    ListAppInstances
    GetDebugAppInstance
AccessTypestring

接入类型，不传表示两种都显示。展开详情

示例值:INTERNET枚举值:INTERNETVPC字符长度 <= 10字符长度 >= 0

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

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

任务状态。

示例值:Running枚举值:FinishedFailedRunning
TaskIdstring

任务 ID。

示例值:f3d1b31c-605e-4d04-a896****
BizRegionIdstring

地域 ID。

示例值:cn-hangzhou
Ticketstring

连接云应用的凭证。展开详情

示例值:DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****
AppInstanceGroupIdstring

交付组 ID。

示例值:aig-53fvrq1oan****
AppInstancePersistentIdstring

持久会话 ID。

示例值:p-0bxls9m3cl7s****
AppInstanceIdstring

应用实例 ID。

示例值:ai-7ybdeiyoeh5e****
OsTypestring

操作系统类型。

示例值:Windows枚举值:Windows
TenantIdinteger<int64>

租户 ID（阿里云账号 UID）。

注意 请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。
示例值:148871678899****
变更历史
暂无变更历史