全部产品
Search
文档中心

云服务器 ECS:API概览

更新时间:Dec 13, 2024
本产品(云服务器 ECS/2014-05-26)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

地域

API标题API概述
DescribeRegions查询地域列表根据计费方式、资源类型等参数查询地域信息列表。
DescribeZones查询可用区列表根据地域ID、计费方式等参数查询可用区信息列表。
DescribeAvailableResource查询可用区的资源库存查询可用区的资源库存状态。您可以在某一可用区创建实例(RunInstances)或者修改实例规格(ModifyInstanceSpec)时查询该可用区的资源库存状态。
DescribeAccountAttributes查询某地域下能创建的资源配额调用DescribeAccountAttributes查询您在一个阿里云地域下能创建的ECS资源配额。包括您能创建的安全组数量、弹性网卡数量、按量付费vCPU核数、抢占式实例vCPU核数、按量付费云盘总容量配额、专用宿主机数量、网络类型以及账号是否已完成实名认证。
DescribeResourcesModification变更实例规格或系统盘类型之前,查询某一可用区下实例规格或系统盘的库存情况调用DescribeResourcesModification变更实例规格或系统盘类型之前,查询某一可用区下实例规格或系统盘的库存情况。
DescribeRecommendInstanceType查找备选实例规格(Beta)调用DescribeRecommendInstanceType根据一个指定的实例规格,查找一个或多个备选的实例规格。针对已经或者即将停售的实例规格,DescribeRecommendInstanceType会罗列出作为替补的所有实例规格。

询价

API标题API概述
DescribePrice查询云服务器ECS资源的最新价格调用DescribePrice接口,并可以指定ResourceType、ImageId、InstanceType等参数,查询云服务器ECS资源的最新价格,例如活动规则、价格、折扣等信息。
DescribeRenewalPrice查询资源续费价格调用DescribeRenewalPrice查询云服务器ECS资源的续费价格。仅支持查询包年包月资源的续费价格。
DescribeInstanceModificationPrice查询未到期的包年包月ECS实例升配时目标实例规格的价格信息、新增包年包月数据盘的价格信息调用DescribeInstanceModificationPrice查询未到期的包年包月ECS实例升配时目标实例规格的价格信息、新增包年包月数据盘的价格信息。

实例

API标题API概述
RunInstances批量创建实例本接口旨在为您提供便捷、高效的方式来创建按量付费或包年包月的 ECS 实例。它拥有一系列强大的功能和特性,不仅可以单次创建多台实例,还能在创建过程中自动启动实例并根据参数设置分配公网 IP,简化了操作流程。同时,用户可以通过设置自动释放时间、使用启动模板、自定义CPU选项等功能,更好地管理和配置自己的实例资源。
CreateInstance创建实例本接口是阿里云 ECS 中用于创建实例的接口,支持创建一台包年包月或按量付费的 ECS 实例。您可通过此接口,依据自身需求灵活配置各类参数,实现实例的个性化创建。
StartInstance启动实例本接口用于启动一台ECS实例,您可以通过指定实例ID以及按需设置 InitLocalDisk 等参数启动实例。
StartInstances批量启动实例本接口用于批量启动 ECS 实例,支持通过设置参数来选择不同的批量操作模式,为您提供灵活的启动方式。
StopInstance停止实例本接口用于停止一台ECS实例,支持您通过不同参数设置选择不同的关机方式和停机模式,来确保实例停止操作的安全性和灵活性。
StopInstances批量停止实例本接口用于停止一台或多台 ECS 实例,支持通过设置参数来选择不同的关机方式、停机模式以及批量操作模式。
RebootInstance重启实例本接口用于重启一台ECS实例。
RebootInstances批量重启实例本接口用于重启一台或多台ECS实例,支持您通过参数来选择是否强制重启和设置不同的批量操作模式。
DeleteInstance删除 ECS 实例本接口用于删除或者释放一台按量付费实例或者到期的包年包月实例,支持通过参数设置决定云盘是否释放或转换为按量付费保留。
DeleteInstances批量删除 ECS 实例本接口用于批量删除或者释放按量付费实例或者到期的包年包月实例,支持通过参数设置决定云盘是否释放或转换为按量付费保留。
DescribeInstanceStatus查询实例的状态信息列表本接口主要用于查询一台或多台指定ECS实例的状态信息,同时支持查询指定条件下的实例列表。
DescribeInstances查询实例的详细信息列表本接口支持根据不同请求条件查询实例列表,并关联查询实例的详细信息。
DescribeInstanceTypeFamilies查询实例规格族列表本接口用于查询阿里云 ECS提供的实例规格族列表。通过该接口获取不同系列的实例规格族信息,从而更好地帮助您了解可用的实例规格资源,为您选择合适的实例规格创建 ECS 实例提供参考。
DescribeInstanceTypes查询实例规格信息列表本接口主要用于查询云服务器ECS提供的所有实例规格的信息列表并关联获取实例规格的详细信息,也可根据特定条件查询指定实例规格的信息,帮助您了解不同实例规格的配置和性能,以便选择适合自己业务需求的实例。
DescribeInstanceAttribute查询实例属性信息本接口用于查询一台指定ECS实例的属性信息。
ModifyInstanceAttribute修改实例属性信息本接口用于修改一台ECS实例的部分属性信息,支持修改密码、实例名称、主机名、所属安全组、实例的MTU以及用户自定义数据等。
ModifyInstanceChargeType修改实例计费方式本接口用于修改一台或者多台ECS实例的计费方式。您可以通过此接口实现按量付费实例和包年包月实例之间的相互转换,同时支持您将实例挂载的所有按量付费云盘转换为包年包月云盘。
ModifyInstanceSpec修改实例的实例规格或公网带宽本接口用于修改一台按量付费ECS实例的实例规格或者公网带宽大小。
ModifyPrepayInstanceSpec修改包年包月实例的实例规格本接口用于修改一台包年包月ECS实例的实例规格,支持您升级或者降低实例规格,修改后的实例规格在实例整个生命周期内生效。
ModifyInstanceAutoReleaseTime修改实例自动释放时间本接口用于修改指定按量付费实例或者抢占式实例的自动释放时间,同时支持取消自动释放功能。
AttachInstanceRamRole为实例授予RAM角色本接口用于为一台或多台ECS实例授予RAM角色。
DescribeInstanceRamRole查询实例被授予的RAM角色本接口具备两个主要功能,支持依据实例 ID 来查询一台或多台 ECS 实例所被授予的实RAM角色,同时也允许通过实例 RAM 角色名称来查询被授予了该特定角色的实例情况。
DetachInstanceRamRole收回实例被授予的RAM角色本接口用于收回一台或多台ECS实例被授予的RAM角色。
DescribeInstanceVncUrl查询实例VNC登陆地址本接口用于查询一台ECS实例的VNC登录地址。
ModifyInstanceVncPasswd修改实例VNC登录密码本接口用于修改一台ECS实例的VNC登录密码。
ModifyInstanceMetadataOptions修改实例内的元数据访问设置本接口用于修改指定地域下实例内的元数据访问设置,包括是否启用元数据访问通道和访问元数据时是否启用强制加固模式等设置。
DescribeUserData查询实例自定义数据本接口用于查询一台ECS实例的自定义数据。
RenewInstance续费实例本接口用于续费一台包年包月的 ECS 实例,支持您设置续费时长或者续费至统一到期日。
DescribeInstanceAutoRenewAttribute查询实例自动续费属性本接口用于查询一台或多台包年包月ECS实例的自动续费属性,包括是否开启自动续费、续费周期等信息。
ModifyInstanceAutoRenewAttribute修改实例的自动续费属性本接口用于修改一台或多台包年包月实例的自动续费属性,可以帮助您减少资源到期的维护成本。
ReActivateInstances重新启动已过期或欠费回收的实例本接口用于重新启动一台已过期或欠费回收的按量付费ECS实例。
DescribeSpotPriceHistory查询抢占式实例的历史价格本接口用于查询抢占式实例的历史价格,最多支持获取近30天内的数据,通过历史价格数据可以帮助您合理的设置抢占式实例的单台实例上限价格。
DescribeSpotAdvice查询抢占式实例平均释放率和折扣率本接口用于查询指定地域下,抢占式实例近30天的平均释放率、平均折扣率等信息。

