云服务器 ECS提供以下相关API接口。

实例

API 描述
RunInstances 调用RunInstances创建一台或多台按量付费或者包年包月ECS实例。
CreateInstance 调用CreateInstance创建一台包年包月或者按量付费ECS实例。
DescribeInstances 调用DescribeInstances查询一台或多台ECS实例的详细信息。
StartInstance 调用StartInstance启动一台实例。
RebootInstance 当一台ECS实例处于运行中(Running)状态时,调用RebootInstance可以重启这台实例。
StopInstance 调用StopInstance停止运行一台实例。
DeleteInstances 调用DeleteInstances释放一台或多台按量付费ECS实例或者到期的包年包月ECS实例。
DeleteInstance 调用DeleteInstance释放一台按量付费实例或者到期的包年包月实例。
AttachInstanceRamRole 调用AttachInstanceRamRole为一台或多台ECS实例授予 实例RAM角色。如果实例已有RAM角色,则报错提示您不能附加新的角色。
DetachInstanceRamRole 调用DetachInstanceRamRole收回一台或多台ECS实例的实例RAM角色。
DescribeInstanceStatus 调用DescribeInstanceStatus获取一台或多台ECS实例的状态信息。
RenewInstance 调用RenewInstance续费一台包年包月ECS实例。
ReactivateInstances 重新启动一台已过期或欠费回收中的按量付费 ECS 实例。
RedeployInstance 当ECS实例收到系统事件通知时,调用RedeployInstance可以重新部署这台实例。
DescribeInstanceVncUrl 查询一台ECS实例的Web管理终端地址。
DescribeUserData 调用DescribeUserData查询一台ECS实例的自定义数据。
DescribeInstanceAutoRenewAttribute 调用DescribeInstanceAutoRenewAttribute查询一台或多台包年包月ECS实例自动续费状态。
DescribeInstanceRamRole 调用DescribeInstanceRamRole查询一台或者多台ECS实例上的已赋予的实例RAM角色。
DescribeSpotPriceHistory 调用DescribeSpotPriceHistory查询抢占式实例近30天内的历史价格。
DescribeInstanceTypeFamilies 调用DescribeInstanceTypeFamilies查询云服务器ECS提供的实例规格族资源。
DescribeInstanceTypes 调用DescribeInstanceTypes查询云服务器ECS提供的实例规格资源。
ModifyInstanceVpcAttribute 调用ModifyInstanceVpcAttribute修改一台ECS实例的专有网络VPC属性。
ModifyInstanceAttribute 调用ModifyInstanceAttribute修改一台ECS实例的部分信息,包括实例密码、名称、描述、主机名和自定义数据等。如果是t5突发性能实例,可以切换这台实例的性能突发模式。
ModifyInstanceVncPasswd 调用ModifyInstanceVncPasswd修改一台ECS实例的Web管理终端密码。
ModifyInstanceAutoReleaseTime 调用ModifyInstanceAutoReleaseTime为一台按量付费ECS实例设定或者取消自动释放时间。设置自动释放时请谨慎操作,配置的时间到期后将自动释放ECS实例。
ModifyInstanceAutoRenewAttribute 调用ModifyInstanceAutoRenewAttribute设置一台或多台包年包月实例的自动续费状态。为了减少您的资源到期维护成本,包年包月ECS实例可以设置自动续费。
ModifyInstanceChargeType 调用ModifyInstanceChargeType更换一台或者多台ECS实例的计费方式。支持在按量付费实例和包年包月实例间相互转换,同时可以将实例挂载的所有按量付费云盘转换为包年包月云盘。
ModifyInstanceSpec 调用ModifyInstanceSpec调整一台按量付费ECS实例的实例规格和公网带宽大小。
ModifyPrepayInstanceSpec 调用ModifyPrepayInstanceSpec升级或者降低一台包年包月ECS实例的实例规格,新实例规格将会覆盖实例的整个生命周期。

启动模板

