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

Instances

Operation Description
RunInstances Creates one or more Pay-As-You-Go or subscription ECS instances.
CreateInstance Creates an ECS instance.
DescribeInstances Queries the details of one or more ECS instances.
StartInstance Starts an ECS instance.
RebootInstance Restarts an ECS instance.
StopInstance Stops an ECS instance.
DeleteInstance Releases a Pay-As-You-Go instance or a subscription ECS instance that expires.
AttachInstanceRamRole Attaches a RAM role to one or more ECS instances. You can only attach one RAM role to an ECS instance at any time. If the instance already has a RAM role, an error code is returned because another RAM role cannot be attached to the same instance.
DetachInstanceRamRole Detaches a RAM role from one or more ECS instances.
DescribeInstanceStatus Obtains the states of multiple ECS instances.
RenewInstance Renews a subscription ECS instance.
ReactivateInstances Restarts a Pay-As-You-Go ECS instance that is suspended because of overdue payments or has expired.
RedeployInstance Redeploys an ECS instance when the instance receives an event notification.
DescribeInstanceVncUrl Queries the Web management terminal 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 the last 30 days for a preemptible instance.
DescribeInstanceTypeFamilies Queries the instance type families provided by ECS.
DescribeInstanceTypes Queries the instance type list provided by ECS.
ModifyInstanceVpcAttribute Modifies the VPC attributes of an ECS instance.
ModifyInstanceAttribute Modifies the information of an ECS instance, such as the password, name, description, hostname, and user data. For a burstable performance instance (t5), you can also change its running mode.
ModifyInstanceVncPasswd Modifies the Web management terminal password of an ECS instance.
ModifyInstanceAutoReleaseTime Sets or cancels the automatic release time for a Pay-As-You-Go ECS instance. Use caution when you set the automatic release time, because the instance is automatically released upon expiration.
ModifyInstanceAutoRenewAttribute Sets one or more subscription ECS instances to the auto renewal status. To reduce the maintenance workload when an instance expires, you can set auto renewal for subscription ECS instances.
ModifyInstanceChargeType Modifies the billing method for one or more ECS instances. You can change the billing method between Pay-As-You-Go and subscription, or change all Pay-As-You-Go data disks attached to an instance to subscription disks.
ModifyInstanceSpec Modifies the instance type or public bandwidth of a Pay-As-You-Go ECS instance.
ModifyPrepayInstanceSpec Modifies the type of your subscription ECS instance. The new instance type takes effect for the entire lifecycle of the instance.

Launch templates

Operation Description
CreateLaunchTemplate Creates an ECS instance launch template (launch template for short). An instance launch template removes the need to configure a large number of parameters every time you create an instance.
CreateLaunchTemplateVersion Creates a new version for a specified ECS instance launch template.
DeleteLaunchTemplate Deletes an ECS instance launch template.
DeleteLaunchTemplateVersion Deletes an ECS instance launch template version. This operation does not delete the default version of an ECS instance launch template. To delete the default version, you must call the DeleteLaunchTemplate operation.
DescribeLaunchTemplates Queries one or more ECS instance launch templates.
DescribeLaunchTemplateVersions Queries one or more ECS instance launch template versions.
ModifyLaunchTemplateDefaultVersion Modifies the default version of an ECS instance launch template. If you do not specify a template version number when creating an ECS instance (RunInstances), the default version is 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.
DescribeAutoProvisioningGroups Queries auto provisioning groups.
DescribeAutoProvisioningGroupInstances Queries ECS instances in an auto provisioning group.
DescribeAutoProvisioningGroupHistory Queries the scheduling tasks of an auto provisioning group.

Disks

Operation Description
CreateDisk Creates a Pay-As-You-Go or subscription data disk. You can create a basic disk, an ultra disk, an SSD disk, or an ESSD disk.
DeleteDisk Releases a Pay-As-You-Go data disk. You can release a basic disk, an ultra disk, or an SSD disk.
DescribeDisks Queries the disks that you have created.
AttachDisk Attaches a data disk to an ECS instance.
DetachDisk Detaches a Pay-As-You-Go disk from an ECS instance. You can detach a basic disk, an ultra disk, or an SSD disk.
ModifyDiskChargeType Modifies the billing method for up to 16 disks that are attached to an ECS instance.
ModifyDiskAttribute Modifies the attributes of a disk.
ReplaceSystemDisk Replaces the system disk or the operating system of an ECS instance.
ReInitDisk Resets a disk to its initial state.
ResetDisk Rolls back a disk to a specified disk state by using one of its historic disk snapshots.
ResizeDisk Resizes a cloud disk. You can resize both system disks and data disks.
ModifyDiskSpec Upgrades the performance level of an ESSD disk.

Reserved instances

Operation Description
PurchaseReservedInstancesOffering Purchases reserved instances to pay for the CPU and memory usage fees of Pay-As-You-Go ECS instances.
DescribeReservedInstances Queries the reserved instances that you have purchased.
ModifyReservedInstances Modifies reserved instances.

Images