块存储

API标题API概述
CreateDisk创建数据盘创建一块按量付费或包年包月的数据盘。
DescribeDisks查询块存储查询一块或多块已创建的块存储(包括云盘、本地盘以及弹性临时盘)信息。
ModifyDiskAttribute修改块存储属性调用ModifyDiskAttribute修改一个或多个块存储的名称、描述、是否随实例释放等属性。
ModifyDiskChargeType修改实例上云盘计费方式转换一台包年包月ECS实例上所挂载的数据盘的计费方式。
ModifyDiskSpec变更云盘类型或性能级别变更一块云盘类型,或者修改一块ESSD云盘的性能级别。ESSD同城冗余云盘(公测)、普通云盘、弹性临时盘和本地盘均不支持变更云盘类型。
DeleteDisk释放一块按量付费数据盘调用DeleteDisk释放一块按量付费数据盘。磁盘类型包括普通云盘、高效云盘、SSD云盘和ESSD云盘。
AttachDisk为实例挂载磁盘为一台ECS实例挂载一块按数据盘或系统盘。
DetachDisk卸载按量付费数据盘或系统盘从一台ECS实例上卸载一块按量付费的数据盘或者系统盘。
ReplaceSystemDisk更换操作系统(系统盘)更换一台ECS实例的操作系统。更换后系统盘的云盘ID将发生变化,原云盘会被释放。
ReInitDisk初始化磁盘至创建时的初始状态重新初始化一块磁盘至创建时的初始状态。
ResizeDisk扩容磁盘扩容一块磁盘,支持扩容系统盘和数据盘。
ResetDisk重置磁盘使用云盘快照,将云盘回滚到之前某一特定的历史状态。
EnableDiskEncryptionByDefault开启块存储账号级默认加密开启指定地域块存储账号级默认加密。
DescribeDiskEncryptionByDefaultStatus查询块存储账号级默认加密的服务状态查询指定地域块存储账号级默认加密的服务状态。
DescribeDiskDefaultKMSKeyId查询块存储账号级默认加密使用的密钥查询块存储账号级默认加密使用的密钥。
ModifyDiskDefaultKMSKeyId修改块存储账号级默认加密使用的密钥修改指定地域块存储账号级默认加密使用的KMS密钥ID。
ResetDiskDefaultKMSKeyId重置块存储账号级默认加密使用的密钥将指定地域块存储账号级默认加密使用的 KMS 密钥 ID 重置为服务密钥的接口。
DisableDiskEncryptionByDefault关闭块存储账号级默认加密关闭指定地域块存储账号级默认加密。

镜像

