The following tables list API operations for use in ECS. For more information, see OpenAPI Explorer.

Instances

Operation Description
RunInstances Creates one or more pay-as-you-go or subscription ECS instances.
CreateInstance Creates a pay-as-you-go or subscription ECS 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 ECS instances that are in the Stopped state.
RebootInstances Restarts one or more ECS instances that are in the Running state.
StopInstances Stops one or more ECS instances that are in the Running state.
AttachInstanceRamRole Attaches a RAM role to one or more ECS instances. An ECS instance can only have one RAM role at any time. If an instance already has a RAM role, an error code will be returned when you attach another RAM role to the instance.
DetachInstanceRamRole Detaches a RAM role from one or more ECS instances.
DescribeInstanceStatus Queries the status information of one or more ECS instances.
DescribeInstances Queries details of one or more instances.
DescribeInstanceVncUrl Queries the VNC URL of an ECS instance.
DescribeUserData Queries the user data of an ECS instance.
DescribeInstanceAutoRenewAttribute Queries the auto-renewal status of one or more subscription ECS instances.
DescribeInstanceRamRole Queries RAM roles attached to one or more ECS instances.
DescribeSpotPriceHistory Queries the price history of a preemptible instance within the last 30 days.
DescribeInstanceTypeFamilies Queries instance families provided by ECS.
DescribeInstanceTypes Queries instance types provided by ECS.
ModifyInstanceAttribute Modifies information about an ECS instance, such as the password, name, description, hostname, and user data. For a burstable instance, you can also change its burst mode.
ModifyInstanceVncPasswd Modifies the VNC password of an instance.
ModifyInstanceAutoReleaseTime Sets or cancels the automatic release time for a pay-as-you-go instance. Exercise caution when you set the automatic release time because the instance will be automatically released upon expiration.
ModifyInstanceAutoRenewAttribute Configures auto-renewal for one or more subscription instances. To reduce the maintenance workload when an instance expires, you can configure auto-renewal for subscription ECS instances.
ModifyInstanceChargeType Changes the billing method of one or more ECS instances. You can switch the billing method of instances between pay-as-you-go and subscription, or switch the billing method of all data disks attached to an instance from pay-as-you-go to subscription.
ModifyInstanceSpec Modifies the instance type and public bandwidth of a pay-as-you-go instance.
ModifyPrepayInstanceSpec Upgrades or downgrades the instance type of a subscription ECS 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 ECS instance.
ReactivateInstances Reactivates a pay-as-you-go ECS instance that is overdue and being recycled and in the Stopped state.
DeleteInstances Releases one or more pay-as-you-go ECS instances or expired subscription ECS instances.

Dedicated hosts

Operation Description
AllocateDedicatedHosts Creates one or more pay-as-you-go or subscription dedicated hosts. A dedicated host provides a dedicated physical server for a single tenant. You can create ECS instances on a dedicated host and view the attributes of the physical server.
RenewDedicatedHosts Renews one or more subscription dedicated hosts.
ReleaseDedicatedHost Releases a pay-as-you-go dedicated host.
RedeployDedicatedHost Migrates ECS instances from a failed dedicated host.
DescribeDedicatedHosts Queries the detailed information of one or more dedicated hosts, including the physical performance metrics, machine code, usage status, and list of ECS instances that have been created.
DescribeDedicatedHostTypes Queries the specifications of supported dedicated hosts in a region, or the ECS instance families that are supported by a specific type of dedicated hosts.
DescribeDedicatedHostAutoRenew Queries the auto-renewal status of one or more subscription dedicated hosts.
ModifyInstanceDeployment Changes the dedicated host of an ECS instance. The ECS instance and the destination dedicated host must be in the same region.
ModifyDedicatedHostAttribute Modifies the information of a dedicated host, including the name, description, and instance migration policy that is applied when the dedicated host fails.
ModifyDedicatedHostAutoReleaseTime Sets the automatic release time for a pay-as-you-go dedicated host or cancels the automatic release of a pay-as-you-go dedicated host.
ModifyDedicatedHostAutoRenewAttribute Enables or disables automatic renewal for one or more subscription dedicated hosts.
ModifyDedicatedHostsChargeType Modifies the billing method of a dedicated host.