API 描述
CreateLaunchTemplate 调用CreateLaunchTemplate创建一个实例启动模板,简称模板。实例启动模板能免除您每次创建实例时都需要填入大量配置参数。
CreateLaunchTemplateVersion 调用CreateLaunchTemplateVersion根据指定的实例启动模板创建一个版本。
DeleteLaunchTemplate 调用DeleteLaunchTemplate删除一个实例启动模板。
DeleteLaunchTemplateVersion 调用DeleteLaunchTemplateVersion删除指定实例启动模板的一个版本。不支持删除默认版本,您需要通过 DeleteLaunchTemplate 删除整个实例启动模板才能删除默认版本。
DescribeLaunchTemplates 调用DescribeLaunchTemplates查询一个或多个可用的实例启动模板。
DescribeLaunchTemplateVersions 调用DescribeLaunchTemplateVersions查询实例启动模板版本。
ModifyLaunchTemplateDefaultVersion 调用ModifyLaunchTemplateDefaultVersion切换启动模板的某个版本为该模板的默认版本。如果您在创建实例(RunInstances)时不指定模板版本号,会采用默认版本。

弹性供应组

API 描述
CreateAutoProvisioningGroup 调用CreateAutoProvisioningGroup接口创建一个弹性供应组。
ModifyAutoProvisioningGroup 调用ModifyAutoProvisioningGroup接口修改一个弹性供应组的设置。
DeleteAutoProvisioningGroup 调用DeleteAutoProvisioningGroup接口删除一个弹性供应组。
DescribeAutoProvisioningGroups 调用DescribeAutoProvisioningGroups接口查询弹性供应组。
DescribeAutoProvisioningGroupInstances 调用DescribeAutoProvisioningGroupInstances查询指定弹性供应组下的实例。
DescribeAutoProvisioningGroupHistory 调用DescribeAutoProvisioningGroupHistory接口查询弹性供应组的调度任务信息。

块存储

API 描述
CreateDisk 调用CreateDisk创建一块按量付费或包年包月数据盘。云盘类型包括普通云盘、高效云盘、SSD云盘和ESSD云盘。
DeleteDisk 调用DeleteDisk释放一块按量付费数据盘。磁盘类型包括普通云盘、高效云盘、SSD云盘和ESSD云盘。
DescribeDisks 调用DescribeDisks查询一块或多块您已经创建的云盘以及本地盘。
AttachDisk 调用AttachDisk为一台ECS实例挂载一块按量付费数据盘。
DetachDisk 调用DetachDisk从一台实例上卸载一块按量付费磁盘。磁盘类型包括普通云盘、高效云盘和SSD云盘。
ModifyDiskChargeType 调用ModifyDiskChargeType修改一台实例上挂载的一块或最多16块云盘的计费方式。
ModifyDiskAttribute 调用ModifyDiskAttribute修改您的磁盘的属性或者明细。
ReplaceSystemDisk 调用ReplaceSystemDisk更换一台ECS实例的系统盘或者操作系统。
ReInitDisk 调用ReInitDisk重新初始化一块云盘到创建时的初始状态。
ResetDisk 调用ResetDisk使用磁盘的历史快照回滚至某一阶段的磁盘状态。
ResizeDisk 调用ResizeDisk扩容一块云盘,支持扩容系统盘和数据盘。
ModifyDiskSpec 调用ModifyDiskSpec升级一块ESSD云盘的性能等级。

预留实例券

API 描述
PurchaseReservedInstancesOffering 您可以调用PurchaseReservedInstancesOffering购买预留实例券,以自动匹配对应的物理实例,抵扣按量付费实例账单。
DescribeReservedInstances 您可以调用DescribeReservedInstances查询已经购买的预留实例券。
ModifyReservedInstances 您可以通过ModifyReservedInstances更改预留实例券。

镜像