API标题API概述
CreateImage创建一份自定义镜像调用CreateImage接口,创建一份自定义镜像。后续您可以使用创建的自定义镜像创建ECS实例(RunInstances),或者更换实例的系统盘(ReplaceSystemDisk)。
DescribeImages查询可以使用的镜像资源调用DescribeImages接口,并可以指定ImageId、ImageFamily、InstanceType等参数,查询您可以使用的镜像资源。
ModifyImageAttribute修改自定义镜像属性调用ModifyImageAttribute接口,并可以指定ImageId、ImageFamily等参数,修改一份自定义镜像的属性,例如镜像族系、名称、启动模式、状态以及是否支持NVMe等。
DeleteImage删除一份自定义镜像调用DeleteImage接口,并可以指定参数ImageId、Force删除一份自定义镜像。
DescribeImageFromFamily查询镜像族系内可用镜像调用DescribeImageFromFamily查询指定镜像族系内最新创建的可用自定义镜像。
DescribeImageSupportInstanceTypes查询指定镜像支持的实例规格调用DescribeImageSupportInstanceTypes查询指定镜像支持的实例规格。
DescribeImageSharePermission查询一份自定义镜像已经共享的所有用户调用DescribeImageSharePermission接口,并可以指定RegionId、ImageId等参数,查询自定义镜像已经共享的所有用户。持返回结果支分页显示,每页的信息条目默认为10条。
ModifyImageSharePermission管理镜像共享权限调用ModifyImageSharePermission管理镜像共享权限。您可以将自己的自定义镜像共享给其他阿里云账号,也可以发布为社区镜像供他人使用。
ImportImage导入本地镜像文件调用ImportImage导入一份您的本地镜像文件到云服务器ECS,作为自定义镜像出现在相应地域中。后续您可以使用导入的镜像创建ECS实例(RunInstances),或者更换实例的系统盘(ReplaceSystemDisk)。
ExportImage导出一份自定义镜像到OSS导出一份自定义镜像到与自定义镜像同一地域的OSS Bucket里。
CopyImage复制一个地域下的自定义镜像到其他地域调用CopyImage复制一个地域下的自定义镜像到其他地域。复制镜像可以实现跨地域部署ECS实例、跨地域复制ECS实例等目的。
CancelCopyImage取消正在进行中的复制镜像任务调用CancelCopyImage取消正在进行中的复制镜像(CopyImage)任务。

镜像构建

API标题API概述
CreateImageComponent创建一个镜像组件调用CreateImageComponent创建一个镜像组件。镜像组件用于存储您在构建镜像时,常用的构建模板命令。
DescribeImageComponents查询一个或多个镜像组件的详细信息调用DescribeImageComponents查询一个或多个镜像组件的详细信息。
DeleteImageComponent删除一个镜像组件调用DeleteImageComponent接口,并指定参数RegionId、ImageComponentId,删除一个镜像组件。
CreateImagePipeline创建镜像构建模板调用CreateImagePipeline创建一个镜像模板。镜像模板可用于构建镜像。
DescribeImagePipelines查询一个或多个镜像模板的详细信息调用DescribeImagePipelines查询一个或多个镜像模板的详细信息。
DeleteImagePipeline删除一个镜像模板调用DeleteImagePipeline接口,并指定参数RegionId、ImagePipelineId,删除一个镜像模板。
StartImagePipelineExecution通过一个镜像模板执行构建镜像的任务调用StartImagePipelineExecution通过一个镜像模板执行构建镜像的任务。
DescribeImagePipelineExecutions查询一个镜像构建任务的详细信息调用DescribeImagePipelineExecutions查询一个镜像构建任务的详细信息。
CancelImagePipelineExecution取消一个镜像构建任务调用CancelImagePipelineExecution取消一个镜像构建任务。

快照

API标题API概述
CreateSnapshot创建快照为一块云盘创建一份快照。
DescribeSnapshots查询云盘快照列表查询云盘的快照列表信息。例如快照状态、正在创建的快照剩余完成时间、自动快照保留天数等。
DescribeSnapshotsUsage查询快照数量和容量调用DescribeSnapshotsUsage查询您在一个地域下的快照数量以及快照容量。
ModifySnapshotAttribute修改快照属性调用ModifySnapshotAttribute修改一份快照的名称、描述或保留天数。
CopySnapshot复制快照调用CopySnapshot将一份标准快照或加密快照从一个地域复制到另一个地域。
DeleteSnapshot删除指定快照调用DeleteSnapshot删除指定的快照。如果需要取消正在创建的快照,也可以调用该接口删除快照,即取消创建快照任务。
DescribeSnapshotLinks查询云盘快照链调用DescribeSnapshotLinks查询云盘快照链。快照链是一块云盘所有快照组成的关系链,一块云盘对应一条快照链。
CreateSnapshotGroup创建快照一致性组为指定ECS实例中的云盘创建快照一致性组。快照一致性组包含一个或多个云盘对应的快照。
DescribeSnapshotGroups查询快照一致性组查询一个或多个快照一致性组的信息。例如状态、所属的实例ID、快照创建进度等。
ModifySnapshotGroup修改快照分组调用ModifySnapshotGroup修改指定实例快照的名称与描述信息。
DeleteSnapshotGroup删除快照分组调用DeleteSnapshotGroup删除指定的实例快照。
CreateAutoSnapshotPolicy创建自动快照策略在指定地域下创建一条自动快照策略。自动快照策略可以周期性地为系统盘或数据盘创建快照备份数据。
DescribeAutoSnapshotPolicyEx查询已创建的自动快照策略本接口用于查询指定地域下已创建的自动快照策略详细信息列表。
ModifyAutoSnapshotPolicyEx修改一条自动快照策略调用ModifyAutoSnapshotPolicyEx修改一条自动快照策略。修改自动快照策略后,之前已应用该策略的云盘随即执行修改后的自动快照策略。已启用快照跨地域复制且在未配置加密参数场景下,加密快照默认使用目的端服务密钥进行加密拷贝。
ApplyAutoSnapshotPolicy为云盘应用自动快照策略调用ApplyAutoSnapshotPolicy为一块或者多块云盘应用自动快照策略。目标云盘已经应用了自动快照策略时,调用ApplyAutoSnapshotPolicy可以更换云盘当前应用的自动快照策略。
CancelAutoSnapshotPolicy取消一块或者多块云盘的自动快照策略调用CancelAutoSnapshotPolicy取消一块或者多块云盘的自动快照策略。
DeleteAutoSnapshotPolicy删除一条自动快照策略删除一条自动快照策略。如果目标自动快照策略已经被应用到磁盘上,删除自动快照策略后,这些磁盘不再执行该策略。
DescribeSnapshotPackage查询某地域下已购买对象存储OSS存储包调用DescribeSnapshotPackage查询您在一个阿里云地域下已经购买的OSS存储包。存储包可以用于抵扣标准快照存储容量,但不支持抵扣本地快照。

网络

