See the following tables for the ECS APIs that are available to use.

For more information, see API Explorer.


API Description
RunInstances Creates a specified number of Subscription, Pay-As-You-Go, or preemptible instances.
CreateInstance Creates a Subscription, Pay-As-You-Go, or preemptible instance.
StartInstance Starts a specified instance.
StopInstance Stops a specified instance.
RebootInstance Restarts a specified instance.
DeleteInstance Releases a specified instance.
AttachInstanceRamRole Attaches a RAM role to your Instance.
DetachInstanceRamRole Detaches a RAM role from an instance.
DescribeInstanceStatus Obtains the list of all your instances in batches with status information.
DescribeInstances Describes details of your instances.
DescribeInstanceVncUrl Describes the management terminal URL before connecting to an instance.
DescribeUserdata Describes the user-defined data of an Instance.
DescribeInstanceAutoRenewAttribute Queries the automatic renewal status of an instance.
DescribeInstanceRamRole Describes information related to the instance RAM role for one or more instances.
DescribeSpotPriceHistory Describes the price history of the preemptible instances. You can query the price records within 30 days at most.
DescribeInstanceTypeFamilies Describes the list of instance type families provided by Alibaba Cloud ECS.
DescribeInstanceTypes Describes the list of instance types provided by Alibaba Cloud ECS.
ModifyInstanceVpcAttribute Modifies the attributes of a VPC to which a specified instance belongs.
ModifyInstanceAttribute Modifies the information on an instance, such as the name, password, and security group.
ModifyInstanceVncPasswd Modifies the password of management terminal used to connect a specified Instance.
ModifyInstanceAutoReleaseTime Sets the auto release time for a specified instance.
ModifyInstanceAutoRenewAttribute Sets the auto renewal attribute for a specified instance.
ModifyInstanceSpec Modifies the instance type or Internet bandwidth of a Pay-As-You-Go instance.
ModifyPrepayInstanceSpec Upgrades or downgrades the instance specification.

Launch templates

API Description
CreateLaunchTemplate Creates an instance launch template (launch template for short). An instance launch template allows you to automatically set configuration parameters that are used each time you create a new instance.
CreateLaunchTemplateVersion Creates a version based on the specified instance launch template.
DeleteLaunchTemplate Deletes an instance launch template.
DeleteLaunchTemplateVersion Deletes a specified instance launch template version. However, if you want to delete the default version, you must first use the DeleteLaunchTemplate API to delete the entire instance launch template.
DescribeLaunchTemplates Describes available instance launch templates.
DescribeLaunchTemplateVersions Describes instance launch template versions.
ModifyLaunchTemplateDefaultVersion Sets a specified version of this template as the default version. If you do not specify a template version when creating an instance (RunInstances), the default version is used.


API Description
CreateDisk Creates a data disk from a cloud disk.
DeleteDisk Releases a cloud disk.
DescribeDisks Describes your available cloud disks.
AttachDisk Attaches a data disk to your Instance.
DetachDisk Detaches a cloud disk from a specified instance.
ModifyDiskChargeType Modifies the billing method for up to 16 disks that are attached to an instance.
ModifyDiskAttribute Modifies the attributes of your cloud disk.
ReplaceSystemDisk Replaces the system disk or the operating system of an Instance.
ReInitDisk Initializes a cloud disk to the initial state.
ResetDisk Rolls back a disk to a specified disk state by using one of its historic disk snapshots.
ResizeDisk Expands the size of a cloud disk.


API Description
CreateImage Creates a custom image.
ImportImage Imports your locally saved image files to Alibaba Cloud ECS. Such images will appear in the corresponding regions as custom images.
ExportImage Exports a custom image to an OSS bucket in the same region as the custom image.
CopyImage Copies a custom image from one region to other regions.
CancelCopyImage Cancels an ongoing image copy (CopyImage) operation.
DescribeImages Describes your available images.
DeleteImage Deletes a specified custom image.
DescribeImageSharePermission Describes all the users with whom a custom image is shared.
ModifyImageAttribute Modifies the name and description of a custom image.
ModifyImageSharePermission Shares a custom image to other Alibaba Cloud users.


API Description
CreateSnapshot Creates a snapshot for a specified disk.
CreateAutoSnapshotPolicy Creates an automatic snapshot policy.
ApplyAutoSnapshotPolicy Applies automatic snapshot policies to one or more disks.
DeleteSnapshot Deletes a specified snapshot.
CancelAutoSnapshotPolicy Cancels the automatic snapshot policy for one or more disks.
DeleteAutoSnapshotPolicy Creates an automatic snapshot policy.
DescribeAutoSnapshotPolicyEx Describes your available automatic snapshot policies.
DescribeSnapshots Describes all the disk snapshots for a specified instance.
DescribeSnapshotLinks Describes the snapshot chains of one or more disks.
ModifyAutoSnapshotPolicyEx Modifies an automatic snapshot policy.
DescribeSnapshotsUsage Describes the quantity and size of snapshots in a region.
DescribeSnapshotPackage Describes your purchased OSS storage plans in an Alibaba Cloud region. These storage plans can be used for snapshot storage.

Security groups

API Description
CreateSecurityGroup Creates a security group.
AuthorizeSecurityGroup Adds an inbound rule for a security group.
AuthorizeSecurityGroupEgress Adds an outbound rule for a security group.
RevokeSecurityGroup Deletes an inbound rule from a security group.
RevokeSecurityGroupEgress Deletes an outbound rule from a security group.
JoinSecurityGroup Adds an instance to a specified security group.
LeaveSecurityGroup Removes an instance from a specified security group.
DeleteSecurityGroup Deletes a security group.
DescribeSecurityGroupAttribute Describes your security groups in detail.
DescribeSecurityGroups Describes the basic information about your security groups, such as the security group ID and description.
DescribeSecurityGroupReferences Describes whether a specified security group has been authorized by other security groups.
ModifySecurityGroupAttribute Modifies the attributes of a specified security group, including the security group name and description.
ModifySecurityGroupPolicy Modifies the intranet communication policy of a security group.
ModifySecurityGroupRule Modifies the description of a security group inbound rule.