API 描述
CreateImage 调用CreateImage创建一份自定义镜像。您可以使用创建的自定义镜像创建ECS实例(RunInstances)或者更换实例的系统盘(ReplaceSystemDisk)。
ImportImage 调用ImportImage导入您已有的镜像文件到云服务器ECS,并作为自定义镜像出现在相应地域中。
CopyImage 调用CopyImage复制一个地域下的自定义镜像到其他地域。您在其他地域可以使用复制后的镜像创建ECS实例(RunInstances)或者更换实例的系统盘(ReplaceSystemDisk)。
CancelCopyImage 调用CancelCopyImage取消正在进行中的复制镜像(CopyImage)任务。
ExportImage 调用ExportImage导出您的自定义镜像到与该自定义镜像同一地域的OSS Bucket里。
DescribeImages 调用DescribeImages查询您可以使用的镜像资源。
DeleteImage 调用DeleteImage删除一份自定义镜像。
DescribeImageSharePermission 调用DescribeImageSharePermission查询一份自定义镜像已经共享的所有用户。返回结果支持分页显示,每页的信息条目默认为 10 条。
ModifyImageAttribute 调用ModifyImageAttribute修改一份自定义镜像的名称或描述信息。
ModifyImageSharePermission 调用ModifyImageSharePermission管理镜像共享权限。您可以将自己的自定义镜像共享给其他阿里云用户,该用户可以使用共享的自定义镜像创建 ECS 实例(RunInstances)或者更换实例的系统盘(ReplaceSystemDisk)。
DescribeImageSupportInstanceTypes 调用DescribeImageSupportInstanceTypes查询指定镜像支持的实例规格。

快照

API 描述
CreateSnapshot 调用CreateSnapshot为一块云盘创建一份快照。
DeleteSnapshot 调用DeleteSnapshot删除指定的快照。如果需要取消正在创建的快照,也可以调用该接口删除快照,即取消创建快照任务。
DescribeSnapshots 调用DescribeSnapshots查询一台ECS实例或一块云盘所有的快照列表。InstanceId、DiskId和SnapshotIds不是必需参数,但是可以构建过滤器逻辑,参数之间为逻辑与(And)关系。
DescribeSnapshotsUsage 调用DescribeSnapshotsUsage查询您在一个地域下的快照数量以及快照容量。
DescribeSnapshotPackage 调用DescribeSnapshotPackage查询您在一个阿里云地域下已经购买的对象存储OSS存储包,存储包可以用于抵扣快照存储容量。
DescribeSnapshotLinks 调用DescribeSnapshotLinks查询云盘快照链。快照链是一块云盘所有快照组成的关系链,一块云盘对应一条快照链。
ModifySnapshotAttribute 调用ModifySnapshotAttribute修改一份快照的名称或描述。
CreateAutoSnapshotPolicy 调用CreateAutoSnapshotPolicy创建一条自动快照策略。
ApplyAutoSnapshotPolicy 为一块或者多块云盘应用自动快照策略。目标云盘已经应用了自动快照策略时,调用ApplyAutoSnapshotPolicy可以更换云盘当前应用的自动快照策略。
CancelAutoSnapshotPolicy 调用CancelAutoSnapshotPolicy取消一块或者多块云盘的自动快照策略。
DeleteAutoSnapshotPolicy 删除一条自动快照策略。如果目标自动快照策略已经被应用到磁盘上,删除自动快照策略后,这些磁盘不再执行该策略。
DescribeAutoSnapshotPolicyEX 调用DescribeAutoSnapshotPolicyEX查询您已创建的自动快照策略。
ModifyAutoSnapshotPolicyEx 调用ModifyAutoSnapshotPolicyEx修改一条自动快照策略。修改自动快照策略后,之前已应用该策略的云盘随即执行修改后的自动快照策略。

安全组