API标题API概述
ModifyInstanceVpcAttribute修改专有网络类型实例的VPC属性修改一台专有网络类型ECS实例的专有网络VPC、私网IP地址或虚拟交换机。
AllocatePublicIpAddress分配固定公网IP为一台ECS实例分配一个固定公网IP地址。该接口只能为带宽非0的ECS实例分配固定公网IP,且仅白名单用户支持指定IP。建议您调用ModifyInstanceNetworkSpec接口调整带宽,分配固定公网IP。
ConvertNatPublicIpToEip将公网IP地址转化为弹性公网IP调用ConvertNatPublicIpToEip将一台专有网络VPC类型ECS实例的公网IP地址(PublicIP)转化为弹性公网IP(EIP)。
AttachClassicLinkVpc将经典网络类型实例连接到专有网络VPC调用AttachClassicLinkVpc将一台经典网络类型实例连接到专有网络VPC中,使经典网络类型实例可以和VPC中的云资源私网互通。
DetachClassicLinkVpc取消经典网络类型实例与VPC的连接调用DetachClassicLinkVpc取消一台经典网络类型ECS实例与专有网络VPC的连接(ClassicLink)。取消ClassicLink后,经典网络类型实例无法与VPC内的实例互通。
DescribeBandwidthLimitation查询不同实例规格公网带宽上限调用DescribeBandwidthLimitation查询不同实例规格可以购买、升级或降配的公网带宽上限。
DescribeClassicLinkInstances查询建立了连接的经典网络类型实例调用DescribeClassicLinkInstances查询一台或多台与专有网络VPC建立了连接的经典网络类型实例。
ModifyInstanceNetworkSpec修改ECS实例的带宽配置修改ECS实例的带宽配置。当实例现有网络规格不满足要求时,可以通过修改实例的带宽配置提高网络性能。本接口支持升配和降配。

弹性网卡

API标题API概述
CreateNetworkInterface创建弹性网卡创建一张弹性网卡(ENI),支持指定主私网IP地址。
DescribeNetworkInterfaces查看弹性网卡(ENI)列表调用DescribeNetworkInterfaces接口,并可以指定ResourceGroupId、VSwitchId、InstanceId等参数,查询一个或多个弹性网卡(ENI)的详细信息。
DescribeNetworkInterfaceAttribute查询网卡属性指定弹性网卡ID,查询一个网卡的详细信息。
ModifyNetworkInterfaceAttribute修改弹性网卡属性调用ModifyNetworkInterfaceAttribute接口,并可以指定NetworkInterfaceId、SecurityGroupId等参数,修改一个弹性网卡(ENI)的名称、描述以及所属安全组等属性。
DeleteNetworkInterface删除一个弹性网卡(ENI)调用DeleteNetworkInterface接口,并指定参数RegionId、NetworkInterfaceId异步删除一个弹性网卡(ENI)。
AttachNetworkInterface附加弹性网卡到专有网络VPC类型实例上调用AttachNetworkInterface接口,并可以指定NetworkInterfaceId、InstanceId、NetworkCardIndex等参数,附加一个弹性网卡(ENI)到一台专有网络VPC类型ECS实例上。
DetachNetworkInterface从实例上分离一个弹性网卡(ENI)调用DetachNetworkInterface从一台ECS实例上分离一个弹性网卡(ENI)。
AssignPrivateIpAddresses为弹性网卡分配辅助私有IP地址为一块弹性网卡分配一个或多个辅助私网IP地址。可以为网卡指定在所属交换机(vSwitch)的空闲私网IP地址,或者通过指定私网地址数量自动分配私网IP地址。
UnassignPrivateIpAddresses从弹性网卡删除辅助私有IP地址调用UnassignPrivateIpAddresses从一块弹性网卡删除一个或多个辅助私有IP地址。
AssignIpv6Addresses为弹性网卡分配一个或多个IPv6地址调用AssignIpv6Addresses为弹性网卡分配一个或多个IPv6地址。
UnassignIpv6Addresses回收弹性网卡IPv6地址调用UnassignIpv6Addresses回收一个或多个弹性网卡IPv6地址。

前缀列表

API标题API概述
CreatePrefixList创建前缀列表调用CreatePrefixList创建一个前缀列表。
DescribePrefixLists查询前缀列表调用DescribePrefixLists查询一个或多个前缀列表的信息。
DescribePrefixListAttributes查询指定前缀列表的详细信息调用DescribePrefixListAttributes查询指定前缀列表的详细信息,包含前缀列表的名称、地址族、最大条目容量以及条目的详细信息等。
DescribePrefixListAssociations查询指定前缀列表已关联的资源信息调用DescribePrefixListAssociations查询指定前缀列表已关联的资源信息。
ModifyPrefixList修改指定前缀列表的名称、描述和条目调用ModifyPrefixList修改指定前缀列表的名称、描述和条目。
DeletePrefixList删除前缀列表调用DeletePrefixList删除指定的前缀列表,同时删除前缀列表中的所有条目。

安全组