Deployment sets

API Description
CreateDeploymentSetId Creates a deployment set in a specified region.
ModifyInstanceDeployment Migrates an ECS instance to another host in the same region.
ModifyDeploymentSetAttributes Adds an instance to a deployment set or migrates an instance to another deployment set.
DescribeDeploymentSets Describes the attributes of one or more deployment sets.
DeleteDeploymentSet Deletes a deployment set.

SSH key pairs

API Description
CreateKeyPair Creates an SSH key pair.
ImportKeyPair Imports the public key of an SSH key pair that is created by other key pair generators.
AttachKeyPair Attaches an SSH key pair to one or more Linux instances.
DetachKeyPair Detaches an SSH key pair from one or more Linux instances.
DeleteKeyPairs Deletes one or more SSH key pairs.
DescribeKeyPairs Describes one or more SSH key pairs.


API Description
AllocatePublicIpAddress Assigns an Internet IP address to an instance.
ConvertNatPublicIpToEip Changes the Internet IP address (NatPublicIp) of a VPC instance to an Elastic IP (EIP).
AttachClassicLinkVpc Links a classic network instance to a VPC so that the classic network instance can communicate with the resources in the VPC over the intranet.
DetachClassicLinkVpc Removes the link between a classic network instance and a VPC.
DescribeBandwidthLimitation Describes a list of bandwidth resources.
DescribeClassicLinkInstances Describes one or more classic network instances that have established links with a VPC.
ModifyInstanceNetworkSpec Modifies the bandwidth configuration for a specified instance.


API Description
CreateNetworkInterface Creates an Elastic Network Interface (ENI).
AttachNetworkInterface Attaches an ENI to a VPC instance.
DetachNetworkInterface Detaches an ENI from an instance.
DeleteNetworkInterface Deletes an ENI.
DescribeNetworkInterfaces Describes the list of ENIs.
ModifyNetworkInterfaceAttribute Modifies the attributes of an ENI.
AssignPrivateIpAddresses Assigns one or more secondary private IP addresses to an ENI. Specifically, you can specify private IP addresses within the CIDR block of the VSwitch to which an ENI belongs. Alternatively, you can specify the number of private IP addresses for ECS to assign them automatically.
UnassignPrivateIpAddresses Releases one or more secondary private IP addresses from an ENI.

System events

API Description
DescribeDisksFullStatus Describes all the status information on a disk.
CreateSimulatedSystemEvents Schedules simulated system events for one or more ECS instances. Simulated system events do not occur in reality, nor do they affect ECS instances.
CancelSimulatedSystemEvents Cancels one or more simulated system events that are in the Scheduled or Executing status. After you cancel a simulated system event, the simulated event is in the Canceled status.
DescribeInstancesFullStatus Describes all the status information on an instance.
DescribeInstanceHistoryEvents Describes the inactive historic events of a specified Instance. The maximum length of query period is two months.

O&M and monitoring

API Description
DescribeDiskMonitorData Describes the usage information on a specified disk within a certain period of time.
DescribeInstanceMonitorData Describes all the monitoring data on an instance. The query results can be displayed on multiple pages.
GetInstanceScreenshot Obtains screenshot information on an instance.
GetInstanceConsoleOutput Obtains the command line output of an instance. The returned output is Base64-encoded.
DescribeEniMonitorData Describes the traffic information on a secondary ENI within a specified period.

Cloud Assistant

API Description
CreateCommand Creates a Cloud Assistant command.
InvokeCommand Executes a specified command on the target instances.
StopInvocation Stops Cloud Assistant command processes that are in the Running status on the target instances.
DeleteCommand Deletes a created Cloud Assistant command.
DescribeCommands Describes the Cloud Assistant commands that you have created.
DescribeInvocations Describes the invocation list and status of Cloud Assistant commands on your instances.
DescribeInvocationResults Describes the invocation result of a Cloud Assistant command, namely the actual output on a specified instance.
ModifyCommand Modifies the parameters and content of a Cloud Assistant command.


API Description
AddTags Adds one or more tags to your ECS resources or overwrites the existing tags.
RemoveTags Removes one or more tags from the specified ECS resources, such as instances, disks, snapshots, images, and security groups.
DescribeTags Describes the tags that are available to you.

Regions and zones

API Description
DescribeRegions Describes the Alibaba Cloud regions that are available to you.
DescribeZones Describes the zones that are available to you in a specified region.
DescribeAvailableResource Describes a list of the resources available in a certain zone.
DescribeResourcesModification Describes a list of resources available in a certain zone upon upgrading or downgrading an instance type or system disk.

Other APIs

API Description
CancelTask Cancels an ongoing task.
DescribeTasks Describes the progress of a specified asynchronous request.
DescribeTaskAttribute Describes the details of a specified asynchronous task. Currently, the asynchronous tasks that can be queried include importing images (ImportImage) and exporting images (ExportImage).
DescribeAccountAttributes Describes the maximum number of ECS resources that you can create in a region. Specifically, you can use this interface to query the quota for security groups, ENIs, Pay-As-You-Go instance vCPU cores, preemptible instance vCPU cores, and Dedicated Hosts (DDHs), local network type, and whether your account has been authenticated with real name credentials.