API 描述
CreateSecurityGroup 调用CreateSecurityGroup新建一个安全组。新建的安全组,默认只允许安全组内的实例互相访问,安全组外的一切通信请求会被拒绝。若您想允许其他安全组实例的通信请求,或者来自互联网的访问请求,需要授权安全组权限(AuthorizeSecurityGroup)。
AuthorizeSecurityGroup 调用AuthorizeSecurityGroup增加一条安全组入方向规则。指定安全组入方向的访问权限,允许或者拒绝其他设备发送入方向流量到安全组里的实例。
AuthorizeSecurityGroupEgress 调用AuthorizeSecurityGroupEgress增加一条安全组出方向规则。指定安全组出方向的访问权限,允许或者拒绝安全组里的实例发送出方向流量到其他设备。
RevokeSecurityGroup 调用RevokeSecurityGroup删除一条安全组入方向规则,撤销安全组入方向的权限设置。
RevokeSecurityGroupEgress 调用RevokeSecurityGroupEgress删除一条安全组出方向规则,撤销安全组出方向的访问权限。
JoinSecurityGroup 调用JoinSecurityGroup将一台ECS实例加入到指定的安全组。
LeaveSecurityGroup 调用LeaveSecurityGroup将一台ECS实例移出指定的安全组。
DeleteSecurityGroup 调用DeleteSecurityGroup删除一个安全组。
DescribeSecurityGroupAttribute 调用DescribeSecurityGroupAttribute查询一个安全组的详情。
DescribeSecurityGroups 调用DescribeSecurityGroups查询您创建的安全组的基本信息,例如安全组ID和安全组描述等。返回列表按照安全组ID降序排列。
DescribeSecurityGroupReferences 调用DescribeSecurityGroupReferences查询一个安全组和其他哪些安全组有安全组级别的授权行为。
ModifySecurityGroupAttribute 调用ModifySecurityGroupAttribute修改指定安全组的属性,包括修改安全组名称和描述。
ModifySecurityGroupEgressRule 调用ModifySecurityGroupEgressRule修改安全组出方向规则的描述信息。如果您还没有增加过安全组规则,可以调用 AuthorizeSecurityGroupEgress 增加。
ModifySecurityGroupPolicy 调用ModifySecurityGroupPolicy修改安全组内网连通策略。
ModifySecurityGroupRule 调用ModifySecurityGroupRule修改安全组入方向规则的描述信息。如果您还没有增加过安全组规则,可以调用AuthorizeSecurityGroup增加。

部署集

API 描述
CreateDeploymentSet 调用CreateDeploymentSet在指定的地域内创建一个部署集。
ModifyInstanceDeployment 调用ModifyInstanceDeployment在同一地域下,修改一台ECS实例的宿主机。
ModifyDeploymentSetAttribute 调用ModifyDeploymentSetAttribute修改一个部署集的名称和描述信息。
DeleteDeploymentSet 调用DeleteDeploymentSet删除一个部署集。
DescribeDeploymentSets 调用DescribeDeploymentSets查询一个或多个部署集的属性列表。

SSH密钥对

API 描述
CreateKeyPair 调用CreateKeyPair创建一对SSH密钥对。我们会为您保管密钥的公钥部分,并返回未加密的PEM编码的PKCS#8格式私钥。您需要自行妥善保管私钥部分。
ImportKeyPair 调用ImportKeyPair导入由其他工具产生的RSA密钥对的公钥部分。导入密钥对后,阿里云为您保管公钥部分,您需要自行妥善保存密钥对的私钥部分。
AttachKeyPair 调用AttachKeyPair绑定一个SSH密钥对到一台或多台Linux实例。
DetachKeyPair 调用DetachKeyPair为一台或者多台Linux实例解绑 SSH 密钥对。
DeleteKeyPairs 调用DeleteKeyPairs删除一对或者多对 SSH 密钥对。删除 SSH 密钥对后,我们不再为您保存该 SSH 密钥对,但是已经绑定的实例可以正常使用该 SSH 密钥对,其 SSH 密钥对名称仍然显示在实例详情中。
DescribeKeyPairs 调用DescribeKeyPairs查询一个或多个密钥对。

网络