API标题API概述
CreateSecurityGroup创建安全组本接口用于创建一个安全组。
DescribeSecurityGroups查询安全组基本信息列表本接口用于查询安全组基本信息列表,支持您通过地域、安全组ID、安全组类型等不同参数查询。
DescribeSecurityGroupAttribute查询安全组和组内规则信息本接口主要用于查询一个指定安全组的详细信息,并关联查询安全组规则详细信息列表。
ModifySecurityGroupPolicy修改普通安全组的组内连通策略本接口用于修改一个普通安全组的组内连通策略。
ModifySecurityGroupAttribute修改安全组的名称或者描述本接口用于修改一个指定安全组的名称或者描述信息。
DeleteSecurityGroup删除安全组本接口用于删除一个安全组,并关联删除组内所有安全组规则。
AuthorizeSecurityGroup增加安全组入方向规则本接口是阿里云 ECS 中用于增加一条或多条安全组入方向规则的接口。通过该接口,用户可以指定安全组入方向的访问权限,允许或者拒绝其他设备发送入方向流量到安全组内的实例,从而实现对网络访问的精细控制。
ModifySecurityGroupRule修改安全组入方向规则本接口用于修改指定安全组中的一条入方向安全组规则。
RevokeSecurityGroup删除安全组入方向规则本接口用于删除指定安全组内的一条或多条入方向安全组规则。
AuthorizeSecurityGroupEgress增加安全组出方向规则本接口是阿里云 ECS 中用于增加一条或多条安全组出方向规则的接口。通过该接口,用户可以指定安全组出方向的访问权限,允许或拒绝安全组内的实例发送出方向流量到其他设备,从而实现对网络访问的精细控制。
ModifySecurityGroupEgressRule修改安全组出方向规则本接口用于修改一条出方向安全组规则。
RevokeSecurityGroupEgress删除出方向安全组规则本接口用于删除指定安全组内的一条或多条出方向安全组规则。
DescribeSecurityGroupReferences查询被授权的安全组列表本接口用于查询一个或多个指定安全组已经被授权的其他安全组列表信息。
JoinSecurityGroup加入安全组本接口用于将一台ECS实例或一张弹性网卡加入到指定的安全组。
LeaveSecurityGroup移出安全组本接口用于将一台ECS实例或一张弹性网卡移出指定的安全组。

SSH 密钥对

API标题API概述
CreateKeyPair创建一对SSH密钥对调用CreateKeyPair创建一对SSH密钥对。系统会为您保管密钥的公钥部分,并返回未加密的PEM编码的PKCS#8格式私钥。您需要自行妥善保管私钥部分。
ImportKeyPair导入RSA密钥对公钥调用ImportKeyPair导入由其他工具产生的RSA密钥对的公钥部分。导入密钥对后,阿里云为您保管公钥部分,您需要自行妥善保存密钥对的私钥部分。
DescribeKeyPairs查询一个或多个密钥对调用DescribeKeyPairs查询一个或多个密钥对。
AttachKeyPair绑定SSH密钥对到Linux实例调用AttachKeyPair绑定一个SSH密钥对到一台或多台Linux实例。
DetachKeyPair为Linux实例解绑 SSH 密钥对调用DetachKeyPair为一台或者多台Linux实例解绑SSH密钥对。
DeleteKeyPairs删除一对或者多对SSH密钥对调用DeleteKeyPairs删除一对或者多对SSH密钥对。

启动模板

API标题API概述
CreateLaunchTemplate创建实例启动模板创建一个ECS实例启动模板,简称模板。实例启动模板能免除每次创建实例时都需要填入大量配置参数。
DescribeLaunchTemplates查询一个或多个可用的实例启动模板调用DescribeLaunchTemplates接口,并可以指定TemplateTag、TemplateResourceGroupId、LaunchTemplateId等参数,查询一个或多个实例启动模板的信息,例如启动模板总个数、模板创建时间、模板最新版本号等信息集合。
DeleteLaunchTemplate删除一个实例启动模板调用DeleteLaunchTemplate接口,并可以指定参数LaunchTemplateId或LaunchTemplateName删除目标地域下的一个实例启动模板。
CreateLaunchTemplateVersion在实例启动模板中创建新版本在指定的ECS实例启动模板下创建一个新版本用于后续创建ECS实例、弹性伸缩组或弹性供应组。
DescribeLaunchTemplateVersions查询实例启动模板的版本信息查询ECS实例启动模板版本的信息,例如实例启动模板总数、模板名称、模板版本号等。
ModifyLaunchTemplateDefaultVersion切换启动模板的默认版本调用ModifyLaunchTemplateDefaultVersion接口,并通过指定DefaultVersionNumber参数,切换启动模板的默认版本。如果您在创建实例(RunInstances)时不指定模板版本号,则会采用默认版本。
DeleteLaunchTemplateVersion删除实例启动模板的一个或多个版本调用DeleteLaunchTemplateVersion接口,并指定LaunchTemplateId、DeleteVersion等参数,删除指定实例启动模板的一个或多个版本。

弹性供应组

API标题API概述
CreateAutoProvisioningGroup创建弹性供应组调用CreateAutoProvisioningGroup接口,并可以指定ResourceGroupId、AutoProvisioningGroupType、ValidFrom等参数,创建一个弹性供应组。
DescribeAutoProvisioningGroups查询一个或多个弹性供应组调用DescribeAutoProvisioningGroups查询一个或多个弹性供应组。
DescribeAutoProvisioningGroupInstances查询一个弹性供应组内的实例调用DescribeAutoProvisioningGroupInstances查询一个弹性供应组内的实例。
ModifyAutoProvisioningGroup修改一个弹性供应组的设置调用ModifyAutoProvisioningGroup接口修改一个弹性供应组的设置。
DescribeAutoProvisioningGroupHistory查询弹性供应组的调度任务信息调用DescribeAutoProvisioningGroupHistory查询弹性供应组的调度任务信息。
DeleteAutoProvisioningGroup删除一个弹性供应组调用DeleteAutoProvisioningGroup接口,并可以指定参数AutoProvisioningGroupId、TerminateInstances删除一个弹性供应组。

部署集

API标题API概述
CreateDeploymentSet在指定的地域内创建一个部署集调用CreateDeploymentSet接口,并可以指定OnUnableToRedeployFailedInstance、DeploymentSetName、Strategy等参数,在指定的地域内创建一个部署集。
DescribeDeploymentSetSupportedInstanceTypeFamily查询支持部署集的实例规格族调用DescribeDeploymentSetSupportedInstanceTypeFamily,并指定RegionId、Strategy参数,查询支持各部署集策略的实例规格族。
DescribeDeploymentSets查询一个或多个部署集的属性列表调用DescribeDeploymentSets接口,并可以指定DeploymentSetIds、Strategy、DeploymentSetName等参数,查询一个或多个部署集的详细信息。
ModifyDeploymentSetAttribute修改一个部署集的名称和描述信息调用ModifyDeploymentSetAttribute接口,并可以指定DeploymentSetId、DeploymentSetName等参数,修改一个部署集的名称和描述信息。
DeleteDeploymentSet删除一个部署集调用DeleteDeploymentSet接口,并指定RegionId、DeploymentSetId等参数,删除一个部署集。

