本產品(
云速搭/2021-09-31
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
Token
API | 標題 | API概述 |
---|---|---|
GetToken | 獲取加載架構圖token(不推薦使用) | 獲取讀取架構圖的臨時授權,有效期30分鐘。 |
模板
API | 標題 | API概述 |
---|---|---|
GetTemplate | 獲取模板信息 | 獲取模板圖片及架構圖相關信息。 |
ListTemplate | 查詢模板列表 | 獲取模板列表,包括模板名稱、架構圖地址、架構圖序列化文件地址等。 |
ValuateTemplate | 模板實時詢價 | 查詢模板價格。 |
應用
API | 標題 | API概述 |
---|---|---|
GetApplicationVariables | 獲取應用輸入參數 | 獲取一個應用的所有輸入的模版變量的值。 |
ReConfigApplication | 更新應用屬性 | 用戶可以從上面函數獲取到需要重新配置的模版變量列表。然后對這些變量重新賦值后,調用本函數,應用狀態會變為“修改中”,同時失敗節點的屬性值會根據傳入的模版變量值重新賦值(例如:修改了失敗資源的實例類型等)。執行該函數后,用戶可以重新部署該應用。 |
GetApplicationVariables4Fail | 查詢“部分部署成功”的應用中和部署失敗的資源節點相關的模版變量列表 | 獲取需要重新配置的變量列表。 |
CreateApplication | 基于模板創建應用接口 | 請確保在使用該接口前,已充分了解阿里云產品的收費方式和價格。基于CADT上官方模板或私有模板創建新的應用。 |
DeleteApplication | 刪除應用 | 刪除應用。 |
GetApplication | 獲取應用詳情 | 獲取指定應用的基本信息、校驗結果、計費結果、部署結果。 |
ListApplication | 獲取應用列表 | 該接口提供當前用戶下所有應用的列表。其中可選參數keyword定義應用名中包含的關鍵字。 |
DeployApplication | 部署應用 | 計費成功后,創建資源。 |
ReleaseApplication | 釋放應用 | 該接口釋放應用的資源。 |
ValidateApplication | 應用校驗 | 對應用下的資源輸入的合法性進行校驗,異步執行,校驗結果調用GetApplication獲取。 |
ValuateApplication | 應用計費 | 對應用下的資源進行詢價,通過GetApplication獲取詢價結果。 |
GetResource4ModifyRecord | 獲取應用變配記錄 | 獲取詢價應用變配記錄。 |
GetResult4QueryInstancePrice4Modify | 獲取詢價結果 | 獲取詢價結果。 |
ModifyApplicationSpec | 提交應用變配 | 提交應用變配。 |
QueryInstancePrice4Modify | 查詢變配價格 | 查詢變配價格。 |
QueryInstanceSpec4Modify | 查詢變配規格列表 | 查詢變配規格列表。 |
資源組
API | 標題 | API概述 |
---|---|---|
ChangeResourceGroup | 更換應用或模板資源組 | 該接口可以將CADT創建的應用或模板從一個資源組轉移到另一個資源組。 |
容災服務
API | 標題 | API概述 |
---|---|---|
GetPotentialFailZones | 獲取容災服務可切換的可用區列表 | 獲取指定容災服務可切換的可用區列表。 |
GetFoTaskStatus | 獲取指定容災任務的狀態 | 獲取指定容災任務(TaskId)的狀態。 |
AppFailOver | 容災應用切換 | 將容災集切換至支持的可用區。 |
AppFailBack | 容災應用切回 | 將容災集切回至主可用區。 |
ListFoCreatedApps | 查詢所有容災服務計劃 | 接口查詢當前賬戶下所有容災服務計劃。 |
InitAppFailOver | 應用容災準備 | 應用容災切換準備,初始化容災切換任務。 |
其他接口
API | 標題 | API概述 |
---|---|---|
ExecuteOperationSync | 同步執行操作 | 維護應用下資源API(同步操作) |
GetExecuteOperationResult | 異步獲取操作結果 | 異步獲取操作結果。 |
ExecuteOperationASync | 異步執行操作 | 異步執行產品操作功能。 |
ListTagResources | 查詢標簽接口 | 該接口用于查詢應用或模板的標簽。 |