文档

API概览

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

实例

API标题API概述
RunInstances创建一台或多台按量付费或者包年包月ECS实例创建一台或多台按量付费或者包年包月ECS实例。
CreateInstance创建一台包年包月或者按量付费ECS实例调用CreateInstance创建一台包年包月或者按量付费ECS实例。
StartInstance启动一台实例调用StartInstance启动一台ECS实例,接口调用成功后实例进入启动中状态。
StartInstances启动实例调用StartInstances启动一台或多台处于已停止(Stopped)状态的ECS实例,接口调用成功后实例进入启动中(Starting)状态。
StopInstance停止一台实例调用StopInstance停止一台运行中(Running)的ECS实例。成功调用接口后,实例从停止中(Stopping)变成已停止(Stopped)状态。
StopInstances停止一台或多台实例调用StopInstances停止一台或多台运行中(Running)的ECS实例。调用接口成功后,ECS实例先进入停止中(Stopping)状态,最终进入已停止(Stopped)状态。
RebootInstance重启实例当一台ECS实例处于运行中(Running)状态时,调用RebootInstance可以重启这台实例。
RebootInstances重启一台或多台实例调用RebootInstances重启一台或多台处于运行中(Running)状态的ECS实例。接口调用成功后,ECS实例先进入停止中(Stopping)状态,最终进入运行中(Running)状态。
AttachInstanceRamRole为实例授予RAM角色调用AttachInstanceRamRole为一台或多台ECS实例授予实例RAM角色。如果实例已有RAM角色,则报错提示您不能附加新的角色。
DescribeInstanceRamRole查询实例上的实例RAM角色调用DescribeInstanceRamRole查询一台或者多台ECS实例上的已赋予的实例RAM角色。
DetachInstanceRamRole回收实例的实例RAM角色调用DetachInstanceRamRole回收一台或多台ECS实例的实例RAM角色。
DescribeInstanceStatus获取多台ECS实例的状态信息调用DescribeInstanceStatus获取多台ECS实例的状态信息。
DescribeInstances查询一台或多台ECS实例的详细信息调用DescribeInstances查询一台或多台ECS实例的详细信息。
DescribeInstanceVncUrl查询一台ECS实例的Web管理终端地址调用DescribeInstanceVncUrl查询一台ECS实例的Web管理终端地址。
ModifyInstanceVncPasswd修改实例Web管理终端密码调用ModifyInstanceVncPasswd修改一台ECS实例的Web管理终端密码。
DescribeUserData查询一台ECS实例的自定义数据调用DescribeUserData查询一台ECS实例的自定义数据。
DescribeInstanceAutoRenewAttribute查询实例自动续费状态调用DescribeInstanceAutoRenewAttribute查询一台或多台包年包月ECS实例的自动续费状态。
ModifyInstanceAutoRenewAttribute设置包年包月实例的自动续费状态调用ModifyInstanceAutoRenewAttribute设置一台或多台包年包月实例的自动续费状态。为了减少您的资源到期维护成本,包年包月ECS实例可以设置自动续费。
RenewInstance续费一台包年包月ECS实例调用RenewInstance续费一台包年包月ECS实例。
DescribeSpotPriceHistory查询抢占式实例近30天内的历史价格调用DescribeSpotPriceHistory查询抢占式实例近30天内的历史价格。
DescribeSpotAdvice查询历史30天平均实例释放率调用DescribeSpotAdvice查询指定地域下,抢占式实例近30天的实例平均释放率、平均折扣率等信息。
DescribeInstanceTypeFamilies查询实例规格族列表调用DescribeInstanceTypeFamilies查询云服务器ECS提供的实例规格族列表。
DescribeInstanceTypes查询云服务器ECS提供的实例规格资源调用DescribeInstanceTypes查询云服务器ECS提供的所有实例规格的信息,也可以查询指定实例规格的信息。
DescribeInstanceAttribute查询实例所有属性信息调用DescribeInstanceAttribute查询单个ECS实例详情。
ModifyInstanceAttribute修改一台实例的部分信息调用ModifyInstanceAttribute修改一台ECS实例的部分信息,包括密码、名称、描述、主机名、所属安全组、实例的MTU以及自定义数据等。如果是突发性能实例,还可以切换性能突发模式。
ModifyInstanceMetadataOptions修改一台实例的元数据信息调用ModifyInstanceMetadataOptions修改一台实例的元数据信息。
ModifyInstanceAutoReleaseTime设定或者取消自动释放时间调用ModifyInstanceAutoReleaseTime为一台按量付费ECS实例设定或者取消自动释放时间。设置自动释放时请谨慎操作,配置的时间到期后将自动释放ECS实例。
ModifyInstanceChargeType修改付费实例类型调用ModifyInstanceChargeType更换一台或者多台ECS实例的计费方式。支持在按量付费实例和包年包月实例间相互转换,同时可以将实例挂载的所有按量付费云盘转换为包年包月云盘。
ModifyInstanceSpec调整实例的实例规格和公网带宽调用ModifyInstanceSpec调整一台按量付费ECS实例的实例规格和公网带宽大小。
ModifyPrepayInstanceSpec升级或降低实例规格调用ModifyPrepayInstanceSpec升级或者降低一台包年包月ECS实例的实例规格,新实例规格将会覆盖实例的整个生命周期。
ReActivateInstances重新启动已过期或欠费回收的实例调用ReActivateInstances重新启动一台已过期或欠费回收的按量付费ECS实例。
DeleteInstance删除 ECS 实例调用DeleteInstance释放一台按量付费实例或者到期的包年包月实例。
DeleteInstances批量删除 ECS 实例调用DeleteInstances释放一台或多台按量付费ECS实例或者到期的包年包月ECS实例。