资源保障

API标题API概述
CreateElasticityAssurance创建弹性保障服务通过指定弹性保障服务所属地域下的可用区、实例规格等参数创建弹性保障服务。
DescribeElasticityAssurances查询弹性保障服务的信息查询弹性保障服务的详细信息。例如弹性保障服务的状态、匹配模式、生效方式、失效时间、已使用的实例的数量等。
DescribeElasticityAssuranceInstances查询弹性保障服务已匹配实例列表调用DescribeElasticityAssuranceInstances查询弹性保障服务已匹配的运行状态的实例列表。
ModifyElasticityAssurance修改一个弹性保障服务的部分信息修改一个弹性保障服务的部分信息,包含名称、描述、容量(暂时只支持缩容)。
RenewElasticityAssurances续费一个或多个弹性保障服务调用RenewElasticityAssurances接口,并可以指定PrivatePoolOptionsId、Period等参数,对一个或多个已购买的弹性保障服务进行续费。
PurchaseElasticityAssurance购买一个准备完毕的弹性保障服务本接口旨在为用户提供便捷、高效的方式来购买弹性保障服务。当用户存在资源准备完毕,处于未激活状态的弹性保障服务时,可以通过该接口进行购买。
CreateCapacityReservation创建容量预定服务指定需要预留的实例规格、总数量,生效方式和可用区等,创建容量预定服务。
DescribeCapacityReservations查询容量预定服务的信息查询一个或多个容量预定服务的详细信息,例如服务的状态、服务的生效与失效时间、私有池的模式和已使用的实例的数量等。
DescribeCapacityReservationInstances查询容量预定服务已匹配的实例列表调用DescribeCapacityReservationInstances查询容量预定服务已匹配的实例列表。
ModifyCapacityReservation修改一个容量预定服务的部分信息调用ModifyCapacityReservation修改一个容量预定服务的部分信息,包括容量预定服务的名称、描述信息、失效方式以及预留的实例总数量。
DescribeInstanceAttachmentAttributes查询实例匹配的私有池信息查询实例匹配的私有池信息,例如匹配模式、私有池ID等。
ModifyInstanceAttachmentAttributes修改实例的私有池的属性修改实例的私有池匹配模式。
ReleaseCapacityReservation释放容量预定服务调用ReleaseCapacityReservation释放容量预定服务。

预留实例券

API标题API概述
PurchaseReservedInstancesOffering购买预留实例券本接口用于购买一张预留实例券,支持您购买一张地域级或者可用区级的预留实例券来抵扣对应规格的按量付费实例账单。
DescribeReservedInstances查询预留实例券详细信息列表本接口主要用于查询您已经购买的预留实例券信息,支持您根据标签、预留实例券属性等参数获取预留实例券详细信息列表。
ModifyReservedInstances修改预留实例券配置本接口的主要功能是通过修改实例规格、数量、可用区等预留实例券的配置来对预留实例券进行拆分、合并或范围变更操作。
ModifyReservedInstanceAttribute修改预留实例券属性本接口用于修改一张预留实例券的属性信息,包括名称和描述。
RenewReservedInstances续费预留实例券本接口用于对一张或多张预留实例券进行续费,支持您在续费时设置购买时长和自动续费属性。
DescribeReservedInstanceAutoRenewAttribute查询预留实例券自动续费属性本接口用于查询一个或多个预留实例券自动续费属性,包括自动续费时长和自动续费状态。
ModifyReservedInstanceAutoRenewAttribute修改预留实例券自动续费属性本接口主要用于修改一个或多个预留实例券的自动续费属性,支持您取消已设定的自动续费。

存储容量单位包

API标题API概述
PurchaseStorageCapacityUnit购买存储容量单位包本接口用于购买一个或多个存储容量单位包SCU(Storage Capacity Unit)。
DescribeStorageCapacityUnits查询存储容量单位包详细信息列表本接口用于查询存储容量单位包SCU(Storage Capacity Unit)的详细信息列表,支持根据名称、状态以及容量大小等条件进行查询。
ModifyStorageCapacityUnitAttribute修改存储容量单位包属性本接口用于修改一个存储容量单位包SCU(Storage Capacity Unit)的名称或者描述信息。

云助手

