集成概覽
系統(tǒng)運(yùn)維管理提供可視化操作控制臺,還提供OpenAPI在線調(diào)試、阿里云SDK、阿里云CLI、Terraform、資源編排ROS等調(diào)用方式。為提升您使用系統(tǒng)運(yùn)維管理的開發(fā)效率,建議您按需選擇合適的操作和集成方式。
OpenAPI介紹
為了能夠讓開發(fā)者快速高效地學(xué)習(xí)和使用云產(chǎn)品OpenAPI,阿里云為用戶提供OpenAPI網(wǎng)站。它是一款集OpenAPI智能搜索、文檔、在線調(diào)試、SDK獲取、CodeSample、調(diào)用出錯(cuò)診斷、調(diào)用統(tǒng)計(jì)為一體的產(chǎn)品。您可以在OpenAPI門戶中調(diào)用阿里云各云產(chǎn)品開放的OpenAPI,查看OpenAPI請求和返回結(jié)果。此外,OpenAPI門戶會自動生成相應(yīng)的SDK調(diào)用示例,幫助您快速使用阿里云產(chǎn)品。更多信息,請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控各時(shí)期云產(chǎn)品大版本的API列表,例如系統(tǒng)運(yùn)維管理目前支持2019-06-01
版本的API列表,2019-06-01
代表的是API版本號而非時(shí)間概念,所展示的都是最新的API公開數(shù)據(jù),并非自2019-06-01
之后就未更新。
版本號 | 說明 |
推薦使用 |
在線調(diào)試
系統(tǒng)運(yùn)維管理在OpenAPI門戶提供API調(diào)試等功能。在調(diào)用前,您需要了解系統(tǒng)運(yùn)維管理提供的版本、接入點(diǎn)說明、集成方式等信息。
調(diào)試入口
調(diào)試API入口為:系統(tǒng)運(yùn)維管理API調(diào)試列表
接入點(diǎn)說明
根據(jù)相關(guān)資源所在地域,選擇對應(yīng)的服務(wù)接入點(diǎn)地址,以獲得最低延遲。例如華北3(張家口)的系統(tǒng)運(yùn)維管理公網(wǎng)接入地址為oos.cn-zhangjiakou.aliyuncs.com
,VPC接入地址為oos-vpc.cn-zhangjiakou.aliyuncs.com
。
公網(wǎng)接入地址在全球都可訪問。
VPC接入地址只有在阿里云對應(yīng)的地域內(nèi),且是VPC網(wǎng)絡(luò)類型才可訪問。VPC地址的優(yōu)勢:
高安全性:VPC服務(wù)地址只能在VPC內(nèi)部訪問,提供更高的安全性和隱私性。
更快的響應(yīng)速度:由于VPC服務(wù)地址在VPC內(nèi)部網(wǎng)絡(luò)中運(yùn)行,其響應(yīng)速度通常比公網(wǎng)服務(wù)更快,且可以避免公網(wǎng)延遲和帶寬限制等問題。
更低的成本:VPC服務(wù)地址可以使用內(nèi)部網(wǎng)絡(luò)通信。
更多信息,請參見服務(wù)接入點(diǎn)。
用戶身份
您阿里云賬號登錄OpenAPI網(wǎng)站后,OpenAPI默認(rèn)使用您的阿里云賬號進(jìn)行在線OpenAPI調(diào)試。阿里云賬號擁有所有API的訪問權(quán)限,風(fēng)險(xiǎn)很高。強(qiáng)烈建議您創(chuàng)建并使用RAM用戶進(jìn)行API訪問或日常運(yùn)維。請根據(jù)業(yè)務(wù)的實(shí)際情況按需分配權(quán)限后進(jìn)行接口調(diào)用。RAM用戶需具備管理系統(tǒng)運(yùn)維管理資源的權(quán)限。具體操作,請參見使用RAM進(jìn)行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM 用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
更多信息
集成方式
SDK是最易于集成,且支持度最好的OpenAPI調(diào)用方式,推薦您選擇使用SDK。
集成方式總覽
調(diào)用方式 | 支持情況 |
支持 | |
支持 | |
支持 | |
支持 | |
支持 |
阿里云SDK
阿里云為開發(fā)者提供了多種編程語言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等)的SDK。開發(fā)者只需要集成SDK,通過SDK暴露的方法直接調(diào)用OpenAPI 。SDK統(tǒng)一封裝了簽名邏輯、超時(shí)機(jī)制、重試機(jī)制,并根據(jù)文檔返回結(jié)構(gòu)化Response對象,易于開發(fā)。更多關(guān)于阿里云SDK的介紹,請參見阿里云SDK。
支持通過阿里云SDK調(diào)用系統(tǒng)運(yùn)維管理。支持語言及依賴安裝方法請參見系統(tǒng)運(yùn)維管理SDK。
阿里云CLI
Terraform
Terraform 是一種開源工具,用于安全高效地預(yù)覽,配置和管理云基礎(chǔ)架構(gòu)和資源。它與阿里云的資源編排服務(wù)的運(yùn)行機(jī)制類似,通過將模板轉(zhuǎn)化為內(nèi)部數(shù)據(jù)后完成 OpenAPI 調(diào)用。更多詳情,請參見什么是Terraform。
支持Terraform編排和使用系統(tǒng)運(yùn)維管理,支持部分普通資源和數(shù)據(jù)資源清單,請參見系統(tǒng)運(yùn)維管理Terraform資源和數(shù)據(jù)源。
快速使用Terraform編排系統(tǒng)運(yùn)維管理,請參見Terraform集成示例。
資源編排ROS
資源編排服務(wù)ROS(Resource Orchestration Service)是阿里云提供的一項(xiàng)簡化云計(jì)算資源管理的服務(wù)。開發(fā)者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS 實(shí)例、RDS 數(shù)據(jù)庫實(shí)例)、資源間的依賴關(guān)系等。ROS 的編排引擎將根據(jù)模板自動完成所有資源的創(chuàng)建和配置,實(shí)現(xiàn)自動化部署及運(yùn)維。更多詳情,請參見什么是資源編排服務(wù)。
支持使用資源編排服務(wù)ROS調(diào)用系統(tǒng)運(yùn)維管理,請參見資源編排ROS集成示例。
自定義封裝API調(diào)用
原生HTTP調(diào)用需要您自行實(shí)現(xiàn)簽名算法,并構(gòu)建自定義請求,發(fā)起HTTP調(diào)用。有關(guān)簽名機(jī)制的更多詳細(xì)信息,請參見系統(tǒng)運(yùn)維管理API概覽和V3版本請求體&簽名機(jī)制。
注意事項(xiàng)
如果調(diào)用系統(tǒng)運(yùn)維管理API后返回錯(cuò)誤,您需要根據(jù)返回的錯(cuò)誤碼提示檢查傳入的請求參數(shù)及其取值是否正確。
您也可以記錄下調(diào)用返回的RequestID或SDK報(bào)錯(cuò)信息,通過阿里云OpenAPI診斷平臺進(jìn)行自助診斷。
常見問題
阿里云系統(tǒng)運(yùn)維管理是阿里云提供的云上自動化運(yùn)維服務(wù),能夠自動化管理和執(zhí)行任務(wù)。您可以通過模板來定義執(zhí)行任務(wù)、執(zhí)行順序、執(zhí)行輸入和輸出,然后通過執(zhí)行模板來完成任務(wù)的自動化運(yùn)行。了解更多產(chǎn)品信息,請參見什么是系統(tǒng)運(yùn)維管理。
系統(tǒng)運(yùn)維管理支持的SDK語言,請參見系統(tǒng)運(yùn)維管理SDK參考。