专有宿主机

API标题API概述
AllocateDedicatedHosts创建一台或多台按量付费或者包年包月专有宿主机调用AllocateDedicatedHosts创建一台或多台按量付费或者包年包月专有宿主机。专有宿主机是单租户独享的物理机资源,您可以在专有宿主机上自行创建ECS实例和获取物理服务器属性等信息。
DescribeDedicatedHosts查询专有宿主机详细信息调用DescribeDedicatedHosts查询一台或多台专有宿主机的详细信息,包括物理性能指标、机器码、使用状态和已创建的ECS实例列表等。
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创建一个专有宿主机集群。
DescribeDedicatedHostClusters查询一个或多个专有宿主机集群的详细信息调用DescribeDedicatedHostClusters查询一个或多个专有宿主机集群的详细信息。
DeleteDedicatedHostCluster删除一个专有宿主机集群调用DeleteDedicatedHostCluster删除一个专有宿主机集群。

启动模板

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

资源诊断

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

资源保障

API标题API概述
CreateElasticityAssurance创建弹性保障服务调用CreateElasticityAssurance创建弹性保障服务。
DescribeElasticityAssurances查询弹性保障服务的详细信息调用DescribeElasticityAssurances查询弹性保障服务的详细信息。
DescribeElasticityAssuranceInstances查询弹性保障服务已匹配实例列表调用DescribeElasticityAssuranceInstances查询弹性保障服务已匹配的运行状态的实例列表。
ModifyElasticityAssurance修改一个弹性保障服务的名称与描述信息调用ModifyElasticityAssurance修改一个弹性保障服务的名称与描述信息。
CreateCapacityReservation创建容量预定服务调用CreateCapacityReservation创建容量预定服务。
DescribeCapacityReservations查询容量预定服务的详细信息调用DescribeCapacityReservations查询一个或多个容量预定服务的详细信息。
DescribeCapacityReservationInstances查询容量预定服务已匹配的实例列表调用DescribeCapacityReservationInstances查询容量预定服务已匹配的实例列表。
ModifyCapacityReservation修改一个容量预定服务的部分信息调用ModifyCapacityReservation修改一个容量预定服务的部分信息,包括容量预定服务的名称、描述信息、失效方式以及预留的实例总数量。
DescribeInstanceAttachmentAttributes查询实例匹配的私有池信息调用DescribeInstanceAttachmentAttributes查询实例匹配的私有池信息。
ModifyInstanceAttachmentAttributes修改实例的私有池的属性调用ModifyInstanceAttachmentAttributes修改实例的私有池的属性。
ReleaseCapacityReservation释放容量预定服务调用ReleaseCapacityReservation释放容量预定服务。

