The following tables list API operations available for use in ECS.

Instances

API Description
RunInstances Creates one or more pay-as-you-go or subscription instances.
CreateInstance Creates a subscription or pay-as-you-go instance.
StartInstance Starts an instance.
StopInstance Stops an instance.
RebootInstance Restarts an instance that is in the Running state.
DeleteInstance Releases a pay-as-you-go instance or an expired subscription instance.
StartInstances Starts one or more instances that are in the Stopped state.
RebootInstances Restarts one or more instances that are in the Running state.
StopInstances Stops one or more instances that are in the Running state.
AttachInstanceRamRole Attaches an instance RAM role to one or more instances. An instance can have only one instance RAM role. If an instance already has an instance RAM role, an error is returned when you attach another instance RAM role to the instance.
DetachInstanceRamRole Detaches an instance RAM role from one or more instances.
DescribeInstanceStatus Queries the status information of one or more instances.
DescribeInstances Queries details of one or more instances.
DescribeInstanceVncUrl Queries the VNC URL of an instance.
DescribeUserData Queries the user data of an instance.
DescribeInstanceAutoRenewAttribute Queries the auto-renewal status of one or more subscription instances.
DescribeInstanceRamRole Queries instance RAM roles attached to one or more instances.
DescribeSpotPriceHistory Queries the price history of a preemptible instance in the last 30 days.
DescribeInstanceTypeFamilies Queries instance families provided by ECS.
DescribeInstanceTypes Queries instance types provided by ECS.
ModifyInstanceAttribute Modifies information about an instance, such as the password, name, description, hostname, and user data. For a burstable instance, you can also change its performance mode.
ModifyInstanceVncPasswd Modifies the VNC password of an instance.
ModifyInstanceAutoReleaseTime Sets or cancels the automatic release time for a pay-as-you-go instance. If you set the automatic release time, the instance is automatically released at the specified time. Exercise caution when you perform this operation.
ModifyInstanceAutoRenewAttribute Configures auto-renewal for one or more subscription instances. To reduce the maintenance workload when instances expire, you can configure auto-renewal for subscription instances.
ModifyInstanceChargeType Changes the billing method of one or more instances. You can change the billing methods of instances between pay-as-you-go and subscription, or change the billing method of all data disks attached to an instance from pay-as-you-go to subscription.
ModifyInstanceSpec Changes the instance type and public bandwidth of a pay-as-you-go instance.
ModifyPrepayInstanceSpec Upgrades or downgrades the instance type of a subscription instance. The new instance type takes effect for the entire lifecycle of the instance.
ModifyInstanceMetadataOptions Modifies the metadata of an instance.
RenewInstance Renews a subscription instance.
ReactivateInstances Reactivates a pay-as-you-go instance that is in the Expired state or the Overdue and Being Recycled state.
DeleteInstances Releases one or more pay-as-you-go instances or expired subscription instances.

Dedicated hosts

API Description
AllocateDedicatedHosts Creates one or more pay-as-you-go or subscription dedicated hosts. A dedicated host is a physical server dedicated to a single tenant. You can create ECS instances on a dedicated host and view the attributes of the dedicated host.
CreateDedicatedHostCluster Creates a dedicated host cluster.
DescribeDedicatedHostClusters Queries details of one or more dedicated host clusters.
ModifyDedicatedHostClusterAttribute Modifies some attributes of a dedicated host cluster, such as its name and description.
DeleteDedicatedHostCluster Deletes a dedicated host cluster.
RenewDedicatedHosts Renews one or more subscription dedicated hosts.
ReleaseDedicatedHost Releases a pay-as-you-go dedicated host.
RedeployDedicatedHost Migrates instances from a failed dedicated host.
DescribeDedicatedHosts Queries details of one or more dedicated hosts, including the physical performance specifications, machine codes, service status, and a list of ECS instances that are created on the dedicated hosts.
DescribeDedicatedHostTypes Queries details of dedicated host types supported in a region, or the ECS instance families supported by a specific dedicated host type.
DescribeDedicatedHostAutoRenew Queries the auto-renewal status of one or more subscription dedicated hosts.
ModifyInstanceDeployment Modifies the deployment set of an instance or migrates an instance to a dedicated host. The instance and the destination dedicated host must be in the same region.
ModifyDedicatedHostAttribute Modifies information of a dedicated host, such as the name, description, and instance migration policy applied when the dedicated host fails.
ModifyDedicatedHostAutoReleaseTime Sets or cancels the automatic release time for a pay-as-you-go dedicated host.
ModifyDedicatedHostAutoRenewAttribute Enables or disables auto-renewal for one or more subscription dedicated hosts.
ModifyDedicatedHostsChargeType Changes the billing method of one or more dedicated hosts.

