GetConnectionTicket - 获取应用连接凭证_无影云应用(App Streaming)-阿里云帮助中心

获取云应用连接凭证。

接口说明

颁发连接凭证是一个耗时动作，因此本接口可能需要多次调用才能最终获得连接凭证。

第一次调用，会为指定的便捷账号分配应用实例，并启动应用。返回启动任务 ID（TaskId）。
后续调用，需要在请求参数中传入 TaskId 参数，查询任务是否结束。当返回的任务状态（TaskStatus）为已完成（Finished）时，会同时返回连接凭证（Ticket）。

说明

如果启动够快，也会在第一次调用时就返回连接凭证（Ticket）。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProductType	string	是	产品类型。枚举值： CloudApp：云应用。 AndroidCloud：云手机。	CloudApp
BizRegionId	string	否	地域 ID。说明当传入本参数时，仅会在参数指定地域的交付组中分配应用实例。	cn-hangzhou
LoginToken	string	否	登录令牌。通过`GetLoginToken`或`GetStsToken`接口获取。	v2c4e2ef03d62******
EndUserId	string	否	便捷账号用户名。	alice
SessionId	string	否	登录会话 ID。通过`GetLoginToken`或`GetStsToken`接口获取，与`LoginToken`配合使用。	09e2b2e6-3181******
LoginRegionId	string	否	登录地域 ID。用户使用工作区登录时，工作区所属的地域 ID。	cn-hangzhou
Uuid	string	否	登录设备的唯一标识。	A8B35215993FBF283F28D61******
ClientId	string	否	客户端 ID。	f2463208-ec89-4309-8e8c-8b1******
ClientOS	string	否	客户端操作系统。	windows_"Windows 10 Enterprise LTSC 2019" 10.0 (Build 17763)
ClientVersion	string	否	客户端版本。	2.0.1-D-20211008.101607
ClientIp	string	否	客户端 IP 地址	22.21..
TaskId	string	否	任务 ID。说明非首次调用时必填。使用本参数查询任务状态和连接凭证。	6f41731b-7091-4******
AppInstanceGroupId	string	否	交付组 ID。说明当传入本参数时，仅会在参数指定的且已授权的交付组中分配应用实例。当传入`AppInstanceId`参数时，本参数必填。	aig-bw1o1gcwv******
AppInstanceId	string	否	应用实例 ID。说明当传入本参数时，仅会尝试分配参数所指定的应用实例。当传入本参数时，必须同时传入`AppInstanceGroupId`参数。	ai-ij4a6kd4bn2******
AppId	string	否	应用 ID。说明首次调用时必填，后续调用时选填。	ca-etn4zizga******
AppVersion	string	否	应用版本号。	1.0.1
Param	string	否	应用启动参数。	/q /n
TenantId	string	否	租户 ID，即阿里云账号 UID。	1126819517******
ResourceId	string	否	资源 ID。说明连接云手机时使用，传入云手机实例对应的持久会话 ID。	p-0cdr5c9kl******
ConnectionProperties	string	否	连接属性。说明连接云手机时使用，传入固定值`{"authMode":"Session"}`。	{"authMode":"Session"}
AutoConnectInQueue	boolean	否	排队排到之后，是否自动连接。说明本参数暂未开放。枚举值： true：自动连接。 false：手动连接。	true

返回参数

名称	类型	描述	示例值
	object	响应信息。
RequestId	string	请求 ID。	AD2D0761-1FE5-549D-B169******
Ticket	string	连接凭证。	n7n9bqZlPrvgUOPY0tOfVYGBBcdoPoH3******
TaskId	string	任务 ID。	f3d1b31c-605e-******
TaskStatus	string	任务状态。枚举值： Finished：任务完成。 Failed：任务失败。 Running：运行中。	Running
RetryTimes	integer	重试次数。	3
Code	string	错误码。	InternalError.TicketGenInternalError
Message	string	错误信息。	reenter app instance failed
AppInstanceGroupId	string	交付组 ID。	aig-53fvrq1oa******
AppInstancePersistentId	string	持久会话 ID。	p-0cdr5c9kl******
AppInstanceId	string	应用实例 ID。	ai-gc1gemx6vp******
OsType	string	操作系统类型。枚举值： Linux：Linux。 Windows：Windows。 Android：Android。	Windows
RegionId	string	交付组所属的地域 ID。	cn-hangzhou
LoginToken	string	登录令牌。	v2c4e2ef03d62******
TenantId	long	租户 ID，即阿里云账号 UID。	1126819517******
Policy	object	会话策略。
ResolutionAdaptive	string	是否使用自适应分辨率。说明 `true`：会话分辨率跟随终端显示区域变化。此时`SessionResolutionWidth`和`SessionResolutionHeight`为分辨率变化的最大值。 `false`：会话分辨率不跟随终端显示区域变化。此时分辨率固定为`SessionResolutionWidth`和`SessionResolutionHeight`的值。	true
ResolutionWidth	integer	分辨率的宽度，单位为像素。	1920
ResolutionHeight	integer	分辨率的高度，单位为像素。	1080
BindQueueInfo	object	排队信息。说明本参数暂未开放。
RequestKey	string	排队请求键。	alice******
TargetId	string	队列 ID。	aig-53fvrq1oa******
QueueStatus	string	排队任务状态。枚举值： Ready：已排到。 Waiting：等待中。	Waiting
ReadyTimeout	long	排到之后，手动连接超时时间。	120
Rank	integer	排名信息。	1
WaitTime	long	排队已等待时间。	100
RemainingTime	long	剩余等待时间。	100

示例

正常返回示例

JSON格式

{
  "RequestId": "AD2D0761-1FE5-549D-B169******",
  "Ticket": "n7n9bqZlPrvgUOPY0tOfVYGBBcdoPoH3******",
  "TaskId": "f3d1b31c-605e-******",
  "TaskStatus": "Running",
  "RetryTimes": 3,
  "Code": "InternalError.TicketGenInternalError",
  "Message": "reenter app instance failed",
  "AppInstanceGroupId": "aig-53fvrq1oa******",
  "AppInstancePersistentId": "p-0cdr5c9kl******",
  "AppInstanceId": "ai-gc1gemx6vp******",
  "OsType": "Windows",
  "RegionId": "cn-hangzhou",
  "LoginToken": "v2c4e2ef03d62******\n",
  "TenantId": 0,
  "Policy": {
    "ResolutionAdaptive": "true",
    "ResolutionWidth": 1920,
    "ResolutionHeight": 1080
  },
  "BindQueueInfo": {
    "RequestKey": "alice******",
    "TargetId": "aig-53fvrq1oa******\n",
    "QueueStatus": "Waiting",
    "ReadyTimeout": 120,
    "Rank": 1,
    "WaitTime": 100,
    "RemainingTime": 100
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-12	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-10-10	OpenAPI 返回结构发生变更	查看变更详情
2023-12-22	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-06-29	OpenAPI 返回结构发生变更	查看变更详情
2023-03-07	API 内部配置变更，不影响调用	查看变更详情
2022-06-08	OpenAPI 入参发生变更	查看变更详情