Operation Description
ExportImage Exports a custom image to an OSS bucket in the same region as the custom image.
CreateImage Creates a custom image. You can use the created image to create ECS instances (RunInstances) and replace system disks (ReplaceSystemDisk).
ImportImage Imports your locally saved image files to Alibaba Cloud ECS. Such images appears in the corresponding regions as custom images.
CopyImage Copies a custom image from one region to another. You can use the copied image to create ECS instances (RunInstances) and replace system disks (ReplaceSystemDisk) in another region.
CancelCopyImage Cancels an ongoing CopyImage operation.
DescribeImages Queries available image resources.
DeleteImage Deletes a specified custom image.
DescribeImageSharePermission Queries the accounts to which a custom image is shared. The response can be displayed over several pages. Ten entries are displayed on each page by default.
ModifyImageAttribute Modifies the name and description of a custom image.
ModifyImageSharePermission Manages which accounts a custom image is shared to. After you share a custom image to other Alibaba Cloud accounts, these accounts can use the shared image to create ECS instances (RunInstances) and replace system disks (ReplaceSystemDisk).
DescribeImageSupportInstanceTypes Queries the instance types supported by the specified image.

Snapshots

Operation Description
CreateSnapshot Creates a snapshot for a specified disk.
CreateAutoSnapshotPolicy Creates an automatic snapshot policy. After you create an automatic snapshot policy, you can call the ApplyAutoSnapshotPolicy operation to apply it to any disks. You can call the ModifyAutoSnapshotPolicyEx operation to modify an existing automatic snapshot policy as required.
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 takes effect on the disk and replace the original policy.
DeleteSnapshot Deletes a snapshot. Snapshots that are currently being created can also be deleted by calling this operation.
CancelAutoSnapshotPolicy Cancels the automatic snapshot policies of 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 that it previously took effect on.
DescribeAutoSnapshotPolicyEX Queries the automatic snapshot policies that you have created.
DescribeSnapshots Queries all the snapshots of an ECS instance or a disk. Request parameters such as InstanceId, DiskId, and SnapshotIds act as filtering conditions and are in a logical AND relationship.
DescribeSnapshotLinks Queries the snapshot links of one or more disks. A snapshot chain is a chain of all the snapshots of a disk and a disk corresponds to a chain of snapshots. 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 the policy applied.
DescribeSnapshotsUsage Queries the number of snapshots stored in a region and the total size of the snapshots. If you want to view the snapshot usage information on each disk in the current region, we recommend that you call the DescribeSnapshotLinks operation to query the snapshot chain information.
DescribeSnapshotPackage Queries the storage plans that you have purchased within an Alibaba Cloud region. These storage plans can be used to store snapshots.

Security groups

Operation Description
ModifySecurityGroupEgressRule Modifies the outbound rules of a security group. You can call the AuthorizeSecurityGroup operation to add a security group rule.
CreateSecurityGroup Creates a security group. Only instances within the security group are granted access permissions by default. If you want to allow requests from the Internet or requests from instances in other security groups, you can call the AuthorizeSecurityGroup operation to grant access permissions to these instances or groups.
AuthorizeSecurityGroup Adds an inbound rule for a security group. This operation allows or blocks the inbound traffic from other devices to ECS instances in the security group.
AuthorizeSecurityGroupEgress Adds an outbound rule for a security group. This operation allows or blocks the outbound traffic from the ECS instances in the security group to other devices.
RevokeSecurityGroup Deletes an inbound rule from a security group.
RevokeSecurityGroupEgress Deletes an outbound rule from a security group.
JoinSecurityGroup Adds an ECS instance to a specified security group.
LeaveSecurityGroup Removes an ECS instance from a specified security group.
DeleteSecurityGroup Deletes a security group. Before deleting a security group, make sure that no ECS instance exists in the security group and that the security group is not referenced by other security groups. Otherwise, the DeleteSecurityGroup request fails.
DescribeSecurityGroupAttribute Queries the details of a security group.
DescribeSecurityGroups Queries the basic information of your security groups, such as security group IDs and descriptions. Security groups are displayed in descending order of their IDs.
DescribeSecurityGroupReferences Queries whether a specified security group has been authorized by other security groups.
ModifySecurityGroupAttribute Modifies the attributes of a security group, including its name and description.
ModifySecurityGroupPolicy Modifies the access control policy of a security group.
ModifySecurityGroupRule Modifies the inbound rules of a security group. You can call the AuthorizeSecurityGroup operation to add a security group rule.

Deployment sets

Operation Description
CreateDeploymentSet Creates a deployment set in the specified region.
ModifyInstanceDeployment Migrates an ECS instance to a DDH in the same region.
ModifyDeploymentSetAttribute Modifies the name and description of a deployment set.
DeleteDeploymentSet Deletes 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 guarantee its confidentiality.
ImportKeyPair Imports the public key of an RSA-encrypted key pair that was created by other key pair generators. After the public key is imported, you must store the private key on your own and its guarantee 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.
DescribeKeyPairs Queries one or more SSH key pairs.

Network configurations