Launch templates

API Description
CreateLaunchTemplate Creates a launch template. A launch template eliminates the needs to configure a large number of parameters each time you create an instance.
CreateLaunchTemplateVersion Creates a version for a specific launch template.
DeleteLaunchTemplate Deletes a launch template.
DeleteLaunchTemplateVersion Deletes a version of a specific launch template. This operation does not delete the default version. To delete the default version, you must call the DeleteLaunchTemplate operation.
DescribeLaunchTemplates Queries one or more available launch templates.
DescribeLaunchTemplateVersions Queries versions of launch templates.
ModifyLaunchTemplateDefaultVersion Modifies the default version of a launch template. If you do not specify a template version number when you create instances (RunInstances), the default version is used.

Auto provisioning groups

API Description
CreateAutoProvisioningGroup Creates an auto provisioning group.
ModifyAutoProvisioningGroup Modifies the configurations of an auto provisioning group.
DeleteAutoProvisioningGroup Deletes an auto provisioning group.
DescribeAutoProvisioningGroupInstances Queries instances in an auto provisioning group.
DescribeAutoProvisioningGroups Queries information of auto provisioning groups.
DescribeAutoProvisioningGroupHistory Queries the scheduling tasks of an auto provisioning group.

Elastic Block Storage (EBS)

API Description
CreateDisk Creates a pay-as-you-go or subscription data disk. The data disk can be a basic disk, an ultra disk, a standard SSD, or an enhanced SSD (ESSD).
DeleteDisk Releases a pay-as-you-go data disk. The data disk can be a basic disk, an ultra disk, a standard SSD, or an ESSD.
DescribeDisks Queries one or more EBS devices that you have created, including cloud disks and local disks.
AttachDisk Attaches a pay-as-you-go disk to an instance.
DetachDisk Detaches a pay-as-you-go disk from an instance. The disk can be a basic disk, an ultra disk, or a standard SSD.
ModifyDiskAttribute Modifies the properties of one or more disks.
ReplaceSystemDisk Replaces the system disk or operating system of an instance.
ReInitDisk Re-initializes a disk to restore it to the status when it was created.
ResetDisk Rolls back a disk to a specific state based on a snapshot of the disk.
ResizeDisk Resizes a system disk or data disk.
ModifyDiskChargeType Changes the billing methods of up to 16 disks attached to an instance.
ModifyDiskSpec Upgrades the performance level of an ESSD.

Reserved instances

API Description
PurchaseReservedInstancesOffering Purchases a reserved instance. Reserved instances can be applied to automatically offset bills of pay-as-you-go instances.
DescribeReservedInstances Queries purchased reserved instances.
ModifyReservedInstances Modifies reserved instances.

Images

API Description
CreateImage Creates a custom image. You can use the created image to create ECS instances (RunInstances) and replace system disks (ReplaceSystemDisk).
ImportImage Imports a local image to ECS. The imported local image appears as a custom image in the corresponding region.
ExportImage Exports a custom image to an OSS bucket in the same region.
CopyImage Copies a custom image from one region to another. You can deploy or copy instances across regions by copying images.
CancelCopyImage Cancels an ongoing image copying (CopyImage) task.
DescribeImages Queries available images.
DeleteImage Deletes a custom image.
DescribeImageSharePermission Queries the accounts to which a custom image is shared. The response can be displayed by page. By default, ten entries are displayed on each page.
ModifyImageAttribute Modifies the name, description, status, or image family of a custom image.
ModifyImageSharePermission Manages the share permission on a custom image. After you share a custom image to another Alibaba Cloud account, the account can use the shared image to create ECS instances (RunInstances) or replace system disks of ECS instances (ReplaceSystemDisk).
DescribeImageSupportInstanceTypes Queries the instance types supported by an image.
DescribeImageFromFamily Queries available custom images that are newly created in a specific image family.

