使用编程方式在业务系统中集成云服务器 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诊断平台进行自助诊断。