Operation Description
AllocatePublicIpAddress Assigns a public IP address to an ECS instance.
ConvertNatPublicIpToEip Converts the public IP address of a VPC-type ECS instance to an EIP.
AttachClassicLinkVpc Establishes a ClassicLink between a classic network-type instance and a VPC to allow the instance to communicate with resources in the VPC over the internal network. For more information, see ClassicLink overview in VPC User Guide.
DetachClassicLinkVpc Removes the ClassicLink between a classic network-type instance and a VPC. For more information, see ClassicLink overview in VPC User Guide. After the ClassicLink is removed, 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 have established ClassicLink with VPCs.
ModifyInstanceNetworkSpec Modifies the bandwidth configurations of an ECS instance. When the network specifications of an ECS instance cannot meet your needs, you can modify its bandwidth configurations to improve network performance.

ENIs

Operation Description
CreateNetworkInterface Creates an ENI.
AttachNetworkInterface Attaches an ENI to a VPC-type instance.
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, or the number of private IP addresses for ECS to assign them automatically.
UnassignPrivateIpAddresses Deletes one or more secondary private IP addresses from an ENI.
DetachNetworkInterface Detaches an ENI from an ECS instance.
DeleteNetworkInterface Deletes an ENI.
DescribeNetworkInterfaces Queries available ENIs.
ModifyNetworkInterfaceAttribute Modifies the attributes of an ENI. You can modify the name, description, and security group of the ENI.

System events

Operation Description
DescribeInstancesFullStatus Queries the full status information of one or more ECS instances. The full status information is made up of the instance status and the instance event status. The instance status is the lifecycle status of the instance. The instance event status is the health status of the maintenance event. For more information, see ECS instance lifecycle and System events.
DescribeInstanceHistoryEvents Queries the system events of the specified ECS instance. You can query system events within the last week. You can specify the InstanceEventCycleStatus parameter to query system events that are in the Scheduled or Executing state.
DescribeDisksFullStatus Queries the full status information of one or more disks.
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
DescribeEniMonitorData Queries traffic information of a secondary ENI over a specific period.
DescribeDiskMonitorData Queries the usage information of a specified disk over a specific period. You can query the read IOPS, write IOPS, read bandwidth (Byte/s), write bandwidth (Byte/s), read latency (ms), and write latency (ms) of the disk. A portion of the information may be missing. This is because the system cannot obtain the relevant information, such as when the disk is not in the In Use state.
DescribeInstanceMonitorData Queries all the monitoring data of an ECS instance. You can query the CPU usage, inbound data traffic, outbound data traffic, network traffic, and average bandwidth of the ECS instance. A portion of the information may be missing. This is because the system cannot obtain the relevant information, such as when the instance is in the Stopped state.
GetInstanceScreenshot Obtains the screenshot information of an ECS instance.
GetInstanceConsoleOutput Obtains the command line output of an ECS instance. The returned output is encoded in Base64.

Cloud assistant

Operation Description
CreateCommand Creates a cloud assistant command.
InstallCloudAssistant Installs the cloud assistant client on one or more ECS instances.
InvokeCommand Triggers a cloud assistant command on one or more ECS instances.
StopInvocation Stops the process of a running cloud assistant command on one or more ECS instances.
DeleteCommand Deletes a cloud assistant command.
DescribeCloudAssistantStatus Checks whether the cloud assistant client is installed on one or more instances.
DescribeCommands Queries the cloud assistant commands that you have created. If you only specify the Action and RegionId parameters, all available commands are displayed.
DescribeInvocations Queries the invocation information and status of cloud assistant commands.
DescribeInvocationResults Queries the invocation result of a cloud assistant command, or the actual output on a specified ECS instance.

Tags

Operation Description
TagResources Creates and attaches tags to the specified ECS resources.
ListTagResources Queries tags that are attached to one or more ECS resources.
UntagResources Detaches and deletes tags from the specified ECS resources.

Regions

Operation Description
DescribeRegions Queries the Alibaba Cloud regions available to you.
DescribeZones Queries zones available in a specified region.
DescribeResourcesModification Queries resources available in a certain zone upon upgrading or downgrading an ECS instance type or system disk.
DescribeAvailableResource Queries resources available in a certain zone. For example, you can view resources available in a certain zone before creating an ECS instance (RunInstances) or modify the instance type (ModifyInstanceSpec).

Other operations

Operation Description
CancelTask Cancels an ongoing task. You can cancel the following asynchronous tasks: importing images (ImportImage) and exporting images (ExportImage).
DescribeTasks Queries the progress of one or more asynchronous tasks.
DescribeTaskAttribute Queries the details of a specified asynchronous task. You can query the following asynchronous tasks: importing images (ImportImage) and exporting images (ExportImage).
DescribeAccountAttributes Queries the maximum number of ECS resources that you can create in a region. Specifically, you can query the maximum number of security groups, ENIs, Pay-As-You-Go instance vCPUs, preemptible instance vCPUs, and Dedicated Hosts (DDHs), local network type, and whether your account has been authenticated with real-name credentials.