Storage capacity units (SCUs)

API Description
PurchaseStorageCapacityUnit Purchases one or more SCUs.
ModifyStorageCapacityUnitAttribute Modifies the name and description of an SCU.
DescribeStorageCapacityUnits Queries details of one or more SCUs.

Snapshots

API Description
CreateSnapshot Creates a snapshot for a disk.
CreateAutoSnapshotPolicy Creates an automatic snapshot policy.
ApplyAutoSnapshotPolicy Applies an automatic snapshot policy to one or more disks. If you apply an automatic snapshot policy to a disk that already has an automatic snapshot policy, the new policy replaces the original policy to take effect on the disk.
CopySnapshot Copies a normal snapshot from one region to another.
DeleteSnapshot Deletes a snapshot. If you call this operation to delete a snapshot that is being created, the snapshot creation task is canceled.
CancelAutoSnapshotPolicy Disables the automatic snapshot policy for one or more disks.
DeleteAutoSnapshotPolicy Deletes an automatic snapshot policy. After you delete an automatic snapshot policy, the policy is no longer applied to the disks on which it previously took effect.
DescribeAutoSnapshotPolicyEX Query the automatic snapshot policies that you have created.
DescribeSnapshots Queries all snapshots of an instance or a disk. You can specify multiple request parameters such as InstanceId, DiskId, and SnapshotIds to be queried. Specified parameters have logical AND relations. Only the specified parameters are included in the filter conditions.
DescribeSnapshotLinks Queries the snapshot chains of one or more disks. A snapshot chain is a chain of all the snapshots created for a disk. A disk corresponds to a chain of snapshots.
ModifyAutoSnapshotPolicyEx Modifies an automatic snapshot policy. After an automatic snapshot policy is modified, the modifications take effect immediately on the disks to which the policy is applied.
DescribeSnapshotsUsage Queries the number of snapshots that are stored in a region and the total size of the snapshots.
ModifySnapshotAttribute Modifies the name and description of a snapshot.

Security groups

API Description
CreateSecurityGroup Creates a security group. For a new security group, only instances in the security group can access each other by default. Access requests to the security group from outside are denied. If you want to receive requests from the Internet or requests from instances in other security groups, you can call the AuthorizeSecurityGroup operation to allow the requests.
AuthorizeSecurityGroup Creates an inbound security group rule. This operation allows or denies inbound traffic from other devices to the instances in the security group.
AuthorizeSecurityGroupEgress Creates an outbound security group rule. This operation allows or denies outbound traffic from the instances in the security group to other devices.
RevokeSecurityGroup Deletes an inbound security group rule. After the rule is deleted, the access control implemented by it is removed.
RevokeSecurityGroupEgress Deletes an outbound security group rule. After the rule is deleted, the access control implemented by it is removed.
JoinSecurityGroup Adds an instance to a security group.
LeaveSecurityGroup Removes an instance from a security group.
DeleteSecurityGroup Deletes a security group.
DescribeSecurityGroupAttribute Queries the rules of a security group.
DescribeSecurityGroups Queries basic information of security groups. Basic information of security groups includes their IDs and descriptions. Security groups are displayed in descending order of their IDs.
DescribeSecurityGroupReferences Queries whether a security group is referenced by other security groups.
ModifySecurityGroupAttribute Modifies the name or description of a security group.
ModifySecurityGroupPolicy Modifies the internal access control policy of a basic security group.
ModifySecurityGroupRule Modifies the description of inbound rules of a security group. You can call the AuthorizeSecurityGroup operation to create an inbound security group rule.
ModifySecurityGroupEgressRule Modifies the description of outbound rules of a security group. You can call the AuthorizeSecurityGroupEgress operation to create an outbound security group rule.

