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概述 |
| GetGitRepository | 查詢 Git 儲存庫。 | 查詢 Git 儲存庫詳情。 |
| DescribeRegions | 查詢目前支援的地區情況。 | 呼叫此 API 查詢目前支援的地區情況。 |
範本
|
API |
標題 |
API概述 |
| CreateTemplate | 建立一個範本。 | 建立一個範本。 |
| DeleteTemplates | 刪除多個範本。 | 呼叫此 API 刪除多個範本。 |
| DeleteTemplate | 刪除一個範本。 | 刪除一個範本。 |
| UpdateTemplate | 更新一個已存在的範本。 | 更新一個已存在的範本。 |
| ListTemplateVersions | 查詢一個範本的多個版本物件。 | 查詢一個範本的多個版本物件。 |
| ListTemplates | 查詢範本。 | 支援多種篩選方式。 |
| GetTemplate | 取得範本。 | 取得一個範本，包括內容。 |
| ListExecutionRiskyTasks | 取得範本中的高風險任務。 | 取得範本中的高風險任務。 |
| ValidateTemplateContent | 驗證範本是否合法。 | 驗證範本是否合法。 |
| UpdateTemplateAttributes | 更新範本屬性。 | 更新範本屬性。 |
| GetTemplateParameterConstraints | 取得範本參數的可用值。 | 取得參數可用值。 |
執行
|
API |
標題 |
API概述 |
| DeleteExecutions | 刪除執行個體。 | 刪除執行個體。 |
| StartExecution | 啟動一個執行個體。 | 啟動一個執行個體。 |
| UpdateExecution | 更新未結束的執行個體。 | 更新未結束（處於 Running、Waiting 狀態）的執行個體。 |
| GetExecutionTemplate | 取得執行所使用的範本。 | 取得執行所使用的範本，包含內容。 |
| ListExecutions | 查詢執行個體。 | 查詢執行個體，支援多種篩選方式。 |
| ListExecutionLogs | 取得執行的詳細記錄。 | 取得執行的詳細記錄。 |
| ListTaskExecutions | 查詢任務執行。 | 查詢任務執行，支援多種篩選方式。 |
| ListResourceExecutionStatus | 檢視包含 ECS 執行個體的排程維運執行資訊。 | 檢視包含 ECS 執行個體的排程維運執行資訊。 |
| CancelExecution | 取消執行。 | 取消執行。 |
| GenerateExecutionPolicy | 取得執行所需 RAM Policy。 | 取得範本執行所需的 RAM Policy。 |
| NotifyExecution | 通知執行如何運行。 | 通知一個狀態為等待中的執行接下來如何運行。 |
| TriggerExecution | 執行事件觸發。 | 事件觸發器或警示觸發器任務，可對該類執行個體傳送訊息體內容，訊息體會使事件或警示任務產生一個新的子執行個體。 |
| StartDebugExecution | 偵錯執行任務。 | 啟動一個執行個體。 |
| ListTaskExecutionInvocations | 取得任務執行內部的雲端助手命令執行 ID。 | 取得任務執行內部的雲端助手命令執行 ID。 |
動作
|
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概述 |
| 修補程式基準 | 修補程式基準 | |
| CreatePatchBaseline | 建立修補程式基準。 | 建立一個修補程式基準。 |
| DeletePatchBaseline | 刪除修補程式基準。 | 刪除一個修補程式基準。 |
| UpdatePatchBaseline | 更新修補程式基準。 | 更新一個修補程式基準。 |
| GetPatchBaseline | 取得修補程式基準。 | 取得修補程式基準的詳細資訊。 |
| ListPatchBaselines | 列出修補程式基準。 | 取得修補程式基準清單。 |
| RegisterDefaultPatchBaseline | 註冊預設修補程式基準。 | 註冊預設修補程式基準。 |
| 修補程式狀態 | 修補程式狀態 | |
| ListInstancePatchStates | 列出執行個體修補程式狀態。 | 取得執行個體修補程式資訊。 |
| ListInstancePatches | 列出執行個體修補程式。 | 取得執行個體修補程式資訊。 |
組態清單
|
API |
標題 |
API概述 |
| ListInventoryEntries | 查詢一個執行個體下的設定清單記錄。 | 查詢一個執行個體下的設定清單記錄。 |
| GetInventorySchema | 取得組態清單的模式資訊。 | 取得組態清單的模式資訊。 |
| SearchInventory | 查詢組態清單的詳細資訊或彙總資訊。 | 查詢組態清單的詳細資訊或彙總資訊。 |
最終狀態組態
|
API |
標題 |
API概述 |
| CreateStateConfiguration | 建立一個終態設定。 | 建立終態設定。 |
| DeleteStateConfigurations | 刪除多個終態設定。 | 批次刪除終態設定。 |
| UpdateStateConfiguration | 更新一個終態組態。 | 更新終態組態。 |
| ListStateConfigurations | 查詢終態組態。 | 查詢終態組態。 |
維運項目
|
API |
標題 |
API概述 |
| CreateOpsItem | 建立維運項目。 | 建立維運項目。 |
| GetOpsItem | 取得維運項目。 | 取得維運項目詳細資訊。 |
| ListOpsItems | 查詢維運項目。 | 查詢維運項目。 |
| UpdateOpsItem | 更新維運項目。 | 修改維運項目。 |
| DeleteOpsItems | 批次刪除維運項目。 | 刪除維運項目。 |
| GenerateOpsItem | 產生維運項目。 | 產生維運項目。 |
服務組態
|
API |
標題 |
API概述 |
| SetServiceSettings | 設定服務設定。 | 開啟或關閉範本執行記錄的投遞功能，以及投遞儲存地點，關聯雲效企業 ID。 |
| GetServiceSettings | 取得服務設定資訊。 | 取得服務的設定資訊，包括執行記錄投遞功能的設定、關聯的雲效企業等。 |
應用程式管理
|
API |
標題 |
API概述 |
| 應用程式 | 應用程式 | |
| CreateApplication | 建立一個應用程式。 | 建立一個應用程式。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| DeleteApplication | 刪除一個應用程式。 | 刪除一個應用程式。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| UpdateApplication | 更新應用程式。 | 更新一個應用程式。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| GetApplication | 取得一個應用程式的詳細資訊。 | 取得一個應用程式的詳細資訊。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| ListApplications | 查詢應用程式清單。 | 查詢應用程式清單。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| ListDeployRevisions | 查詢部署物列表 | 查詢部署物列表 |
| CreateDeployRevision | 建立部署成品。 | 建立部署成品。 |
| GetDeployRevision | 查詢應用部署物詳情 | 查詢應用部署物詳情 |
| 應用程式群組 | 應用程式群組 | |
| CreateApplicationGroup | 建立一個應用程式分組。 | 建立一個應用程式分組。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| DeleteApplicationGroup | 刪除一個應用程式分組。 | 刪除一個應用程式分組。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| UpdateApplicationGroup | 更新一個應用程式分組的資訊。 | 更新一個應用程式分組的資訊。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| GetApplicationGroup | 取得一個應用程式群組的詳細資訊。 | 取得一個應用程式群組的詳細資訊。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| ListApplicationGroups | 查詢應用程式分組列表。 | 查詢應用程式分組列表。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| DeployApplicationGroup | 部署應用程式分組。 | 部署應用程式分組。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| ContinueDeployApplicationGroup | 繼續部署應用程式分組。 | 當應用程式分組部署失敗時，呼叫此介面繼續部署應用程式分組。應用程式管理的服務地域僅支援杭州，請使用杭州的 endpoint。 |
| DescribeApplicationGroupBill | 查詢應用程式分組資源成本。 | 查詢應用程式分組資源成本。 |
Git
|
API |
標題 |
API概述 |
| CheckGitRepoFileExists | 檢查指定儲存庫檔案是否已存在。 | 檢測儲存庫中檔案是否存在。 |
| ListGitOrganizations | 查詢登入帳號的組織。 | 取得已授權使用者的組織。 |
| ListGitRepositories | 列出儲存庫。 | 查詢 Git 儲存庫清單。 |
| CreateGitRepository | 建立 Git 儲存庫。 | 建立儲存庫。 |
| ListGitAccounts | 列出已綁定的 Git 帳戶。 | 取得目前阿里雲使用者已授權在應用程式管理的託管平台帳戶。 |
| ListGitBranches | 查詢指定儲存庫的分支。 | 取得指定 Git 儲存庫的所有分支。 |
| CheckGitRepositoryExists | 檢查儲存庫是否存在。 | 檢測儲存庫是否存在。 |
| GetGitBranch | 取得分支詳情。 | 查詢 Git 分支詳情，支援查詢未授權的公開儲存庫。 |
| ListGitRepositoryContents | 取得儲存庫檔案和目錄內容。 | 取得儲存庫檔案與目錄資訊。 |
標籤
|
API |
標題 |
API概述 |
| ListTagKeys | 查詢已建立的標籤。 | 查詢已建立的標籤。 |
| ListTagValues | 查詢已建立的標籤值。 | 查詢已建立的標籤值。 |
| ListTagResources | 查詢資源標籤關係。 | 查詢可見的資源標籤關係。 |
| UntagResources | 刪除使用者標籤資源關係。 | 刪除使用者標籤資源關係，即可為資源刪除使用者標籤。 |
| TagResources | 建立標籤資源關係。 | 建立標籤資源關係，即可為資源建立使用者標籤。 |
資源群組
|
API |
標題 |
API概述 |
| ChangeResourceGroup | 變更資源群組。 | 修改雲端資源所屬的資源群組。 |
擴充
|
API |
標題 |
API概述 |
| UpdateInstancePackageState | 更新執行個體安裝的擴充功能。 | 更新執行個體安裝的擴充功能。 |
| ListInstancePackageStates | 查詢某個執行個體已安裝的擴充功能。 | 列出執行個體軟體套件狀態。 |
AI 助手組態
|
API |
標題 |
API概述 |
| CreateChatConfiguration | 建立對話設定。 | 用於建立、更新、查詢及刪除聊天設定，支援釘釘等平台。 |
| UpdateChatConfiguration | 更新對話設定。 | 用於建立、更新、查詢和刪除聊天設定，支援釘釘等平台。 |
| GetChatConfiguration | 檢視對話設定。 | 用於建立、更新、查詢和刪除聊天設定，支援釘釘等平台。 |
| ListChatConfigurations | 檢視對話設定清單。 | 用於建立、更新、查詢和刪除聊天設定，支援釘釘等平台。 |
| DeleteChatConfiguration | 刪除對話設定。 | 用於建立、更新、查詢及刪除聊天設定，支援釘釘等平台。 |