Launch templates

Operation Description
CreateLaunchTemplate Creates an instance launch template (template). An instance launch template eliminates the needs to configure a large number of parameters every time you create an instance.
CreateLaunchTemplateVersion Creates a version for the specified instance launch template.
DeleteLaunchTemplate Deletes an ECS instance launch template.
DeleteLaunchTemplateVersion Deletes a version of the specified instance 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 ECS instance launch templates.
DescribeLaunchTemplateVersions Queries versions of ECS instance launch templates.
ModifyLaunchTemplateDefaultVersion Modifies the default version of an ECS instance launch template. If you do not specify a template version number when you create an ECS instance (RunInstances), the default version will be used.

Auto provisioning groups

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

Block Storage

Operation 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 enhanced SSD.
DescribeDisks Queries one or more cloud disks and local disks that you have created.
AttachDisk Attaches a pay-as-you-go data disk to an ECS instance.
DetachDisk Detaches a pay-as-you-go disk from an ECS instance. The disks to be detached can be a basic disk, an ultra disk, or a standard SSD.
ModifyDiskAttribute Modifies the attributes of a disk.
ReplaceSystemDisk Replaces the system disk or operating system of an ECS instance.
ReInitDisk Re-initializes a disk to restore it to the status when it was created.
ResetDisk Rolls back a disk to the specified state based on a snapshot of the disk.
ResizeDisk Resizes a system disk or data disk.
ModifyDiskChargeType Modifies the billing methods of up to 16 disks attached to an instance.
ModifyDiskSpec Upgrades the performance level of an enhanced SSD.

Reserved instances

Operation Description
PurchaseReservedInstancesOffering Purchases a reserved instance to automatically offset the bills of pay-as-you-go instances.
DescribeReservedInstances Queries the reserved instances that you have purchased.
ModifyReservedInstances Modifies reserved instances.

Images

Operation Description
CreateImage Creates a custom image. You can use the created image to create ECS instances (RunInstances) and replace system disks (ReplaceSystemDisk).
ImportImage Imports an existing image file to ECS and has the image displayed as a custom image in the corresponding region.
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 another. This operation helps you deploy and copy ECS instances across regions.
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 and description of a custom image.
ModifyImageSharePermission Manages the share permission of an image. After you share a custom image with another Alibaba Cloud account, the account can use the shared image to create ECS instances (RunInstances) or replace the system disk of an ECS instance (ReplaceSystemDisk).
DescribeImageSupportInstanceTypes Queries the instance types supported by a specific image.

Snapshots

Operation Description
CreateSnapshot Creates a snapshot for the specified disk.
CreateAutoSnapshotPolicy Creates an automatic snapshot policy.
ApplyAutoSnapshotPolicy Applies an automatic snapshot policy to one or more disks. If the target disk has an automatic snapshot policy applied, you can call this API operation to replace the automatic snapshot policy.
DeleteSnapshot Deletes the specified snapshot. If you call this operation to delete a snapshot that is being created, the task of creating the snapshot is canceled.
CancelAutoSnapshotPolicy Removes the automatic snapshot policy of one or more disks.
DeleteAutoSnapshotPolicy Deletes an automatic snapshot policy. After you delete an automatic snapshot policy, the policy will no longer be applied to the disks that it previously took effect on.
DescribeAutoSnapshotPolicyEX Queries the automatic snapshot policies that you have created.
DescribeSnapshots Queries all snapshots of an ECS instance or a disk. Request parameters such as InstanceId, DiskId, and SnapshotIds act as filtering conditions and have a Boolean AND relationship.
DescribeSnapshotLinks Queries the snapshot chain of a disk. A snapshot chain is a chain of all the snapshots of a disk. A disk corresponds to a snapshot chain. The snapshot chain ID is the same as the disk ID.
ModifyAutoSnapshotPolicyEx Modifies an automatic snapshot policy. After you modify an automatic snapshot policy, the new policy takes effect immediately on the disks that have applied the policy.
DescribeSnapshotsUsage Queries the number of snapshots that are stored in a region and the total size of the snapshots.
DescribeSnapshotPackage Queries the Object Storage Service (OSS) storage plans that you have purchased in a region. Storage plans can be used to offset the storage space of snapshots.
ModifySnapshotAttribute Modifies the name and description of a snapshot.