Deployment sets

API Description
CreateDeploymentSet Creates a deployment set in a specific region.
DeleteDeploymentSet Deletes a deployment set.
ModifyDeploymentSetAttribute Modifies the name and description of a deployment set.
DescribeDeploymentSets Queries the attributes of one or more deployment sets.

SSH key pairs

API Description
CreateKeyPair Creates an SSH key pair. Alibaba Cloud stores the public key and returns the unencrypted private key. The private key is PEM-encoded in the PKCS#8 format. You must securely lock the private key away on your own.
ImportKeyPair Imports the public key of an RSA-encrypted key pair that is generated by a third-party tool. After the key pair is imported, the public key is stored in Alibaba Cloud. You must securely lock the private key away on your own.
AttachKeyPair Binds an SSH key pair to one or more Linux instances.
DetachKeyPair Unbinds an SSH key pair from one or more Linux instances.
DeleteKeyPairs Deletes one or more SSH key pairs. After an SSH key pair is deleted, the public key is no longer stored in Alibaba Cloud. However, the instance to which the SSH key pair is bound can still use the key pair, and the key pair name is still displayed on the instance details page.
DescribeKeyPairs Queries one or more key pairs.

Network

API Description
ModifyInstanceVpcAttribute Modifies the VPC properties of an instance.
AllocatePublicIpAddress Assigns a public IP address to an instance.
ConvertNatPublicIpToEip Converts the public IP address of a VPC-type instance to an elastic IP address (EIP).
AttachClassicLinkVpc Links a classic network-type instance to a VPC by establishing a ClassicLink connection. This way, the instance can communicate with cloud resources in the VPC over the internal network.
DetachClassicLinkVpc Unlinks a classic network-type instance from a VPC by removing the ClassicLink connection between them. After the instance is unlinked from the VPC, it can no longer communicate with the resources in the VPC.
DescribeBandwidthLimitation Queries available bandwidth resources.
DescribeClassicLinkInstances Queries one or more classic network-type instances that have established ClassicLink connections with VPCs.
ModifyInstanceNetworkSpec Modifies the bandwidth configurations of an instance. You can modify the bandwidth configurations of an instance to improve network performance.

Elastic network interfaces (ENIs)

API Description
CreateNetworkInterface Creates an ENI.
AttachNetworkInterface Binds an ENI to a VPC-type instance.
DetachNetworkInterface Unbinds an ENI from an instance.
DeleteNetworkInterface Deletes an ENI.
DescribeNetworkInterfaces Queries one or more ENIs.
ModifyNetworkInterfaceAttribute Modifies the properties such as the name, description, and security group of an ENI.
AssignPrivateIpAddresses Assigns one or more secondary private IP addresses to an ENI. You can specify available private IP addresses within the CIDR block of the VSwitch that is associated with the ENI. Alternatively, you can specify a number of private IP addresses for ECS to assign them automatically.
UnassignPrivateIpAddresses Unassigns one or more secondary private IP addresses from an ENI.

System events

API Description
DescribeDisksFullStatus Queries the full status information of one or more EBS devices.
DescribeInstancesFullStatus Queries the full status information of one or more instances. The full status information includes the instance status and the status of an instance system event. The instance status is the lifecycle status of an instance. The status of an instance system event is the health status of a maintenance event.
DescribeInstanceHistoryEvents Queries the system events of an instance. By default, system events that are in the Executed, Avoided, Canceled, or Failed state are queried.
CancelSimulatedSystemEvents Cancels one or more simulated system events that are in the Scheduled or Executing state. After you cancel a simulated system event, the simulated event enters the Canceled state.
CreateSimulatedSystemEvents Schedules simulated system events for one or more instances. The simulated system events do not actually occur on or affect ECS instances.
AcceptInquiredSystemEvent Accepts the default operation for a system event in the Inquiring state and authorizes the system to perform the default operation.

