本產(chǎn)品（
無影云應(yīng)用/2021-09-01）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費 5個工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進行簽名對接。在使用API前，您需要準(zhǔn)備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請參見獲取AccessKey。
地域
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListRegions | 查詢支持的地域 | 查詢無影云應(yīng)用支持的地域。 |
資源
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListNodeInstanceType | 查詢資源規(guī)格 | 查詢創(chuàng)建交付組時可選購的資源規(guī)格。 |
| GetResourcePrice | 查詢資源價格 | 查詢資源的價格信息。 |
| GetResourceRenewPrice | 查詢資源續(xù)費價格 | 查詢無影云應(yīng)用資源的續(xù)費價格。 |
交付組
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateAppInstanceGroup | 創(chuàng)建交付組 | 創(chuàng)建交付組。 |
| GetAppInstanceGroup | 查詢指定交付組詳細(xì)信息 | 查詢指定交付組詳細(xì)信息。 |
| ListAppInstanceGroup | 查詢多個交付組詳細(xì)信息 | 查詢多個交付組詳細(xì)信息，即不指定特定的交付組，而是查詢所有滿足條件的交付組的詳細(xì)信息。 |
| PageListAppInstanceGroupUser | 分頁查詢交付組的分配用戶 | 分頁查詢交付組中已添加的分配用戶。 |
| RenewAppInstanceGroup | 為交付組續(xù)費 | 為交付組續(xù)費。 |
| UpdateAppInstanceGroupImage | 更新交付組鏡像 | 更新交付組的鏡像。 |
| ModifyAppInstanceGroupAttribute | 修改交付組通用策略 | 修改交付組的通用策略，包括并發(fā)會話數(shù)、會話斷連保留時長等。 |
| ModifyNodePoolAttribute | 修改交付組彈性模式 | 修改交付組的彈性模式，包括固定數(shù)量（不使用彈性擴縮容）、定時擴縮容和自動擴縮容。 |
| AuthorizeInstanceGroup | 為交付組添加或移除分配用戶 | 為交付組添加或移除分配用戶。只有添加到分配用戶的用戶可訪問云應(yīng)用。 |
| LogOffAllSessionsInAppInstanceGroup | 注銷交付組下所有會話 | 注銷已開啟定時擴縮容策略的按量付費交付組下所有會話。 |
| DeleteAppInstanceGroup | 刪除按量付費交付組 | 刪除"資源型-按量付費"形式的交付組。 |
| ModifyAppPolicy | 修改交付組顯示策略 | 修改交付組顯示策略，包括幀率、分辨率、協(xié)議類型等設(shè)置。 |
應(yīng)用實例
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListAppInstances | 查詢交付組內(nèi)實例詳細(xì)信息 | 查詢交付組內(nèi)會話實例的詳細(xì)信息，包括實例ID、實例狀態(tài)、創(chuàng)建時間、更新時間、會話狀態(tài)、主網(wǎng)卡公網(wǎng)IP等。 |
| DeleteAppInstances | 刪除指定應(yīng)用實例 | 刪除指定應(yīng)用實例。 |
連接
| API | 標(biāo)題 | API概述 |
|---|---|---|
| GetConnectionTicket | 獲取云應(yīng)用連接憑證 | 獲取云應(yīng)用連接憑證。 |
| Unbind | 解綁用戶和會話 | 解綁用戶和會話。 |
調(diào)試
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateImageFromAppInstanceGroup | 通過調(diào)試交付組創(chuàng)建新鏡像 | 通過調(diào)試交付組創(chuàng)建新鏡像。 |
| GetDebugAppInstance | 獲取調(diào)試應(yīng)用實例信息 | 獲取調(diào)試應(yīng)用實例信息。 |
OTA升級
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListOtaTask | 查詢OTA升級歷史記錄 | 查詢OTA升級歷史記錄。 |
| GetOtaTaskByTaskId | 查詢OTA升級任務(wù)明細(xì) | 查詢OTA升級任務(wù)明細(xì)，包括可升級版本、版本說明等。 |
| ApproveOtaTask | 設(shè)置OTA升級執(zhí)行時間 | 設(shè)置OTA升級的執(zhí)行時間。 |
管理員賬號
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListTenantConfig | 查詢管理員賬號配置信息 | 查詢管理員賬號配置信息，例如是否已開啟資源到期提醒。 |
| ModifyTenantConfig | 修改管理員賬號配置信息 | 修改管理員賬號配置信息，例如是否開啟資源到期提醒。 |