弹性供应组

API标题API概述
CreateAutoProvisioningGroup创建一个弹性供应组调用CreateAutoProvisioningGroup接口创建一个弹性供应组。
DescribeAutoProvisioningGroups查询一个或多个弹性供应组调用DescribeAutoProvisioningGroups查询一个或多个弹性供应组。
DescribeAutoProvisioningGroupInstances查询一个弹性供应组内的实例调用DescribeAutoProvisioningGroupInstances查询一个弹性供应组内的实例。
ModifyAutoProvisioningGroup修改一个弹性供应组的设置调用ModifyAutoProvisioningGroup接口修改一个弹性供应组的设置。
DescribeAutoProvisioningGroupHistory查询弹性供应组的调度任务信息调用DescribeAutoProvisioningGroupHistory查询弹性供应组的调度任务信息。
DeleteAutoProvisioningGroup删除一个弹性供应组调用DeleteAutoProvisioningGroup删除一个弹性供应组。

块存储

API标题API概述
CreateDisk创建一块按量付费或包年包月数据盘调用CreateDisk创建一块按量付费或包年包月数据盘。
DescribeDisks查询已经创建的块存储调用DescribeDisks查询一块或多块您已经创建的块存储(包括云盘以及本地盘)。
AttachDisk为实例挂载数据盘或系统盘调用AttachDisk为一台ECS实例挂载一块按量付费数据盘,或者挂载一块系统盘。实例和云盘必须在同一个可用区。
DetachDisk卸载按量付费数据盘或系统盘调用DetachDisk从一台ECS实例上卸载一块按量付费数据盘,或者卸载一块系统盘。
ModifyDiskAttribute修改块存储属性调用ModifyDiskAttribute修改一个或多个块存储的名称、描述、是否随实例释放等属性。
ReplaceSystemDisk更换操作系统调用ReplaceSystemDisk更换一台ECS实例的操作系统。系统盘的云盘ID会发生变化,原云盘会被释放。
ReInitDisk重新初始化一块云盘到创建时的初始状态调用ReInitDisk重新初始化一块云盘到创建时的初始状态。
ResizeDisk扩容云盘调用ResizeDisk扩容一块云盘,支持扩容系统盘和数据盘。
ResetDisk重置磁盘调用ResetDisk使用云盘的历史快照回滚至某一阶段的云盘状态。
ModifyDiskChargeType修改实例上云盘计费方式转换一台包年包月ECS实例上所挂载的数据盘的计费方式。
ModifyDiskSpec变更云盘类型或性能级别调用ModifyDiskSpec变更一块云盘类型,或者修改一块ESSD云盘的性能级别。
DeleteDisk释放一块按量付费数据盘调用DeleteDisk释放一块按量付费数据盘。磁盘类型包括普通云盘、高效云盘、SSD云盘和ESSD云盘。

预留实例券

