获取云应用连接凭证。
接口说明
本接口需要多次调用（至少两次）才能最终获得连接凭证。
第一次调用，会为指定的便捷账号分配应用实例，并启动应用。返回启动任务 ID（TaskID）。
后续调用，需要在请求参数中传入TaskID参数，查询任务是否结束，当返回的任务状态（TaskStatus）为已完成（Finished）时，会同时返回连接凭证（Ticket）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| appstreaming:GetConnectionTicket | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProductType | string | 是 | 产品类型。 枚举值：
| CloudApp |
| EndUserId | string | 是 | 便捷账号 ID。 | alice |
| BizRegionId | string | 否 | 地域 ID。 说明
当传入本参数时，仅会在参数指定地域的交付组中分配应用实例。
| cn-hangzhou |
| TaskId | string | 否 | 任务 ID。 说明
非首次调用时必填。使用本参数查询任务状态和连接凭证。
| 28778acb-a469-4bc0-8e0f**** |
| AppId | string | 否 | 应用 ID。 说明
首次调用时必填，后续调用时选填。
| ca-e4s0puhmwi7v**** |
| AppVersion | string | 否 | 应用版本。传入本参数时，仅会打开参数所指定版本的应用。如果不传入本参数，则会打开已授权的任意版本的应用。 | 1.0.0 |
| AppStartParam | string | 否 | 应用启动参数。关于启动参数的获取方法，请参见如何获取应用安装参数与启动参数。 | /q /n |
| AppInstanceGroupIdList | array | 否 | 交付组列表。 说明
AppInstanceId或AppInstancePersistentId 参数时，本参数必填。 | |
| string | 否 | 交付组 ID。 | aig-4xz0oy8x4ipyv**** | |
| AppInstancePersistentId | string | 否 | 持久会话 ID。 | p-0bxls9m3cl7s**** |
| AppInstanceId | string | 否 | 应用实例 ID。 说明
AppInstanceGroupIdList参数，且AppInstanceGroupIdList中交付组 ID 的数量为 1。 | ai-1rznfnrvsa99d**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"TaskStatus": "Running",
"TaskId": "f3d1b31c-605e-4d04-a896****",
"BizRegionId": "cn-hangzhou",
"Ticket": "DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****",
"AppInstanceGroupId": "aig-53fvrq1oan****",
"AppInstancePersistentId": "p-0bxls9m3cl7s****",
"AppInstanceId": "ai-7ybdeiyoeh5e****",
"OsType": "Windows",
"TenantId": 0
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-12-22 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-06-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-20 | API 内部配置变更，不影响调用 | 查看变更详情 |