API标题API概述
RunCommand在实例中执行脚本调用RunCommand接口,并指定Type、CommandContent等参数,在一台或多台ECS实例中执行一段Shell、PowerShell或者Bat类型的脚本。
CreateCommand新建一条云助手命令新建一条Shell、PowerShell或者Bat脚本类型的云助手命令。
InvokeCommand为一台或多台ECS实例触发一条云助手命令调用InvokeCommand接口,并可以指定CommandId、InstanceId、ResourceGroupId等参数,为一台或多台ECS实例触发一条云助手命令。
DescribeInvocations查询云助手脚本的执行列表和状态调用DescribeInvocations查询云助手命令的执行列表和状态。
DescribeInvocationResults查看云助手命令执行结果调用DescribeInvocationResults查看一条或多条云助手命令的执行结果,即在ECS实例中的实际执行结果。
ModifyInvocationAttribute修改任务的执行信息修改云助手定时任务的执行信息,包括命令内容、定时执行方式、添加ECS实例或托管实例到任务。
StopInvocation停止一台或多台ECS实例中一条正在进行中(Running)的云助手命令进程调用StopInvocation停止一台或多台ECS实例中一条正在进行中(Running)的云助手命令进程。
DescribeCommands查询已创建的云助手命令查询您手动创建的云助手命令或者阿里云提供的公共命令。
ModifyCommand修改一条云助手命令相关参数以及命令内容调用ModifyCommand修改一条云助手命令相关参数。
DeleteCommand删除一条云助手命令调用DeleteCommand接口,并指定参数RegionId、CommandId删除一条云助手命令。它无法删除正在执行中的命令。
SendFile上传本地文件到ECS实例调用SendFile向一台或多台ECS实例下发远程文件。
DescribeSendFileResults查询云助手下发文件列表及状态调用DescribeSendFileResults查询云助手下发文件列表及状态。
DescribeCloudAssistantStatus查询一台或者多台实例是否安装了云助手Agent调用DescribeCloudAssistantStatus查询一台或者多台实例是否安装了云助手Agent。如果已安装了云助手,还将查询云助手命令执行的总数量、正在执行的数量以及最近一次命令执行的时间。
InstallCloudAssistant为实例安装云助手Agent调用InstallCloudAssistant为一台或多台ECS实例安装云助手Agent。需要重启实例来完成安装云助手Agent的操作。
StartTerminalSession开始终端会话调用StartTerminalSession基于会话管理功能创建一个会话。您可以通过指定ECS实例ID与该实例建立一个WebSocket会话,通过接口返回的WebSocketUrl可以远程连接到ECS实例。
DescribeTerminalSessions查看Session Manager会话历史记录查看Session Manager会话历史记录。
ModifyCloudAssistantSettings修改云助手服务配置修改云助手服务配置。
DescribeCloudAssistantSettings查询云助手服务配置查询云助手服务配置。
CreateActivation创建一个激活码调用CreateActivation创建一个激活码。该激活码用于将非阿里云服务器注册为阿里云托管实例。
DescribeActivations查询激活码的使用情况调用DescribeActivations查询已创建的激活码以及激活码的使用情况。
DisableActivation手动禁用指定的激活码调用DisableActivation手动禁用指定的激活码。
DeleteActivation删除一个未被使用的激活码调用DeleteActivation删除一个未被使用的激活码。
DescribeManagedInstances获取托管实例调用DescribeManagedInstances查询托管实例列表。
ModifyManagedInstance修改托管实例调用ModifyManagedInstance修改一台托管实例的相关信息。
DeregisterManagedInstance注销托管实例调用DeregisterManagedInstance注销一个托管实例。注销后您将无法再使用云助手向实例发送命令或文件。
ListPluginStatus查询实例中云助手插件的状态调用ListPluginStatus查询实例中云助手插件的状态。

系统事件

API标题API概述
DescribeInstancesFullStatus查询实例的全状态信息调用DescribeInstancesFullStatus查询一台或多台ECS实例的全状态信息。全状态信息包括实例状态和实例系统事件状态,其中,实例状态为实例的生命周期状态,实例系统事件为维护事件的健康状态。
DescribeDisksFullStatus查询一块或多块块存储的全部状态信息调用DescribeDisksFullStatus查询一块或多块块存储的全部状态信息。
DescribeInstanceHistoryEvents查询指定实例系统事件信息调用DescribeInstanceHistoryEvents接口,并可以指定InstanceId、EventType等参数,查询指定实例系统事件信息,默认查询处于非活跃状态的历史系统事件。
CreateSimulatedSystemEvents为实例预约模拟系统事件调用CreateSimulatedSystemEvents为一台或多台ECS实例预约模拟系统事件。模拟系统事件相当于事件演习,不会真正执行事件,也不会对ECS实例产生影响。
CancelSimulatedSystemEvents取消模拟系统事件调用CancelSimulatedSystemEvents取消一件或多件处于Scheduled(计划中)或Executing(执行中)状态的模拟系统事件。取消系统事件后,模拟事件变为Canceled(已取消)状态。
AcceptInquiredSystemEvent接受并授权执行系统事件操作调用AcceptInquiredSystemEvent接受并授权执行系统事件操作。对问询中(Inquiring)状态的系统事件,接受系统事件的默认操作,授权系统执行默认操作。

资源诊断

API标题API概述
CreateDiagnosticMetricSet创建资源诊断指标集合调用CreateDiagnosticMetricSet创建资源诊断指标集合。您可以根据需要,灵活组合诊断指标。
DescribeDiagnosticMetricSets查询资源诊断集合列表调用DescribeDiagnosticMetricSets查询资源诊断集合列表。
DescribeDiagnosticMetrics查询诊断指标列表调用DescribeDiagnosticMetrics查询诊断指标列表。
ModifyDiagnosticMetricSet修改资源诊断指标集合调用ModifyDiagnosticMetricSet修改资源诊断指标集合。
DeleteDiagnosticMetricSets删除资源诊断指标集合调用DeleteDiagnosticMetricSets删除资源诊断指标集合。
CreateDiagnosticReport创建资源诊断报告调用CreateDiagnosticReport创建资源诊断报告。根据您传入诊断指标集合ID,生成多个诊断指标的诊断报告。您可以根据返回的诊断报告ID,调用DescribeDiagnosticReportAttributes查询资源诊断详情。
DescribeDiagnosticReports查询资源诊断报告列表调用DescribeDiagnosticReports查询资源诊断报告列表。
DescribeDiagnosticReportAttributes查询资源诊断详情调用DescribeDiagnosticReportAttributes查询资源诊断详情。
DeleteDiagnosticReports删除资源诊断报告调用DeleteDiagnosticReports删除资源诊断报告。

运维与监控