API标题API概述
PurchaseReservedInstancesOffering购买一张预留实例券调用PurchaseReservedInstancesOffering购买一张预留实例券。预留实例券可以自动匹配对应的ECS实例,抵扣按量付费实例账单。
DescribeReservedInstances查询已经购买的预留实例券调用DescribeReservedInstances查询已经购买的预留实例券。
ModifyReservedInstances修改预留实例券调用ModifyReservedInstances拆分、合并或修改预留实例券。
ModifyReservedInstanceAttribute修改RI预留实例的属性调用ModifyReservedInstanceAttribute修改预留实例券的属性,包括名称和描述信息。
RenewReservedInstances对已购买的一张或多张预留实例券进行续费调用RenewReservedInstances对已购买的一张或多张预留实例券进行续费。
DescribeReservedInstanceAutoRenewAttribute查询预留实例券自动续费状态调用DescribeReservedInstanceAutoRenewAttribute查询一个或多个包年包月预留实例券自动续费状态。
ModifyReservedInstanceAutoRenewAttribute预留实例券设置自动续费,也可以取消已设定的自动续费调用ModifyReservedInstanceAutoRenewAttribute为一个或多个包年包月预留实例券设置自动续费,也可以取消已设定的自动续费。

存储容量单位包

API标题API概述
PurchaseStorageCapacityUnit购买存储容量单位包SCU调用PurchaseStorageCapacityUnit购买一个或多个存储容量单位包SCU(Storage Capacity Unit)。
DescribeStorageCapacityUnits查询存储容量单位包SCU详细信息查询一个或多个存储容量单位包SCU的详细信息。
ModifyStorageCapacityUnitAttribute修改存储容量单位包SCU属性调用ModifyStorageCapacityUnitAttribute修改一个存储容量单位包SCU的名称或者描述信息。

镜像

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

镜像构建

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

快照

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

前缀列表

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

安全组

API标题API概述
CreateSecurityGroup新建安全组调用CreateSecurityGroup新建一个安全组。新建的安全组,默认只允许安全组内的实例互相访问,安全组外的一切通信请求会被拒绝。若您想允许其他安全组实例的通信请求,或者来自互联网的访问请求,需要授权安全组权限(AuthorizeSecurityGroup)。
DescribeSecurityGroups查询安全组的基本信息调用DescribeSecurityGroups查询您创建的安全组的基本信息。
DescribeSecurityGroupAttribute查询一个安全组的安全组规则调用DescribeSecurityGroupAttribute查询一个安全组的安全组规则。
ModifySecurityGroupPolicy修改普通安全组内网连通策略调用ModifySecurityGroupPolicy修改普通安全组内网连通策略,企业安全组不支持修改组内内网连通策略。
ModifySecurityGroupAttribute修改一个安全组的名称或者描述调用ModifySecurityGroupAttribute修改一个安全组的名称或者描述。
ModifySecurityGroupRule修改安全组入方向规则的描述信息调用ModifySecurityGroupRule修改入方向安全组规则。
ModifySecurityGroupEgressRule修改安全组出方向规则的描述信息调用ModifySecurityGroupEgressRule修改出方向安全组规则。
AuthorizeSecurityGroup增加安全组入方向规则调用AuthorizeSecurityGroup增加一条或多条入方向安全组规则。指定安全组入方向的访问权限,允许或者拒绝其他设备发送入方向流量到安全组里的实例。
AuthorizeSecurityGroupEgress增加安全组出方向规则调用AuthorizeSecurityGroupEgress增加一条或多条安全组出方向规则。指定安全组出方向的访问权限,允许或者拒绝安全组里的实例发送出方向流量到其他设备。
JoinSecurityGroup将实例加入到指定安全组调用JoinSecurityGroup将一台ECS实例或一个弹性网卡加入到指定的安全组。
LeaveSecurityGroup将实例移出指定安全组调用LeaveSecurityGroup将一台ECS实例或一个弹性网卡移出指定的安全组。
DescribeSecurityGroupReferences查询有安全组级别的授权行为调用DescribeSecurityGroupReferences查询一个安全组和其他哪些安全组有安全组级别的授权行为。
RevokeSecurityGroup删除安全组入方向规则调用RevokeSecurityGroup删除一条或多条入方向安全组规则。
RevokeSecurityGroupEgress删除一条或多条出方向安全组规则调用RevokeSecurityGroupEgress删除一条或多条出方向安全组规则。
DeleteSecurityGroup删除一个安全组调用DeleteSecurityGroup删除一个安全组。

部署集

