本產品（
系統運維管理/2019-06-01）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
地域
| API | 標題 | API概述 |
|---|---|---|
| DescribeRegions | 查詢當前支持的地域情況 | 調用該API查詢當前支持的地域情況。 |
模板
| API | 標題 | API概述 |
|---|---|---|
| CreateTemplate | 創建一個模版 | 創建一個模版。 |
| DeleteTemplates | 刪除多個模版 | 調用該API刪除多個模版。 |
| 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概述 |
|---|---|---|
| 補丁基線 | 補丁基線 | |
| 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 | 更新運維項 | 修改運維項。 |
服務配置
| API | 標題 | API概述 |
|---|---|---|
| SetServiceSettings | 設置服務配置 | 開啟或關閉模板執行記錄的投遞功能，以及投遞存儲地點，關聯云效企業ID。 |
| GetServiceSettings | 獲取服務配置信息 | 獲取服務的配置信息，包括執行記錄投遞功能的配置、關聯的云效企業等。 |
應用管理
| 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 | 查詢某個實例已安裝的擴展 | 列出實例軟件包狀態 |