Security groups

Operation Description
CreateSecurityGroup Creates a security group. For a newly created security group, only ECS 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 accept requests from the Internet or requests from instances of 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 the inbound traffic from other devices to ECS instances in the security group.
AuthorizeSecurityGroupEgress Creates an outbound security group rule. This operation allows or denies the outbound traffic from the instances in the security group to other devices.
RevokeSecurityGroup Deletes an inbound security group rule and revokes inbound permissions specified by this rule.
RevokeSecurityGroupEgress Deletes an outbound security group rule and revokes outbound permissions specified by this rule.
JoinSecurityGroup Adds an ECS instance to a specific security group.
LeaveSecurityGroup Removes an ECS instance from a specific security group.
DeleteSecurityGroup Deletes a security group.
DescribeSecurityGroupAttribute Queries the rules of a security group.
DescribeSecurityGroups Queries the basic information of your security groups, such as security group IDs and descriptions. The security groups are displayed in descending order by security group ID.
DescribeSecurityGroupReferences Queries whether a specific security group and other security groups grant access permissions to each other.
ModifySecurityGroupAttribute Modifies the attributes of a security group, including the name and description of the security group.
ModifySecurityGroupPolicy Modifies the access control policy of a security group.
ModifySecurityGroupRule Modifies the description of inbound rules of a security group. You can call the AuthorizeSecurityGroup operation to create a security group rule.
ModifySecurityGroupEgressRule Modifies the description of outbound rules of a security group. You can call the AuthorizeSecurityGroupEgress operation to add a outbound security group rule.

Deployment sets

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

SSH key pairs

Operation Description
CreateKeyPair Creates an SSH key pair. The system stores the public key and returns the unencrypted private key. The private key is encoded by using PEM and is in the PKCS#8 format. You must store the private key on your own and ensure its confidentiality.
ImportKeyPair Imports the public key of an RSA-encrypted key pair that you created using a third-party tool. After the key pair is imported, the public key is stored on Alibaba Cloud. You must store the private key on your own and make sure its confidentiality.
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. The entry of a deleted SSH key pair is removed from the database. However, the instances to which the SSH key pair is attached can still use the SSH key pair, and the key pair name is still displayed on the instance details page.
DescribeKeyPairs Queries one or more key pairs.

Networks

Operation Description
ModifyInstanceVpcAttribute Modifies the VPC attribute of an ECS instance.
AllocatePublicIpAddress Assigns a public IP address to an ECS instance.
ConvertNatPublicIpToEip Converts the public IP address of a VPC-type ECS instance to an Elastic IP address (EIP).
AttachClassicLinkVpc Connects a classic network-type instance with a VPC. This way, the instance can communicate with cloud resources in the VPC through the internal network.
DetachClassicLinkVpc Cancels the connection between a classic network-type instance and a VPC (ClassicLink). After the ClassicLink is canceled, the classic network-type instance cannot communicate with the VPC.
DescribeBandwidthLimitation Queries available bandwidth resources.
DescribeClassicLinkInstances Queries one or more classic network-type instances that are connected with VPCs.
ModifyInstanceNetworkSpec Modifies the bandwidth configurations of an instance. You can modify the network specifications of an instance to improve network performance if necessary.

Elastic network interfaces

Operation Description
CreateNetworkInterface Creates an elastic network interface (ENI).
AttachNetworkInterface Attaches an ENI to a VPC-type ECS instance.
DetachNetworkInterface Detaches an ENI from an ECS instance.
DeleteNetworkInterface Deletes an ENI.
DescribeNetworkInterfaces Queries available ENIs.
ModifyNetworkInterfaceAttribute Modifies the attributes of an ENI, such as the name, description, and security group of the ENI.
AssignPrivateIpAddresses Assigns one or more secondary private IP addresses to an ENI. You can specify private IP addresses within the CIDR block of the VSwitch that hosts the ENI. Alternatively, you can specify the number of private IP addresses for ECS to assign them automatically.
UnassignPrivateIpAddresses Deletes one or more secondary private IP addresses from an ENI.