API标题API概述
CreateDeploymentSet在指定的地域内创建一个部署集调用CreateDeploymentSet在指定的地域内创建一个部署集。
DescribeDeploymentSetSupportedInstanceTypeFamily查询支持部署集的实例规格族调用DescribeDeploymentSetSupportedInstanceTypeFamily查询支持部署集的实例规格族。
DescribeDeploymentSets查询一个或多个部署集的属性列表调用DescribeDeploymentSets查询一个或多个部署集的属性列表。
ModifyDeploymentSetAttribute修改一个部署集的名称和描述信息调用ModifyDeploymentSetAttribute修改一个部署集的名称和描述信息。
DeleteDeploymentSet删除一个部署集调用DeleteDeploymentSet删除一个部署集。

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概述
ModifyInstanceVpcAttribute修改专有网络类型实例的VPC属性调用ModifyInstanceVpcAttribute修改一台专有网络类型ECS实例的专有网络VPC、私网IP地址或虚拟交换机。
AllocatePublicIpAddress分配固定公网IP调用AllocatePublicIpAddress为一台ECS实例分配一个固定公网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实例的带宽配置调用ModifyInstanceNetworkSpec修改ECS实例的带宽配置。当实例现有网络规格不满足要求时,可以通过修改实例的带宽配置提高网络性能。

弹性网卡

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

系统事件

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

运维与监控

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

高性能集群

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

标签与资源组

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

地域

API标题API概述
DescribeRegions查询可以使用的阿里云地域调用DescribeRegions查询您可以使用的阿里云地域。
DescribeZones查询阿里云可用区调用DescribeZones查询一个阿里云地域下的可用区。
DescribeAvailableResource查询某一可用区的资源列表调用DescribeAvailableResource查询某一可用区的资源列表。您可以在某一可用区创建实例(RunInstances)或者修改实例规格(ModifyInstanceSpec)时查询该可用区的资源列表。
DescribeAccountAttributes查询某地域下能创建的资源配额调用DescribeAccountAttributes查询您在一个阿里云地域下能创建的ECS资源配额。包括您能创建的安全组数量、弹性网卡数量、按量付费vCPU核数、抢占式实例vCPU核数、按量付费云盘总容量配额、专用宿主机数量、网络类型以及账号是否已完成实名认证。
DescribeResourcesModification查询某一可用区可用资源信息调用DescribeResourcesModification查询升级和降配实例规格或者系统盘时,某一可用区的可用资源信息。

询价

API标题API概述
DescribePrice查询云服务器ECS资源的最新价格调用DescribePrice查询云服务器ECS资源的最新价格。
DescribeRenewalPrice查询资源续费价格调用DescribeRenewalPrice查询云服务器ECS资源的续费价格。仅支持查询包年包月资源的续费价格。
DescribeInstanceModificationPrice查询未到期的包年包月ECS实例升配时目标实例规格的价格信息、新增包年包月数据盘的价格信息调用DescribeInstanceModificationPrice查询未到期的包年包月ECS实例升配时目标实例规格的价格信息、新增包年包月数据盘的价格信息。

存储集(Beta)

API标题API概述
CreateStorageSet在指定地域的可用区下创建一个存储集(Beta)调用CreateStorageSet在指定地域的可用区下创建一个存储集。
DescribeStorageSetDetails查询存储集内云盘或共享块存储详细信息(Beta)调用DescribeStorageSetDetails查询一个存储集内云盘或共享块存储的详细信息。
DescribeStorageSets查询存储集信息(Beta)调用DescribeStorageSets查询一个或多个存储集信息,包括所属地域、所属可用区、创建时间和最大分区数等信息。
ModifyStorageSetAttribute修改存储集属性(Beta)调用ModifyStorageSetAttribute修改一个存储集的名称或描述信息。
DeleteStorageSet删除一个空的存储集(Beta)调用DeleteStorageSet删除一个空的存储集。待删除的存储集必须为空,不能包含云盘或者共享块存储。

任务

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