API标题API概述
GetInstanceScreenshot获取实例的截屏信息调用GetInstanceScreenshot获取实例的截屏信息。
GetInstanceConsoleOutput获取实例系统命令行输出获取一台实例的系统命令行输出,数据以Base64编码后返回。
DescribeDiskMonitorData查询一块云盘指定时间内的使用信息调用DescribeDiskMonitorData接口,并可以指定DiskId、StartTime、EndTime等参数,查询一块云盘在指定时间内的使用信息。
DescribeInstanceMonitorData查询一台实例的监控信息调用DescribeInstanceMonitorData查询一台ECS实例的监控信息。可查询的指标包括ECS实例的vCPU使用率、突发性能实例积分、接收的数据流量、发送的数据流量、平均带宽等。
DescribeEniMonitorData查询辅助网卡流量信息调用DescribeEniMonitorData查询一块辅助网卡在指定时间段内使用的流量信息。
DescribeSnapshotMonitorData查询近30天内快照容量变化监控数据调用DescribeSnapshotMonitorData查询一个地域下近30天内的快照容量变化监控数据。
DescribeInstanceMaintenanceAttributes查询实例的维护属性调用DescribeInstanceMaintenanceAttributes查询实例的维护属性。
ModifyInstanceMaintenanceAttributes修改实例的维护属性调用ModifyInstanceMaintenanceAttributes修改实例的维护属性。
RedeployInstance重新部署实例当ECS实例收到系统事件通知时,调用RedeployInstance可以重新部署这台ECS实例。
ReportInstancesStatus反馈一台或者多台ECS实例异常问题调用ReportInstancesStatus反馈一台或者多台ECS实例的异常问题。您可以反馈多台ECS实例发生的相同问题,也可以反馈一台ECS实例的多块磁盘发生的相同问题。

标签与资源组

API标题API概述
TagResources为指定的ECS资源列表统一创建并绑定标签调用TagResources为指定的ECS资源列表统一创建并绑定标签。
ListTagResources查询资源已经绑定的标签列表查询一个或多个ECS资源已经绑定的标签列表。
UntagResources为指定资源列表统一解绑标签调用UntagResources为指定的ECS资源列表统一解绑标签。解绑后,如果该标签没有绑定其他任何资源,会被自动删除。
JoinResourceGroup将一个ECS资源或者服务加入一个资源组调用JoinResourceGroup将一个ECS资源或者服务加入一个资源组。

专有宿主机

API标题API概述
AllocateDedicatedHosts创建一台或多台按量付费或者包年包月专有宿主机调用AllocateDedicatedHosts创建一台或多台按量付费或者包年包月专有宿主机。专有宿主机是单租户独享的物理机资源,您可以在专有宿主机上自行创建ECS实例和获取物理服务器属性等信息。
DescribeDedicatedHosts查询专有宿主机详细信息本接口用于查询一台或多台专有宿主机的详细信息。通过该接口,您可以获取包括专有宿主机的物理性能指标、机器码、使用状态以及已创建的ECS实例列表等信息。您能够根据具体需求,通过指定相关参数,如专有宿主机ID列表、专有宿主机集群ID、宿主机名称、状态等,精准地查询所需的专有宿主机详细信息,为高效管理和优化云计算资源提供有力支持。
DescribeDedicatedHostTypes查询专有宿主机规格详细参数调用DescribeDedicatedHostTypes查询指定地域下支持的专有宿主机规格详细参数,或者查询专有宿主机支持的ECS实例规格族。
ModifyDedicatedHostClusterAttribute修改一台专有宿主机集群的部分信息调用ModifyDedicatedHostClusterAttribute修改一台专有宿主机集群的部分信息,包括专有宿主机集群的名称、描述信息、属性等。
ModifyDedicatedHostAttribute修改专有宿主机部分信息调用ModifyDedicatedHostAttribute修改一台专有宿主机的部分信息,包括专有宿主机的名称、描述和服务不可用属性等。
ModifyDedicatedHostsChargeType修改专有宿主机的付费类型调用ModifyDedicatedHostsChargeType修改专有宿主机的付费类型。
DescribeDedicatedHostAutoRenew查询专有宿主机自动续费状态调用DescribeDedicatedHostAutoRenew查询一台或多台包年包月专有宿主机自动续费状态。
ModifyDedicatedHostAutoRenewAttribute为专有宿主机设置或取消自动续费调用ModifyDedicatedHostAutoRenewAttribute为一台或多台包年包月专有宿主机设置自动续费,也可以取消已设定的自动续费。
RenewDedicatedHosts续费一台或者多台包年包月专有宿主机调用RenewDedicatedHosts续费一台或者多台包年包月专有宿主机。
ModifyDedicatedHostAutoReleaseTime为专有宿主机设定自动释放时间调用ModifyDedicatedHostAutoReleaseTime为一台按量付费专有宿主机设定自动释放时间,或者取消自动释放一台按量付费专有宿主机。
ModifyInstanceDeployment修改实例部署集调用ModifyInstanceDeployment修改ECS实例的部署集,或迁移ECS实例至专有宿主机。支持在迁移ECS实例的同时变更实例规格。
RedeployDedicatedHost执行专有宿主机的故障迁移调用RedeployDedicatedHost执行专有宿主机的故障迁移。
ReleaseDedicatedHost释放专有宿主机调用ReleaseDedicatedHost释放一台按量付费专有宿主机。
CreateDedicatedHostCluster创建一个专有宿主机集群调用CreateDedicatedHostCluster接口,并可以指定ResourceGroupId、DedicatedHostClusterName、ZoneId等参数,创建一个专有宿主机集群。
DescribeDedicatedHostClusters查询一个或多个专有宿主机集群的详细信息调用DescribeDedicatedHostClusters查询一个或多个专有宿主机集群的详细信息。
DeleteDedicatedHostCluster删除一个专有宿主机集群调用DeleteDedicatedHostCluster接口,并指定参数RegionId和DedicatedHostClusterId,删除一个专有宿主机集群,操作前请先将该专有宿主机集群下的专有宿主机迁移至其他专有宿主机集群。

高性能集群

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

任务

API标题API概述
DescribeTasks查询一个或多个异步请求的进度调用DescribeTasks查询一个或多个异步请求的进度。
DescribeTaskAttribute查询异步任务的详细信息调用DescribeTaskAttribute查询异步任务的详细信息。目前,可以查询的异步任务有导入镜像(ImportImage)、导出镜像(ExportImage)及变更云盘类型(ModifyDiskSpec)。
CancelTask取消一件正在运行的任务调用CancelTask取消一件正在运行的任务。目前,您能取消正在运行的导入镜像任务(ImportImage)和导出镜像任务(ExportImage)。