API 描述
AllocatePublicIpAddress 调用AllocatePublicIpAddress为一台ECS实例分配一个公网IP地址。
ConvertNatPublicIpToEip 调用ConvertNatPublicIpToEip将一台网络类型为专有网络VPC的ECS实例的公网 IP(NatPublicIp)转化为弹性公网IP(EIP)。
AttachClassicLinkVpc 调用AttachClassicLinkVpc将一台经典网络类型实例连接到专有网络VPC中,使经典网络类型实例可以和VPC中的云资源私网互通。
DetachClassicLinkVpc 调用DetachClassicLinkVpc取消经典网络类型实例与专有网络 VPC 的连接(ClassicLink)。取消 ClassicLink 后,经典网络类型实例无法与 VPC 互通。
DescribeBandwidthLimitation 查询带宽资源列表。
DescribeClassicLinkInstances 调用DescribeClassicLinkInstances查询一台或多台与专有网络 VPC 建立了连接的经典网络类型实例。
ModifyInstanceNetworkSpec 调用ModifyInstanceNetworkSpec修改实例的带宽配置。当实例现有网络规格不满足要求时,可以通过修改实例的带宽配置提高网络性能。

弹性网卡

API 描述
CreateNetworkInterface 调用CreateNetworkInterface创建一个弹性网卡(ENI)。
AttachNetworkInterface 调用AttachNetworkInterface附加弹性网卡(ENI)到专有网络(VPC)类型实例上。
AssignPrivateIpAddresses 调用AssignPrivateIpAddresses为一块弹性网卡分配一个或多个辅助私有IP地址。可以为网卡指定在所属虚拟交换机(VSwitch)的CIDR私有IP地址,或者通过指定私有网络地址数量自动创建私有IP地址。
UnassignPrivateIpAddresses 调用UnassignPrivateIpAddresses从一块弹性网卡删除一个或多个辅助私有IP地址。
DetachNetworkInterface 调用DetachNetworkInterface从一台实例上分离一个弹性网卡(ENI)。
DeleteNetworkInterface 调用DeleteNetworkInterface删除一个弹性网卡(ENI)。
DescribeNetworkInterfaces 调用DescribeNetworkInterfaces查看弹性网卡(ENI)列表。
ModifyNetworkInterfaceAttribute 调用ModifyNetworkInterfaceAttribute修改一个弹性网卡(ENI)的属性。例如,弹性网卡名称、描述以及所属安全组等。
AssignIpv6Addresses 调用AssignIpv6Addresses为弹性网卡分配一个或多个IPv6地址。
UnassignIpv6Addresses 若弹性网卡已被分配了IPv6地址,调用UnassignIpv6Addresses可以回收一个或多个IPv6地址。

系统事件

API 描述
DescribeInstancesFullStatus 调用DescribeInstancesFullStatus查询一台或多台实例的全状态信息。全状态信息包括实例状态和实例系统事件状态,其中,实例状态为实例的生命周期状态,实例系统事件为维护事件的健康状态。
DescribeInstanceHistoryEvents 调用DescribeInstanceHistoryEvents查询指定实例的系统事件信息,默认查询处于非活跃状态的历史系统事件。
DescribeDisksFullStatus 调用DescribeDisksFullStatus查询一块或多块块存储的全部状态信息。
CancelSimulatedSystemEvents 调用CancelSimulatedSystemEvents取消一件或多件处于Scheduled(计划中)或Executing(执行中)状态的模拟系统事件。取消系统事件后,模拟事件变为Canceled(已取消)状态。
CreateSimulatedSystemEvents 调用CreateSimulatedSystemEvents为一台或多台ECS实例预约模拟系统事件。模拟系统事件相当于事件演习,不会真正执行事件,也不会对ECS实例产生影响。

运维与监控

