使用編程方式在業務系統中集成云服務器 ECS(Elastic Compute Service)的能力,使系統能夠自動化地創建ECS實例、創建ECS快照、查詢ECS實例資源、ECS實例運行狀態以及管理ECS安全組、ECS云盤等資源,簡化運營、管理成本。本文為您介紹云服務器 ECS開放的OpenAPI及支持的集成方式。
ECS OpenAPI
想了解OpenAPI的完整調用鏈路流程及涉及到的身份、授權、憑證等信息,請參見什么是OpenAPI。
在線調試
云服務器 ECS在OpenAPI門戶提供API調試等功能。在調用前,您需要了解云服務器 ECS提供的版本、接入點說明、集成方式等信息。
版本說明
阿里云OpenAPI通過版本號管控各時期云產品大版本的API列表,例如云服務器 ECS目前支持2014-05-26
版本的API列表,2014-05-26
代表的是API版本號而非時間概念,所展示的都是最新的API公開數據,并非自2014-05-26
之后就未更新。
版本號 | 說明 |
推薦使用。 包含云服務器 ECS實例、鏡像、快照、安全組、密鑰對、塊存儲等基礎功能。 | |
包含塊存儲EBS異步復制、數據洞察、專屬塊存儲集群等高階功能。 |
服務接入點說明
服務接入點是訪問阿里云服務的入口點。根據相關資源所在地域,選擇對應的服務接入點地址,以獲得最低延遲。例如華東1(杭州)的云服務器 ECS公網接入地址為ecs-cn-hangzhou.aliyuncs.com
,VPC接入地址為ecs-vpc.cn-hangzhou.aliyuncs.com
。
公網接入地址在全球都可訪問。
VPC接入地址只有在阿里云對應的地域內,且是VPC網絡類型才可訪問。VPC接入地址的優勢:
高安全性:VPC服務地址只能在VPC內部訪問,提供更高的安全性和隱私性。
更快的響應速度:由于VPC服務地址在VPC內部網絡中運行,其響應速度通常比公網服務更快,且可以避免公網延遲和帶寬限制等問題。
更低的成本:VPC服務地址可以使用內部網絡通信。
更多信息,請參見服務接入點。
支持的調用身份
您阿里云賬號登錄OpenAPI網站后,OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調試。阿里云賬號擁有所有API的訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。ECS對于以下用戶身份訪問OpenAPI的支持情況如下表所示:
用戶身份 | 支持情況 |
支持 | |
RAM 用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
集成方式
SDK是最易于集成,且支持度最好的OpenAPI調用方式,推薦您選擇使用SDK。
ECS支持通過SDK、CLI等方式管理云上資源,具體的支持情況如下表所示:
集成方式 | 支持情況 |
阿里云SDK(推薦) | 支持 |
阿里云CLI | 支持 說明
|
Terraform | 支持 說明
|
資源編排ROS | 支持 說明
|
自定義封裝API調用 | 支持 說明
|
注意事項
如果調用云服務器 ECS API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。更多信息,請參見公共錯誤碼。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。