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

获取云应用连接凭证。

接口说明

调用协议说明：operation_type: polling、required_steps: 1。

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

第一次调用，会为指定的便捷账号分配应用实例，并启动应用。如果返回 Ticket，说明同步拿到了结果，如果返回启动任务 ID（TaskId），需要后续调用。

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

说明

前置说明

调用前确保已经创建交付组，完成交付组与用户的授权：
1、创建交付组 API 为 CreateAppInstanceGroup，参数见对应 API 的文档。
2、可以通过 ListAppInstanceGroup API 查询交付组的列表，如果对应的交付组没有查询到，需要确认是否已经创建交付组，或使用的认证凭据是否属于正确的租户。
3、交付组与用户的授权 API 为 AuthorizeInstanceGroup，参数见对应 API 的文档。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:GetConnectionTicket

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ProductType	string	是	产品类型。枚举值： CloudApp : 云应用 AndroidCloud : 安卓云	CloudApp
EndUserId	string	是	用户名称。	alice
BizRegionId	string	否	地域 ID。说明当传入本参数时，仅会在参数指定地域的交付组中分配应用实例。枚举值： cn-shenzhen : cn-shenzhen cn-beijing : cn-beijing cn-shanghai : cn-shanghai cn-zhangjiakou : cn-zhangjiakou cn-hangzhou : cn-hangzhou	cn-hangzhou
TaskId	string	否	任务 ID。说明非首次调用时必填。使用本参数查询任务状态和连接凭证。	28778acb-a469-4bc0-8e0f****
AppId	string	否	应用 ID。说明首次调用时必填，后续调用时选填。	ca-e4s0puhmwi7v****
AppVersion	string	否	应用版本。传入本参数时，仅会打开参数所指定版本的应用。如果不传入本参数，则会打开已授权的任意版本的应用。	1.0.0
AppStartParam	string	否	应用启动参数。非必选，可以参考制作镜像资料中填写启动参数的方式，在镜像制作环节手动验证启动参数，本字段适合填写带可变内容的启动参数，供 API 调用者灵活设置。关于启动参数的获取方法，请参见如何获取应用安装参数与启动参数。	/q /n
EnvironmentConfig	string	否	环境配置。	{"userConfigReenter":"NATIVE"}
AppInstanceGroupIdList	array	否	交付组列表。说明当传入本参数时，仅会在参数指定的且已授权的交付组中分配应用实例。当传入`AppInstanceId`或`AppInstancePersistentId` 参数时，本参数必填。
	string	否	交付组 ID。	aig-4xz0oy8x4ipyv****
AppInstanceGroupSetId	string	否	用于获取连接凭证的交付组集合 ID。	set-3jm9d0abc00example
AppInstancePersistentId	string	否	持久会话 ID。	p-0bxls9m3cl7s****
AppInstanceId	string	否	应用实例 ID。说明当传入本参数时，仅会尝试分配参数所指定的应用实例。当传入本参数时，必须同时传入`AppInstanceGroupIdList`参数，且`AppInstanceGroupIdList`中交付组 ID 的数量为 1。	ai-1rznfnrvsa99d****
AccessType	string	否	接入类型。枚举值： INTERNET : 互联网接入 VPC : 企业专网接入	INTERNET
AppPolicyId	string	否	策略 ID。	pg-0clfzcy0adpcf****

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
AppInstanceGroupId	string	交付组 ID。	aig-53fvrq1oan****
AppInstanceId	string	应用实例 ID。	ai-7ybdeiyoeh5e****
AppInstancePersistentId	string	持久会话 ID。	p-0bxls9m3cl7s****
AvatarId	string	分身 ID。	default
BizRegionId	string	地域 ID。	cn-hangzhou
OsType	string	操作系统类型。枚举值： Windows : Windows 操作系统	Windows
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TaskId	string	任务 ID。	f3d1b31c-605e-4d04-a896****
TaskStatus	string	任务状态。枚举值： Finished : 已完成 Failed : 已失败 Running : 执行中	Running
TenantId	integer	租户 ID（阿里云账号 UID）。	148871678899****
Ticket	string	连接云应用的凭证。说明非首次调用时显示此参数。	DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****

示例

正常返回示例

JSON格式

{
  "AppInstanceGroupId": "aig-53fvrq1oan****",
  "AppInstanceId": "ai-7ybdeiyoeh5e****",
  "AppInstancePersistentId": "p-0bxls9m3cl7s****",
  "AvatarId": "default",
  "BizRegionId": "cn-hangzhou",
  "OsType": "Windows",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TaskId": "f3d1b31c-605e-4d04-a896****",
  "TaskStatus": "Running",
  "TenantId": 0,
  "Ticket": "DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****"
}

错误码

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

变更历史

更多信息，参考变更详情。