O&M and monitoring

API Description
DescribeDiskMonitorData Queries the monitoring data of a disk over a specific period of time.
DescribeInstanceMonitorData Queries the monitoring data of an instance. You can query the vCPU utilization, burstable instance credits, inbound data traffic, outbound data traffic, and average bandwidth of the instance.
GetInstanceScreenshot Obtains the screenshots of an instance.
GetInstanceConsoleOutput Obtains the command output of an instance. The returned command output is encoded in Base64.
DescribeEniMonitorData Queries the monitoring data of a secondary ENI over a specific period of time.
RedeployInstance Redeploys an instance when the instance receives an event notification.
DescribeSnapshotMonitorData Queries the monitoring data of changes in snapshot sizes in a region over the last 30 days.
DescribeInstanceMaintenanceAttributes Queries the maintenance attributes of an instance.
ModifyInstanceMaintenanceAttributes Modifies the maintenance attributes of an instance.

Cloud Assistant

API Description
CreateCommand Creates a Cloud Assistant command.
InvokeCommand Triggers a Cloud Assistant command for one or more instances.
StopInvocation Stops the process of a running Cloud Assistant command on one or more instances.
DeleteCommand Deletes a Cloud Assistant command.
DescribeCommands Queries Cloud Assistant commands that you have created. If you specify only the Action and RegionId parameters, all available commands are queried.
DescribeInvocations Queries the execution list and status of Cloud Assistant commands in the last two weeks.
DescribeInvocationResults Queries the execution results of Cloud Assistant commands on instances.
DescribeCloudAssistantStatus Queries whether the Cloud Assistant client is installed on one or more instances.
InstallCloudAssistant Installs the Cloud Assistant client on one or more instances.
RunCommand Creates a Cloud Assistant command of the shell, PowerShell, or batch type, and then runs the command on one or more instances.

HPC clusters

API Description
DeleteHpcCluster Deletes an HPC cluster.
CreateHpcCluster Creates an HPC cluster.
DescribeHpcClusters Queries available HPC clusters. You can specify multiple request parameters to be queried. Specified parameters have logical AND relations. Only the specified parameters are included in the filtering conditions.
ModifyHpcClusterAttribute Modifies the description of an HPC cluster.

Tags

API Description
TagResources Creates and binds tags to specified ECS resources.
ListTagResources Queries tags that are bound to one or more ECS resources.
UntagResources Unbinds tags from specified ECS resources.

Regions

API Description
DescribeRegions Queries available Alibaba Cloud regions.
DescribeZones Queries the zones in a specific region.
DescribeAvailableResource Queries resources in a specific zone. For example, you can query the most recent resource list before you create instances (RunInstances) or modify instance specifications (ModifyInstanceSpec) in a zone.
DescribeResourcesModification Queries available resources in a specific zone when you upgrade or downgrade instance types or replace system disks.

Other operations

API Description
CancelTask Cancels a running task. You can cancel the running tasks generated by the ImportImage or ExportImage operation.
DescribeTasks Queries the progress of one or more asynchronous requests.
DescribeTaskAttribute Queries details of an asynchronous task. You can query the asynchronous tasks generated by the ImportImage or ExportImage operation.
DescribeAccountAttributes Queries the quotas of ECS resources that you can create in an Alibaba Cloud region. You can query the maximum numbers of security groups, ENIs, vCPUs for pay-as-you-go instances, vCPUs for preemptible instances, and dedicated hosts that you can create in a region. You can also query the information such as the network type or whether an account has passed the real-name verification.
JoinResourceGroup Adds an ECS resource to a resource group.
DescribePrice Queries the most recent prices of ECS resources. This operation is in internal preview.
DescribeRenewalPrice Queries the renewal price of an ECS resource. This operation is in internal preview. You can call this operation to query only the renewal prices of subscription instances.
DescribeDemands Queries the delivery and usage status of filed resources.