API標準及多語言預置SDK
本產品（oos/2019-06-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
地域
|
API |
標題 |
API概述 |
| DeleteTemplates | 刪除多個模版 | 調用該API刪除多個模版。 |
範本
|
API |
標題 |
API概述 |
| StartExecution | 啟動一個執行 | 啟動一個執行。 |
| GenerateExecutionPolicy | 擷取執行所需 Ram Policy | 擷取模板執行所需要的Ram Policy。 |
| DeleteTemplate | 刪除一個模版 | 刪除一個模版。 |
| UpdateTemplate | 更新一個已經存在的模板 | 更新一個已經存在的模板。 |
| ListTemplateVersions | 查詢一個模版的多個版本對象 | 查詢一個模版的多個版本對象。 |
| ListTemplates | 查詢範本 | 支援多種過濾方式。 |
| GetTemplate | 擷取模版 | 擷取一個模版，包括內容。 |
| ListExecutionRiskyTasks | 擷取模版中的高風險任務 | 擷取模版中的高風險任務。 |
| ValidateTemplateContent | 校正一個模版是否合法 | 校正一個模版是否合法。 |
執行
|
API |
標題 |
API概述 |
| DeleteExecutions | 刪除執行 | 刪除執行。 |
| StartExecution | 啟動一個執行 | 啟動一個執行。 |
| UpdateExecution | 更新未結束的執行 | 更新未結束（處於Running, Waiting狀態）的執行。 |
| GetExecutionTemplate | 擷取一個執行所使用的模板 | 擷取一個執行所使用的模板，包括內容。 |
| ListExecutions | 查詢執行 | 查詢執行，支援多種過濾方式。 |
| ListExecutionLogs | 擷取執行的詳細日誌 | 擷取執行的詳細日誌。 |
| ListTaskExecutions | 查詢任務執行 | 查詢任務執行，支援多種過濾方式。 |
| ListResourceExecutionStatus | 查看包含ECS執行個體的定時營運執行資訊 | 查看包含ECS執行個體的定時營運執行資訊。 |
| CancelExecution | 取消執行 | 取消執行。 |
| GenerateExecutionPolicy | 擷取執行所需 Ram Policy | 擷取模板執行所需要的Ram Policy。 |
| NotifyExecution | 通知執行如何運行 | 通知一個狀態為等待中的執行接下來如何運行。 |
| TriggerExecution | 執行事件觸發 | 事件觸發程序或警示觸發器任務，可對該類執行發送訊息體內容，訊息體會使事件或警示任務產生一個新的子執行。 |
動作
|
API |
標題 |
API概述 |
| ListActions | 查詢可用動作 | 查詢可用動作，包括原子動作和雲產品動作。 |
參數
|
API |
標題 |
API概述 |
| 一般參數 | 一般參數 | |
| CreateParameter | 建立一個普通參數 | 建立一個普通參數。 |
| DeleteParameter | 刪除普通參數 | 刪除普通參數。 |
| UpdateParameter | 更新一個已存在的普通參數 | 更新一個已存在的普通參數。 |
| GetParameter | 擷取普通參數 | 擷取一個普通參數或公用參數，包括參數值。 |
| ListParameters | 查詢普通參數 | 查詢普通參數和公用參數，支援多種查詢。 |
| ListParameterVersions | 查看普通參數的多個版本對象 | 查看普通參數的多個版本對象。 |
| GetParametersByPath | 通過路徑擷取普通參數 | 通過路徑擷取參數。 |
| GetParameters | 擷取一個或多個普通參數的詳細資料 | 擷取一個或多個參數的詳細資料。 |
| 加密參數 | 加密參數 | |
| CreateSecretParameter | 建立一個加密參數 | 建立一個加密參數。請確保在使用該介面前有操作kms CreateSecret API的許可權。 |
| DeleteSecretParameter | 刪除一個加密參數 | 刪除一個加密參數。請確保在使用該介面前有操作kms DeleteSecret API的許可權。 |
| UpdateSecretParameter | 更新一個加密參數 | 更新一個加密參數。請確保在使用該介面前有操作kms UpdateSecretValue API的許可權。 |
| GetSecretParameter | 擷取一個加密參數和參數值 | 擷取一個加密參數，包括參數值。請確保在使用該介面前有操作kms GetSecretValue API的許可權。 |
| ListSecretParameters | 擷取加密參數列表 | 查詢普通參數，支援多種查詢。 |
| ListSecretParameterVersions | 查詢加密參數的多個版本對象 | 查詢加密參數的多個版本對象。 |
| GetSecretParametersByPath | 通過路徑擷取加密參數 | 通過路徑擷取加密參數。請確保在使用該介面前有操作kms GetSecretValue API的許可權。 |
| GetSecretParameters | 擷取一個或多個加密參數的詳細資料 | 擷取一個或多個加密參數的詳細資料。請確保在使用該介面前有操作kms GetSecretValue API的許可權。 |
修補程式管理
|
API |
標題 |
API概述 |
| 修補程式基線 | 修補程式基線 | |
| UpdateApplicationGroup | 更新一個應用分組的資訊 | 更新一個應用分組的資訊。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| GetApplicationGroup | 擷取一個應用分組的詳細資料 | 擷取一個應用分組的詳細資料。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| ListApplicationGroups | 查詢應用分組列表 | 查詢應用分組列表。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| DeployApplicationGroup | 部署應用分組 | 部署應用分組。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| ListPatchBaselines | 列出Hotfix基準 | 擷取補丁基準列表。 |
| RegisterDefaultPatchBaseline | 註冊預設補丁基準 | 註冊預設補丁基準。 |
| 修補程式狀態 | 修補程式狀態 | |
| ListInstancePatchStates | 列出執行個體Hotfix狀態 | 擷取執行個體補丁資訊。 |
| ListInstancePatches | 列出執行個體Hotfix | 擷取執行個體補丁資訊。 |
組態清單
|
API |
標題 |
API概述 |
| ListTagValues | 查詢已建立的標籤值 | 查詢已建立的標籤值。 |
| GetInventorySchema | 擷取配置清單的模式資訊 | 擷取配置清單的模式資訊。 |
| SearchInventory | 查詢配置清單的詳細資料或彙總資訊 | 查詢配置清單的詳細資料或彙總資訊。 |
終態組態
|
API |
標題 |
API概述 |
| UpdateInstancePackageState | 更新執行個體安裝的擴充 | 更新執行個體安裝的擴充 |
| ListInstancePackageStates | 查詢某個執行個體已安裝的擴充 | 列出執行個體軟體包狀態 |
| UpdateStateConfiguration | 更新一個終態配置 | 更新終態配置。 |
| ListStateConfigurations | 查詢終態配置 | 查詢終態配置。 |
運維項目
|
API |
標題 |
API概述 |
| GetTemplateParameterConstraints | Gets the available values for template parameters | 擷取參數可用值 |
| GetOpsItem | 擷取營運項 | 擷取營運項詳情。 |
| ListOpsItems | 查詢營運項 | 查詢營運項。 |
| UpdateOpsItem | 更新營運項 | 修改營運項。 |
| DeleteOpsItems | 大量刪除營運項 | 刪除營運項 |
服務組態
|
API |
標題 |
API概述 |
| CancelExecution | 取消執行 | 取消執行。 |
| ChangeResourceGroup | 更改資源群組 | 修改雲資源所屬的資源群組。 |
應用程式管理
|
API |
標題 |
API概述 |
| 應用程式 | 應用程式 | |
| CreateApplication | 建立一個應用 | 建立一個應用。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| DeleteApplication | 刪除一個應用 | 刪除一個應用。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| UpdateApplication | 更新應用 | 更新一個應用。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| GetApplication | 擷取一個應用的詳細資料 | 擷取一個應用的詳細資料。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| ListApplications | 查詢應用列表 | 查詢應用列表。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| 應用程式群組 | 應用程式群組 | |
| CreateApplicationGroup | 建立一個應用分組 | 建立一個應用分組。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| DeleteApplicationGroup | 刪除一個應用分組 | 刪除一個應用分組。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| UpdateApplicationGroup | 更新一個應用分組的資訊 | 更新一個應用分組的資訊。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| GetApplicationGroup | 擷取一個應用分組的詳細資料 | 擷取一個應用分組的詳細資料。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| ListApplicationGroups | 查詢應用分組列表 | 查詢應用分組列表。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| DeployApplicationGroup | 部署應用分組 | 部署應用分組。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| ContinueDeployApplicationGroup | 繼續部署應用分組 | 當應用分組部署失敗時，調用此介面繼續部署應用分組。應用管理的服務地區僅支援杭州，請使用杭州的endpoint。 |
| DescribeApplicationGroupBill | 查詢應用分組資源成本 | 查詢應用分組資源成本。 |
標籤
|
API |
標題 |
API概述 |
| ListTagKeys | 查詢已建立的標籤 | 查詢已建立的標籤。 |
| ListTagValues | 查詢已建立的標籤值 | 查詢已建立的標籤值。 |
| ListTagResources | 查詢資源標籤關係 | 查詢可見的資源標籤關係。 |
| UntagResources | 刪除使用者標籤資源關係 | 刪除使用者標籤資源關係，即可為資源刪除使用者標籤。 |
| TagResources | 建立標籤資源關係 | 建立標籤資源關係，即可為資源建立使用者標籤。 |
資源群組
|
API |
標題 |
API概述 |
| ChangeResourceGroup | 更改資源群組 | 修改雲資源所屬的資源群組。 |
擴充
|
API |
標題 |
API概述 |
| UpdateInstancePackageState | 更新執行個體安裝的擴充 | 更新執行個體安裝的擴充 |
| ListInstancePackageStates | 查詢某個執行個體已安裝的擴充 | 列出執行個體軟體包狀態 |
其他
|
API |
標題 |
API概述 |
| GenerateOpsItem | 產生營運項 | 產生營運項。 |
| GetTemplateParameterConstraints | Gets the available values for template parameters | 擷取參數可用值 |
| CheckGitRepoFileExists | 檢查指定倉庫檔案是否已存在 | 檢測倉庫中檔案是否存在 |
| CheckGitRepositoryExists | 檢查倉庫是否存在 | 檢測倉庫是否存在 |
| CreateChatConfiguration | 建立對話配置 | 用於建立、更新、查詢和刪除聊天配置，支援DingTalk等平台。 |
| CreateDeployRevision | 建立部署物 | 建立部署製品 |
| CreateGitRepository | 建立Git倉庫 | 建立倉庫 |
| DeleteChatConfiguration | 刪除對話配置 | 用於建立、更新、查詢和刪除聊天配置，支援DingTalk等平台。 |
| GetChatConfiguration | 查看對話配置 | 用於建立、更新、查詢和刪除聊天配置，支援DingTalk等平台。 |
| GetGitBranch | 擷取分支詳情 | 查詢Git分支詳情,支援查詢未授權的公開倉庫 |
| GetGitRepository | 查詢Git倉庫 | 查詢Git倉庫詳情 |
| ListChatConfigurations | 查看對話配置列表 | 用於建立、更新、查詢和刪除聊天配置，支援DingTalk等平台。 |
| ListGitAccounts | 列表已綁定的Git賬戶 | 擷取當前阿里雲使用者已授權在應用管理的託管平台賬戶 |
| ListGitBranches | 查詢指定倉庫的分支 | 擷取指定Git倉庫的所有分支 |
| ListGitOrganizations | 查詢登入賬戶的組織 | 擷取已授權使用者的組織 |
| ListGitRepositories | 列出倉庫 | 查詢Git倉庫列表 |
| ListGitRepositoryContents | 擷取倉庫檔案和目錄內容 | 擷取倉庫檔案與目錄資訊 |
| ListTaskExecutionInvocations | 擷取任務執行內部的雲助手命令執行ID | 擷取任務執行內部的雲助手命令執行ID |
| StartDebugExecution | 調試執行任務 | 啟動一個執行 |
| UpdateChatConfiguration | 更新對話配置 | 用於建立、更新、查詢和刪除聊天配置，支援DingTalk等平台。 |
| UpdateTemplateAttributes | 更新模板屬性 | 更新模板屬性 |