全部产品
Search
文档中心

:API简介

更新时间:Nov 30, 2023

欢迎您选择云服务器ECS(Elastic Compute Service),如果您熟悉网络服务协议和一种以上的编程语言,推荐您调用API管理您的云上资源和开发自己的应用程序,直接与云服务进行交互,实现自动化管理、灵活性和定制化的开发。

使用限制

根据您使用云服务器ECS资源的实际情况,您能创建的ECS实例、块存储、安全组、快照和实例公网带宽流量等资源均有数量和规格限制。更多信息,请参见使用限制

使用说明

ECS API支持HTTP或HTTPS网络请求协议,允许使用GET或POST方法。您可以通过以下任一方式调用ECS API:

  • 通过阿里云OpenAPI开发者门户,可以快速对ECS API进行调试。更多信息,请参见OpenAPI开发者门户

  • 通过云服务器ECS提供的软件开发工具包(SDK)调用ECS相关的API。更多信息,请参见SDK

  • 通过阿里云命令行工具(CLI),您可以在命令行Shell中使用aliyun命令与阿里云服务进行交互,管理您的阿里云资源。更多信息,请参见阿里云CLI

说明

在阿里云CLI及SDK中调用API时,部分带点号(.)的请求参数需要去掉点号(.)再使用。例如,使用SystemDiskCategory表示请求参数SystemDisk.Category

不同调用方式的示例操作,请参见快速入门

资源术语

中文

常见参数

说明

地域

RegionId

阿里云建设的数据中心。资源创建成功后无法更换地域。

可用区

ZoneId

同一地域内,电力和网络互相独立的物理数据中心。一个地域下可以有多个可用区。同一地域内的可用区之间内网互通并且故障隔离,云服务器ECS网络延时低。

实例

InstanceId

采用虚拟化技术从阿里云物理服务器上虚拟出来的虚拟机,是一台云服务器ECS的基本计算单位。更多信息,请参见实例规格族

预留实例券

ReservedInstanceId

一种抵扣券,可以抵扣按量付费实例(不包括抢占式实例)的账单,也能够预留实例资源。

实例启动模板

LaunchTemplateId

实例启动模板中包含了用于创建实例的配置信息,可以存储除了密码以外的任意配置信息,包括密钥对、RAM角色、实例类型和网络设置等。

弹性供应组

AutoProvisioningGroupId

一个使用抢占式实例和按量付费实例快速部署实例集群的方案,支持一键部署跨计费方式、跨可用区、跨实例规格族的实例集群。

镜像

ImageId

一般包含操作系统和应用软件。新建实例的系统盘数据完全拷贝镜像,包括操作系统、软件配置等。您可以使用镜像初始化实例或者更换系统盘。

块存储

DiskId

云服务器ECS的存储设备,根据性能表现和适用场景可分为云盘和本地盘。

安全组

SecurityGroupId

虚拟防火墙,一台实例至少属于一个安全组。

SSH密钥对

KeyPairName

由一对公钥和私钥组成的密钥对,采用SSH协议连接ECS实例,仅适用于Linux系统。

弹性网卡

NetworkInterfaceId

可以灵活绑定和解绑的辅助网卡设备,仅适用于专有网络(VPC)类型的ECS实例。

快照

SnapshotId

为云盘创建的数据还原点,包含特定时刻的云盘数据。快照可以用于还原云盘数据或创建镜像。

标签

Tag.N.Key

由一对键值对(Key-Value)组成,用于为资源绑定标签,便于快速筛选和分类。

IP地址

NatIPAddress

云服务器ECS的公网或私网IP地址。

云助手

CommandId

云服务器ECS的原生运维部署服务,无需远程连接实例,云助手便能帮您自动批量执行Bat、PowerShell或者Shell命令。