獲取云應用連接憑證。
接口說明
本接口需要多次調用（至少兩次）才能最終獲得連接憑證。
第一次調用，會為指定的便捷賬號分配應用實例，并啟動應用。返回啟動任務 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 內部配置變更，不影響調用 | 查看變更詳情 |