System events

Operation Description
DescribeDisksFullStatus Queries the full status information of one or more block storage devices.
DescribeInstancesFullStatus Queries the full status information of one or more ECS instances. The full status information includes the instance status and the status of instance system events. The instance status is the lifecycle status of an instance. The status of instance system events is the health status of maintenance events.
DescribeInstanceHistoryEvents Queries the system events of a specific instance. Inactive historical system events are queried by default.
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 is in the Canceled state.
CreateSimulatedSystemEvents Schedules simulated system events for one or more ECS instances. The simulated system events do not occur in the actual system and the simulation does not affect ECS instances.

O&M and monitoring

Operation Description
DescribeDiskMonitorData Queries the usage information of a disk over the specified period.
DescribeInstanceMonitorData Queries all the monitoring information of an ECS 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 screenshot information of the ECS instance.
GetInstanceConsoleOutput Obtains the command line output of an ECS instance. The returned command output is encoded in Base64.
DescribeEniMonitorData Queries the traffic consumed by a secondary network interface over the specified period.
RedeployInstance Redeploys an ECS instance when the instance receives an event notification.
DescribeSnapshotMonitorData Queries the monitoring data on snapshot capacity changes in a region over the past 30 days.
DescribeInstanceMaintenanceAttributes Queries the maintenance attributes of an instance.
ModifyInstanceMaintenanceAttributes Modifies the maintenance attributes of an instance.

Cloud Assistant

Operation Description
CreateCommand Creates a Cloud Assistant command.
InvokeCommand Triggers a Cloud Assistant command for one or more ECS instances.
StopInvocation Stops the invocation process of a running Cloud Assistant command on one or more ECS instances.
DeleteCommand Deletes a Cloud Assistant command.
DescribeCommands Queries Cloud Assistant commands that you have created. If you only specify the Action and RegionId parameters, the system queries all available commands by default.
DescribeInvocations Queries the invocation list and status of Cloud Assistant commands in the last two weeks.
DescribeInvocationResults Queries the invocation results of Cloud Assistant commands on ECS instances.
DescribeCloudAssistantStatus Queries whether the Cloud Assistant client has been installed on one or more ECS instances.
InstallCloudAssistant Installs the Cloud Assistant client on one or more ECS instances.
RunCommand Creates a Cloud Assistant script of the shell, PowerShell, or Batch type, and then run the script on one or more ECS instances.

High-performance computing (HPC) clusters

Operation Description
DeleteHpcCluster Deletes an HPC cluster.
CreateHpcCluster Creates an HPC cluster.
DescribeHpcClusters Queries the available HPC clusters. Specified request parameters are used as filters with logical AND (&&) relations. The request parameters are not dependent on each other.
ModifyHpcClusterAttribute Modifies the description of an HPC cluster.

Tags

Operation Description
TagResources Creates and binds tags to specified ECS resources.
ListTagResources Queries the tags that have been bound to one or more ECS resources.
UntagResources Unbinds tags from the specified ECS resources.

Regions

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

Other operations

Operation Description
CancelTask Cancels a running task. You can cancel the running tasks generated by calling the ImportImage and ExportImage operations.
DescribeTasks Queries the progress of one or more asynchronous requests.
DescribeTaskAttribute Queries the details of an asynchronous task. You can query the asynchronous tasks generated by calling the ImportImage and ExportImage operations.
DescribeAccountAttributes Queries the quotas of ECS resources that you can create in a region. You can query the maximum numbers of security groups, ENIs, pay-as-you-go instance vCPUs, preemptible instance vCPUs, and dedicated hosts that you can create in a region. You can also obtain the information such as network types available in the region and whether an account has passed real-name verification.
JoinResourceGroup Adds an ECS resource or service to a resource group.
DescribePrice (Under internal preview). Queries the most recent prices of ECS resources.
DescribeDemands Queries the delivery and usage status of filed resources.