API 描述
DescribeEniMonitorData 调用DescribeEniMonitorData查询一块辅助网卡在指定时间段内使用的流量信息。
DescribeDiskMonitorData 调用DescribeDiskMonitorData查询一块云盘指定时间内的使用信息。可查询云盘实用信息包括读IOPS、写IOPS、读带宽(Bps)、写带宽(Bps)、读时延(μs)以及写时延(μs)。若查询的信息中出现内容缺失,是因为我们无法获取该段时间的使用信息,即云盘状态不是使用中(In_Use)。
DescribeInstanceMonitorData 调用DescribeInstanceMonitorData查询一台 ECS 实例所有相关的监控信息。返回的监控内容包括 ECS 实例的 CPU 使用率、接收的数据流量、发送的数据流量、网络流量、平均带宽。当返回信息中缺少部分内容时,可能是由于系统没有获取到相应的信息,比如当时实例处于已停止(Stopped)状态。
GetInstanceScreenshot 调用GetInstanceScreenshot获取实例的截屏信息。
GetInstanceConsoleOutput 调用GetInstanceConsoleOutput获取一台实例的系统命令行输出,数据以Base64编码后返回。

云助手

API 描述
CreateCommand 调用CreateCommand新建一条云助手命令。
InstallCloudAssistant 调用InstallCloudAssistant为一台或多台实例安装云助手客户端。
InvokeCommand 调用InvokeCommand为一台或多台ECS实例触发一条云助手命令。
StopInvocation 调用StopInvocation停止一台或多台ECS实例中一条正在进行中(Running)的云助手命令进程。
DeleteCommand 调用DeleteCommand删除一条云助手命令。
DescribeCloudAssistantStatus 调用DescribeCloudAssistantStatus查询一台或者多台实例是否安装了云助手客户端。
DescribeCommands 调用DescribeCommands查询您已经创建的云助手命令。只输入参数Action和RegionId,不输入其他任何请求参数,则默认查询您所有可用的命令(CommandId)。
DescribeInvocations 调用DescribeInvocations查询最近两周云助手命令的执行列表和状态。
DescribeInvocationResults 调用DescribeInvocationResults查看云助手命令的执行结果,在指定ECS实例中的实际执行结果。

高性能集群

API 描述
CreateHpcCluster 调用CreateHpcCluster创建一个HPC集群。
DeleteHpcCluster 调用DeleteHpcCluster删除一个HPC集群。
DescribeHpcClusters 调用DescribeHpcClusters查询您可用的HPC集群。请求参数作为筛选器(Filter)使用,筛选关系为逻辑与(&&)关系,参数之间无依赖关系。
ModifyHpcClusterAttribute 调用ModifyHpcClusterAttribute修改一个HPC集群的描述信息。

标签

API 描述
TagResources 调用TagResources为指定的ECS资源列表统一创建并绑定标签。
ListTagResources 调用ListTagResources查询一个或多个ECS资源已经绑定的标签列表。
UntagResources 调用UntagResources为指定的ECS资源列表统一解绑并删除标签。

地域

API 描述
DescribeRegions 调用DescribeRegions查询您可以使用的阿里云地域。
DescribeZones 调用DescribeZones查询一个阿里云地域下的可用区。
DescribeResourcesModification 调用DescribeResourcesModification查询升级和降配实例规格或者系统盘时,某一可用区的可用资源信息。
DescribeAvailableResource 调用DescribeAvailableResource查询某一可用区的资源列表。例如,您可以在某一可用区创建实例(RunInstances)或者修改实例规格(ModifyInstanceSpec)时查询该可用区的资源列表。

其他接口

API 描述
CancelTask 调用CancelTask取消一件正在运行的任务。目前,您能取消正在运行的导入镜像任务(ImportImage)和导出镜像任务(ExportImage)。
DescribeTasks 调用DescribeTasks查询一个或多个异步请求的进度。
DescribeTaskAttribute 调用DescribeTaskAttribute查询异步任务的详细信息。目前,可以查询的异步任务有导入镜像(ImportImage)和导出镜像(ExportImage)两种。
DescribeAccountAttributes 调用DescribeAccountAttributes查询您在一个阿里云地域下能创建的ECS资源配额。包括您能创建的安全组数量、弹性网卡数量、按量付费vCPU核数、抢占式实例vCPU核数、专用宿主机数量、地域网络类型以及账号是否已完成实名认证。
DescribePrice (Beta)调用DescribePrice查询云服务器ECS资源的最新价格。