本產品(
云渲染/2021-11-11
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(11370001915),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
實例管理
API | 標題 | API概述 |
---|---|---|
ReserveInstances | 預定云渲染實例 | 預定GCS實例 |
ReleaseInstances | 退訂云渲染實例 | 退訂云渲染實例。 |
ListInstances | 查詢云渲染實例列表 | 查詢云渲染實例列表。 |
DescribeInstanceStatsInfo | 查詢實例統計 | 此 API 旨在查詢不同維度下,用戶購買的云渲染實例統計信息。 用戶可以通過此接口獲取項目(ProjectId)、大區(DistrictId)和實例類型(InstanceType)等條件下的實例統計信息, 實例統計信息中包含: 創建中、運行中、運維中、釋放中等狀態的實例數量。 |
應用管理
API | 標題 | API概述 |
---|---|---|
CreateApp | 創建應用 | 創建一個新的應用。 |
ModifyApp | 修改應用信息 | 修改某個應用的名稱。 |
ListApp | 查詢應用列表 | 查詢應用列表。 |
GetApp | 查詢應用詳情 | 查詢單個應用的詳細信息。 |
DeleteApp | 刪除應用 | 刪除某個應用。 |
版本管理
API | 標題 | API概述 |
---|---|---|
CreateAppVersion | 創建版本 | 為應用創建一個新版本。 |
ModifyAppVersion | 修改版本信息 | 修改應用的版本信息。 |
ListAppVersion | 查詢應用版本列表 | 查詢某個應用的版本列表。 |
GetAppVersion | 查詢版本詳情 | 查詢某個應用的版本詳情。 |
DeleteAppVersion | 刪除版本 | 刪除某個應用的版本。 |
適配管理
API | 標題 | API概述 |
---|---|---|
CreateAdaptation | 創建適配請求 | 為某個應用版本創建適配請求。 |
GetAdaptation | 查詢適配詳情 | 查詢某個適配申請的詳情。 |
容器預定管理
API | 標題 | API概述 |
---|---|---|
CreateCapacityReservation | 創建容器預定任務 | 創建容器預定任務。預定可運行指定會話數量的容器,預定結果通過HTTP接口返回。 |
CancelReserveTask | 取消容器預定任務 | 取消指定的容器預定任務。 |
GetReserveTaskDetail | 查詢容器預定任務詳情 | 查詢容器預定任務的詳細信息。 |
ReleaseCapacity | 釋放預定的容器 | 釋放預定的容器。當符合指定條件且多個條件同時滿足時,容器才會被釋放。釋放結果通過HTTP接口返回。 |
ReleaseCapacityByBatch | 根據批次號釋放資源 | 釋放指定批次的機器。一般是機器預檢未通過時,釋放指定批次的機器。釋放結果通過消息返回。 |
GetCapacity | 查詢容器信息 | 查詢容器信息。 |
會話管理
API | 標題 | API概述 |
---|---|---|
CreateAppSession | 創建應用會話 | 創建應用會話,并啟動一個應用進程,返回會話信息。 |
StopAppSession | 停止應用會話 | 停止應用會話,后續停止結果會通過消息返回。 |
GetAppSession | 獲取應用會話詳情 | 獲取應用會話詳情。 |
ListAppSessions | 查詢應用會話列表 | 查詢應用會話列表,支持批量查詢。只支持查詢未結束的會話信息。 |
CreateAppSessionSync | 同步創建應用會話 | 創建應用會話并啟動應用進程后,會話信息通過消息返回。 |
CreateAppSessionBatchSync | 批量同步創建應用會話 | 批量創建應用會話,平臺會按順序調配資源,啟動多個進程。 |
StopAppSessionBatch | 批量停止應用會話 | 批量停止應用會話。后續停止結果會通過HTTP接口返回。 |
GetAppCcu | 查詢運行中會話統計信息 | 查詢運行中會話的詳細信息。 |
BatchCheckSession | 批量檢查疑似異常會話 | 此接口用于檢查疑似異常會話。 |