All Products
Search
Document Center

Elastic Compute Service:List of operations by function

Last Updated:Apr 17, 2024
This product(Ecs/2014-05-26) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Instances

APITitleDescription
RunInstancesRunInstancesCreates pay-as-you-go or subscription Elastic Compute Service (ECS) instances.
CreateInstanceCreateInstanceCreates a subscription or pay-as-you-go Elastic Compute Service (ECS) instance.
StartInstanceStartInstanceStarts an Elastic Compute Service (ECS) instance. After the operation is called, the instance enters the Starting state.
StartInstancesStartInstancesStarts Elastic Compute Service (ECS) instances that are in the Stopped state.
StopInstanceStopInstanceStops an Elastic Compute Service (ECS) instance in the Running state. After the operation is called, the state of the instance changes to Stopping and then to Stopped.
StopInstancesStopInstancesStops Elastic Compute Service (ECS) instances. After the operation is called, the state of the instances changes to Stopping and then to Stopped.
RebootInstanceRebootInstanceRestarts an Elastic Compute Service (ECS) instance that is in the Running state.
RebootInstancesRebootInstancesRestarts Elastic Compute Service (ECS) instances. After this API operation is called, the ECS instances enter the Stopping state and then the Running state.
AttachInstanceRamRoleAttachInstanceRamRoleAttaches an instance Resource Access Management (RAM) role to one or more Elastic Compute Service (ECS) instances. An instance can have only a single 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.
DescribeInstanceRamRoleDescribeInstanceRamRoleQueries the instance RAM roles that are attached to Elastic Compute Service (ECS) instances.
DetachInstanceRamRoleDetachInstanceRamRoleDetaches an instance RAM role from one or more ECS instances.
DescribeInstanceStatusDescribeInstanceStatusQueries the status information of multiple Elastic Compute Service (ECS) instances.
DescribeInstancesDescribeInstancesQueries the details of one or more Elastic Compute Service (ECS) instances.
DescribeInstanceVncUrlDescribeInstanceVncUrlQueries the Virtual Network Computing (VNC) logon address of an Elastic Compute Service (ECS) instance.
ModifyInstanceVncPasswdModifyInstanceVncPasswdModifies the Virtual Network Computing (VNC) password of an Elastic Compute Service (ECS) instance.
DescribeUserDataDescribeUserDataQueries the user data of an Elastic Compute Service (ECS) instance.
DescribeInstanceAutoRenewAttributeDescribeInstanceAutoRenewAttributeQueries the auto-renewal status of subscription Elastic Compute Service (ECS) instances.
ModifyInstanceAutoRenewAttributeModifyInstanceAutoRenewAttributeConfigures auto-renewal for one or more subscription instances. To reduce maintenance workloads after subscription instances expire, you can configure auto-renewal for the instances.
RenewInstanceRenewInstanceRenews a subscription Elastic Compute Service (ECS) instance.
DescribeSpotPriceHistoryDescribeSpotPriceHistoryQueries the price history of a preemptible instance within the previous 30 days.
DescribeSpotAdviceDescribeSpotAdviceQueries information such as the average release rate of preemptible instances and the percentage of the average preemptible instance price relative to the pay-as-you-go instance price in the last 30 days, and real-time discounts of preemptible instances in a specified region.
DescribeInstanceTypeFamiliesDescribeInstanceTypeFamiliesYou can call this operation to query the instance families provided by ECS.
DescribeInstanceTypesDescribeInstanceTypesQueries the details of all instance types or a specific instance type provided by Elastic Compute Service (ECS).
DescribeInstanceAttributeDescribeInstanceAttributeQueries the details of an instance by instance ID.
ModifyInstanceAttributeModifyInstanceAttributeModifies attributes of an Elastic Compute Service (ECS) instance, such as the password, name, description, hostname, security groups, and user data. If the instance is a burstable instance, you can also change its performance mode.
ModifyInstanceMetadataOptionsModifyInstanceMetadataOptionsModifies the metadata of an Elastic Compute Service (ECS) instance.
ModifyInstanceAutoReleaseTimeModifyInstanceAutoReleaseTimeSets or cancels automatic release time for a pay-as-you-go Elastic Compute Service (ECS) instance. If you set the automatic release time for an instance, the instance is automatically released at the specified time. Proceed with caution when you perform this operation.
ModifyInstanceChargeTypeModifyInstanceChargeTypeChanges the billing methods of instances between pay-as-you-go and subscription, or changes the billing method of all data disks that are attached to an instance from pay-as-you-go to subscription.
ModifyInstanceSpecModifyInstanceSpecChanges the instance type and public bandwidth of a pay-as-you-go Elastic Compute Service (ECS) instance.
ModifyPrepayInstanceSpecModifyPrepayInstanceSpecUpgrades or downgrades the instance type of a subscription Elastic Compute Service (ECS) instance. The new instance type takes effect for the remaining lifecycle of the instance.
ReActivateInstancesReActivateInstancesReactivates a pay-as-you-go Elastic Compute Service (ECS) instance that has expired or has been recycled due to overdue payments.
DeleteInstanceDeleteInstanceReleases a pay-as-you-go Elastic Compute Service (ECS) instance or an expired subscription ECS instance.
DeleteInstancesDeleteInstancesReleases pay-as-you-go instances or expired subscription instances.

Dedicated hosts

APITitleDescription
AllocateDedicatedHostsAllocateDedicatedHostsCreates pay-as-you-go or subscription dedicated hosts. A dedicated host is a physical server dedicated to a single tenant. You can create Elastic Compute Service (ECS) instances on a dedicated host and view the attributes of a dedicated host.
DescribeDedicatedHostsDescribeDedicatedHostsQueries the information about dedicated hosts, including the physical performance specifications, machine codes, and service states of the dedicated hosts, and Elastic Compute Service (ECS) instances that are created on the dedicated hosts.
DescribeDedicatedHostTypesDescribeDedicatedHostTypesYou can call this operation to query the details about dedicated host types supported in a region, or the ECS instance families supported by a specific dedicated host type.
ModifyDedicatedHostClusterAttributeModifyDedicatedHostClusterAttributeModifies the attributes of a dedicated host cluster, such as its name and description.
ModifyDedicatedHostAttributeModifyDedicatedHostAttributeModifies some properties of a dedicated host, such as the name, description, and instance migration policy that is applied when the dedicated host fails.
ModifyDedicatedHostsChargeTypeModifyDedicatedHostsChargeTypeChanges the billing method of dedicated hosts.
DescribeDedicatedHostAutoRenewDescribeDedicatedHostAutoRenewQueries the auto-renewal states of one or more subscription dedicated hosts.
ModifyDedicatedHostAutoRenewAttributeModifyDedicatedHostAutoRenewAttributeEnables or disables auto-renewal for subscription dedicated hosts.
RenewDedicatedHostsRenewDedicatedHostsRenews one or more subscription dedicated hosts.
ModifyDedicatedHostAutoReleaseTimeModifyDedicatedHostAutoReleaseTimeSets or cancels automatic release time for a pay-as-you-go dedicated host.
ModifyInstanceDeploymentModifyInstanceDeploymentChanges the deployment set of an Elastic Compute Service (ECS) instance or migrates an ECS instance to a dedicated host. You can change the instance type of an instance when you migrate the instance.
RedeployDedicatedHostRedeployDedicatedHostMigrates Elastic Compute Service (ECS) instances away from a failed dedicated host.
ReleaseDedicatedHostReleaseDedicatedHostReleases a pay-as-you-go dedicated host.
CreateDedicatedHostClusterCreateDedicatedHostClusterYou can call this operation to create a dedicated host cluster.
DescribeDedicatedHostClustersDescribeDedicatedHostClustersQueries the details of one or more dedicated host clusters.
DeleteDedicatedHostClusterDeleteDedicatedHostClusterDeletes a dedicated host cluster.

Launch templates

APITitleDescription
CreateLaunchTemplateCreateLaunchTemplateCreates a launch template. A launch template eliminates the need to configure a large number of parameters every time you create an Elastic Compute Service (ECS) instance.
DescribeLaunchTemplatesDescribeLaunchTemplatesQueries available launch templates.
DeleteLaunchTemplateDeleteLaunchTemplateDeletes a launch template.
CreateLaunchTemplateVersionCreateLaunchTemplateVersionCreates a version for a launch template.
DescribeLaunchTemplateVersionsDescribeLaunchTemplateVersionsQueries the versions of a launch template.
ModifyLaunchTemplateDefaultVersionModifyLaunchTemplateDefaultVersionChanges the default version of a launch template. If you do not specify a version number for a launch template when you create instances by calling the RunInstances operation, the default version of the launch template is used.
DeleteLaunchTemplateVersionDeleteLaunchTemplateVersionDeletes the versions of a launch template. You cannot call this operation to delete the default version of a launch template. To delete the default version, you must call the DeleteLaunchTemplate operation to delete the launch template and all versions of the launch template.

Resource diagnostic

APITitleDescription
CreateDiagnosticReportCreateDiagnosticReportCreates a diagnostic report for a resource.
DescribeDiagnosticReportsDescribeDiagnosticReportsQueries diagnostic reports.
DescribeDiagnosticReportAttributesDescribeDiagnosticReportAttributesQueries the details of a diagnostic report.
DeleteDiagnosticReportsDeleteDiagnosticReportsDeletes diagnostic reports.
CreateDiagnosticMetricSetCreateDiagnosticMetricSetCreates a diagnostic metric set. You can group diagnostic metrics into diagnostic metric sets.
DescribeDiagnosticMetricSetsDescribeDiagnosticMetricSetsQueries diagnostic metric sets.
DescribeDiagnosticMetricsDescribeDiagnosticMetricsQueries diagnostic metrics.
ModifyDiagnosticMetricSetModifyDiagnosticMetricSetModifies a diagnostic metric set.
DeleteDiagnosticMetricSetsDeleteDiagnosticMetricSetsDelete diagnostic metric sets.

Elasticity assurances

APITitleDescription
CreateElasticityAssuranceCreateElasticityAssuranceCreates an elasticity assurance.
DescribeElasticityAssurancesDescribeElasticityAssurancesQueries the details of elasticity assurances.
DescribeElasticityAssuranceInstancesDescribeElasticityAssuranceInstancesQueries the running Elastic Compute Service (ECS) instances that match and use the elasticity assurance service.
CreateCapacityReservationCreateCapacityReservationCreates a capacity reservation.
DescribeCapacityReservationsDescribeCapacityReservationsQueries the details of capacity reservations.
DescribeCapacityReservationInstancesDescribeCapacityReservationInstancesQueries the instances that match a capacity reservation.
ModifyCapacityReservationModifyCapacityReservationModifies the information about a capacity reservation, including the name, description, release mode, and the total number of Elastic Compute Service (ECS) instances for which capacity is reserved.
DescribeInstanceAttachmentAttributesDescribeInstanceAttachmentAttributesQueries the information about the private pools that Elastic Compute Service (ECS) instances match.
ModifyInstanceAttachmentAttributesModifyInstanceAttachmentAttributesModifies the attributes of the private pool of an instance.
ReleaseCapacityReservationReleaseCapacityReservationReleases a capacity reservation.

Auto provisioning groups

APITitleDescription
CreateAutoProvisioningGroupCreateAutoProvisioningGroupCreates an auto provisioning group.
DescribeAutoProvisioningGroupsDescribeAutoProvisioningGroupsQueries information of auto provisioning groups.
DescribeAutoProvisioningGroupInstancesDescribeAutoProvisioningGroupInstancesYou can call this operation to query instances in an auto provisioning group.
ModifyAutoProvisioningGroupModifyAutoProvisioningGroupModifies the configurations of an auto-provisioning group.
DescribeAutoProvisioningGroupHistoryDescribeAutoProvisioningGroupHistoryQueries the scheduling tasks of an auto provisioning group.
DeleteAutoProvisioningGroupDeleteAutoProvisioningGroupDeletes an auto provisioning group.

Elastic Block Storage (EBS) devices

APITitleDescription
CreateDiskCreateDiskCreates a pay-as-you-go or subscription data disk.
DescribeDisksDescribeDisksQueries one or more block storage devices that you created, including cloud disks and local disks.
AttachDiskAttachDiskAttaches a pay-as-you-go data disk or a system disk to an Elastic Compute Service (ECS) instance. The instance and the disk must reside in the same zone.
DetachDiskDetachDiskDetaches a pay-as-you-go data disk or a system disk from an Elastic Compute Service (ECS) instance.
ModifyDiskAttributeModifyDiskAttributeModifies the attributes of one or more block storage devices (disks). The attributes include names, descriptions, and whether the attributes are released together with the associated instances.
ReplaceSystemDiskReplaceSystemDiskReplaces the system disk or the operating system of an Elastic Compute Service (ECS) instance. After the system disk is replaced, the ID of the system disk changes and the original disk is released.
ReInitDiskReInitDiskRe-initializes a disk to the state that it was in when it was created.
ResizeDiskResizeDiskResizes a system disk or data disk.
ResetDiskResetDiskRolls back a disk to a specific point in time based on a snapshot of the disk.
ModifyDiskChargeTypeModifyDiskChargeTypeChanges the billing method of disks that are attached to an Elastic Compute Service (ECS) instance. The billing method of up to 16 disks that are attached to the instance can be changed by calling this operation.
ModifyDiskSpecModifyDiskSpecYou can call this operation to change the category of a disk or modify the performance level of an enhanced SSD (ESSD).
DeleteDiskDeleteDiskReleases 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 (ESSD).

Reserved instances

APITitleDescription
PurchaseReservedInstancesOfferingPurchaseReservedInstancesOfferingPurchases a reserved instance. Reserved instances can be automatically matched to pay-as-you-go instances to offset the fees of the pay-as-you-go instances.
DescribeReservedInstancesDescribeReservedInstancesQueries purchased reserved instances.
ModifyReservedInstancesModifyReservedInstancesSplits, merges, or modifies reserved instances. You call this operation to modify the names and zones of reserved instances or change their instance types within the same instance family.
ModifyReservedInstanceAttributeModifyReservedInstanceAttributeModifies the attributes of a reserved instance, such as its name and description.
RenewReservedInstancesRenewReservedInstancesRenews existing reserved instances.
DescribeReservedInstanceAutoRenewAttributeDescribeReservedInstanceAutoRenewAttributeQueries the auto-renewal status of one or more subscription reserved instances.
ModifyReservedInstanceAutoRenewAttributeModifyReservedInstanceAutoRenewAttributeEnables or disables auto-renewal for one or more reserved instances.

Storage capacity units (SCUs)

APITitleDescription
PurchaseStorageCapacityUnitPurchaseStorageCapacityUnitPurchases one or more storage capacity units (SCUs).
DescribeStorageCapacityUnitsDescribeStorageCapacityUnitsQueries the details of one or more SCUs.
ModifyStorageCapacityUnitAttributeModifyStorageCapacityUnitAttributeChanges the name or modifies the description of a storage capacity unit (SCU).

Images

APITitleDescription
CreateImageCreateImageCreates a custom image. After you call this operation to create a custom image, you can call the RunInstances operation to create Elastic Compute Service (ECS) instances from the created custom image or call the ReplaceSystemDisk operation to replace system disks by using the custom image.
ImportImageImportImageImports an on-premise image to Elastic Compute Service (ECS). The imported image exists as a custom image in the destination region. You can use the imported image to create ECS instances by calling the RunInstances operation or replace the system disks of ECS instances by calling the ReplaceSystemDisk operation.
ExportImageExportImageExports a custom image to an Object Storage Service (OSS) bucket in the same region.
CopyImageCopyImageCopies a custom image from one region to another. You can deploy or copy Elastic Compute Service (ECS) instances across regions by copying custom images.
CancelCopyImageCancelCopyImageCancels an ongoing image copy task.
DescribeImagesDescribeImagesQueries available images.
ModifyImageAttributeModifyImageAttributeModifies the name, description, status, or image family of a custom image.
ModifyImageSharePermissionModifyImageSharePermissionManages the share permissions on a custom image. You can share your custom images to other Alibaba Cloud accounts or publish the images as community images.
DescribeImageSupportInstanceTypesDescribeImageSupportInstanceTypesQueries the instance types supported by an image.
DescribeImageFromFamilyDescribeImageFromFamilyYou can call this operation to query available custom images that are newly created in a specific image family.
DeleteImageDeleteImageDeletes a custom image.

Image components

APITitleDescription
CreateImageComponentCreateImageComponentCreates an image component. Image components are used to store the image template commands that are commonly used to create images.
CreateImagePipelineCreateImagePipelineCreates an image template. Image templates can be used to create images.
DescribeImageComponentsDescribeImageComponentsQueries the details of one or more image components.
DescribeImagePipelinesDescribeImagePipelinesQueries the details of one or more image templates.
StartImagePipelineExecutionStartImagePipelineExecutionExecutes a pipeline task by using an image template.
DescribeImagePipelineExecutionsDescribeImagePipelineExecutionsQueries the details of an image creation task.
CancelImagePipelineExecutionCancelImagePipelineExecutionYou can call this operation to cancel an image build task.
DeleteImageComponentDeleteImageComponentDeletes an image component.
DeleteImagePipelineDeleteImagePipelineDeletes an image template.

Snapshots

APITitleDescription
CreateSnapshotCreateSnapshotThe retention period of the snapshot. Valid values: 1 to 65536. Unit: days. The snapshot is automatically released when its retention period expires. This parameter is empty by default, which indicates that the snapshot is not automatically released.
CopySnapshotCopySnapshotCopies a normal snapshot from one region to another.
DescribeSnapshotsDescribeSnapshotsQueries all the snapshots of an Elastic Compute Service (ECS) instance or a disk.
DescribeSnapshotsUsageDescribeSnapshotsUsageQueries the number of snapshots that are stored in a region and the total size of the snapshots.
DescribeSnapshotPackageDescribeSnapshotPackageQueries purchased Object Storage Service (OSS) storage plans in a specified Alibaba Cloud region.
DescribeSnapshotLinksDescribeSnapshotLinksQueries the snapshot chains of disks. A snapshot chain is a chain of all the snapshots created for a disk. A disk corresponds to a chain of snapshots.
ModifySnapshotAttributeModifySnapshotAttributeModifies the name, description, or retention period of a snapshot.
DeleteSnapshotGroupDeleteSnapshotGroupDeletes a snapshot-consistent group.
DeleteSnapshotDeleteSnapshotDeletes a snapshot. If you call this operation to delete a snapshot that is being created, the snapshot creation task is canceled.
CreateAutoSnapshotPolicyCreateAutoSnapshotPolicyCreates an automatic snapshot policy in a specific region. Automatic snapshot policies allow Elastic Compute Service (ECS) to create snapshots for a disk on a regular basis to back up data. The policies can be applied to both system disks and data disks. If cross-region snapshot replication is enabled and no encryption parameters are configured, encrypted snapshots are copied to the destination region and snapshot copies are encrypted by using the default service customer master key (CMK) that was created by Key Management Service (KMS) in the destination region.
DescribeAutoSnapshotPolicyExDescribeAutoSnapshotPolicyExQueries existing automatic snapshot policies in a region.
ModifyAutoSnapshotPolicyExModifyAutoSnapshotPolicyExModifies an automatic snapshot policy. After an automatic snapshot policy is modified, the modifications immediately take effect on the disks that are associated with the policy. If cross-region replication for snapshots is enabled and no encryption parameters are configured, the generated encrypted snapshot copies are encrypted by using the Key Management Service (KMS) encryption keys in the region to which the snapshots are copied.
ApplyAutoSnapshotPolicyApplyAutoSnapshotPolicyApplies an automatic snapshot policy to one or more disks. You can call this operation to replace the automatic snapshot policy of a disk.
CancelAutoSnapshotPolicyCancelAutoSnapshotPolicyDisables automatic snapshot policies for one or more disks.
DeleteAutoSnapshotPolicyDeleteAutoSnapshotPolicyYou can call this operation to delete 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.
CreateSnapshotGroupCreateSnapshotGroupCreates a snapshot-consistent group for the cloud disks of an Elastic Compute Service (ECS) instance. A snapshot-consistent group contains snapshots of one or more cloud disks.
DescribeSnapshotGroupsDescribeSnapshotGroupsQueries the information of one or more snapshot-consistent groups.
ModifySnapshotGroupModifySnapshotGroupModifies the name and description of a snapshot-consistent group.

PrefixList

APITitleDescription
CreatePrefixListCreatePrefixListCreates a prefix list.
DescribePrefixListsDescribePrefixListsQueries the information of one or more prefix lists.
DescribePrefixListAssociationsDescribePrefixListAssociationsQueries the information of resources that are associated with a specific prefix list.
DescribePrefixListAttributesDescribePrefixListAttributesQueries the details of a prefix list, including the name, address family, maximum number of entries, and details of the entries.
ModifyPrefixListModifyPrefixListModifies the name, description, or entries of a specific prefix list.
DeletePrefixListDeletePrefixListDeletes a prefix list and all entries in the prefix list.

Security groups

APITitleDescription
CreateSecurityGroupCreateSecurityGroupCreates a security group. By default, a security group allows only instances in the security group to access each other. Access requests from outside the security group are denied. If you want to allow requests over the Internet or from instances in other security groups, you can call the AuthorizeSecurityGroup operation.
DescribeSecurityGroupsDescribeSecurityGroupsQueries the basic information about security groups.
DescribeSecurityGroupAttributeDescribeSecurityGroupAttributeQueries the rules of a security group.
ModifySecurityGroupPolicyModifySecurityGroupPolicyModifies the internal access control policy of a basic security group. The internal access control policies of advanced security groups cannot be modified.
ModifySecurityGroupAttributeModifySecurityGroupAttributeModifies the name or description of a security group.
ModifySecurityGroupRuleModifySecurityGroupRuleModifies an inbound rule in a security group.
ModifySecurityGroupEgressRuleModifySecurityGroupEgressRuleModifies the description of a security group rule. You can call this operation to modify only the description of a security group rule. If you want to modify other information, such as the policy, port range, and authorization object of the rule, log on to the Elastic Compute Service (ECS) console.
AuthorizeSecurityGroupAuthorizeSecurityGroupCreates inbound rules in a security group. You can use the created rules to allow or deny inbound traffic from other hosts to instances in the security group.
AuthorizeSecurityGroupEgressAuthorizeSecurityGroupEgressCreates outbound rules in a security group. You can use the created rules to allow or deny outbound traffic from instances in the security group to other objects.
JoinSecurityGroupJoinSecurityGroupAdds an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) to a security group.
LeaveSecurityGroupLeaveSecurityGroupRemoves an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) from a security group.
DescribeSecurityGroupReferencesDescribeSecurityGroupReferencesChecks whether a security group is referenced by the rules of other security groups.
RevokeSecurityGroupRevokeSecurityGroupDeletes one or more inbound security group rules.
RevokeSecurityGroupEgressRevokeSecurityGroupEgressDeletes outbound security group rules.
DeleteSecurityGroupDeleteSecurityGroupDeletes a security group.

Deployment sets

APITitleDescription
CreateDeploymentSetCreateDeploymentSetCreates a deployment set in a specific region.
DescribeDeploymentSetSupportedInstanceTypeFamilyDescribeDeploymentSetSupportedInstanceTypeFamilyQueries the instance families that support deployment sets.
DescribeDeploymentSetsDescribeDeploymentSetsQueries the attributes of one or more deployment sets.
ModifyDeploymentSetAttributeModifyDeploymentSetAttributeYou can call this operation to modify the name and description of a deployment set.
DeleteDeploymentSetDeleteDeploymentSetYou can call this operation to delete a deployment set.

SSH key pairs

APITitleDescription
CreateKeyPairCreateKeyPairCreates an SSH key pair. The system stores the public key and returns the unencrypted private key. The private key is encoded with PEM in the PKCS#8 format. You are responsible for storing the private key and ensuring its confidentiality.
ImportKeyPairImportKeyPairImports the public key of a Rivest-Shamir-Adleman (RSA)-encrypted key pair that is generated by a third-party tool. After the public key of the key pair is imported, Alibaba Cloud stores the public key. You are responsible for storing the private key. We recommend that you store it in a safe place.
DescribeKeyPairsDescribeKeyPairsQueries one or more key pairs.
AttachKeyPairAttachKeyPairBinds an SSH key pair to one or more Linux instances.
DetachKeyPairDetachKeyPairUnbinds an SSH key pair from one or more Linux instances.
DeleteKeyPairsDeleteKeyPairsDeletes one or more SSH key pairs.

Networks

APITitleDescription
ModifyInstanceVpcAttributeModifyInstanceVpcAttributeChanges the virtual private cloud (VPC), private IP address, or vSwitch of an Elastic Compute Service (ECS) instance that resides in a VPC.
AllocatePublicIpAddressAllocatePublicIpAddressAssigns a public IP address to an Elastic Compute Service (ECS) instance.
ConvertNatPublicIpToEipConvertNatPublicIpToEipConverts the public IP address of an Elastic Compute Service (ECS) instance located in a virtual private cloud (VPC) into an elastic IP address (EIP).
AttachClassicLinkVpcAttachClassicLinkVpcLinks an instance that is deployed in the classic network to a virtual private cloud (VPC) by establishing a ClassicLink connection between the instance and the VPC. This way, the instance can communicate with cloud resources in the VPC over the internal network.
DetachClassicLinkVpcDetachClassicLinkVpcYou can call this operation to unlink a classic network-type instance from a virtual private cloud (VPC) by removing the ClassicLink connection between them. After the instance is unlinked from the VPC, it can no longer communicate with instances in the VPC.
DescribeBandwidthLimitationDescribeBandwidthLimitationQueries the maximum public bandwidth that can be purchased, upgraded, or downgraded for various Elastic Compute Service (ECS) instance types.
DescribeClassicLinkInstancesDescribeClassicLinkInstancesQueries Elastic Compute Service (ECS) instances that reside in the classic network and have established ClassicLink connections with virtual private clouds (VPCs).
ModifyInstanceNetworkSpecModifyInstanceNetworkSpecModifies the bandwidth configurations of an Elastic Compute Service (ECS) instance. You can modify the bandwidth configurations of an instance to improve network performance.

Elastic network interfaces (ENIs)

APITitleDescription
CreateNetworkInterfaceCreateNetworkInterfaceCreates an elastic network interface (ENI).
AttachNetworkInterfaceAttachNetworkInterfaceAttaches an elastic network interface (ENI) to an Elastic Compute Service (ECS) instance that resides in a virtual private cloud (VPC).
DetachNetworkInterfaceDetachNetworkInterfaceDetach an elastic network interface (ENI) from an Elastic Compute Service (ECS) instance.
DescribeNetworkInterfacesDescribeNetworkInterfacesQueries the details of one or more elastic network interfaces (ENIs).
DescribeNetworkInterfaceAttributeDescribeNetworkInterfaceAttributeQueries the details of an elastic network interface (ENI).
ModifyNetworkInterfaceAttributeModifyNetworkInterfaceAttributeModifies the attributes, such as the name, description, and security group of an elastic network interface (ENI).
AssignPrivateIpAddressesAssignPrivateIpAddressesAssigns one or more secondary private IP addresses to an elastic network interface (ENI). You can specify available 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 Elastic Compute Service (ECS) to automatically assign them.
UnassignPrivateIpAddressesUnassignPrivateIpAddressesUnassigns one or more secondary private IP addresses from an elastic network interface (ENI).
AssignIpv6AddressesAssignIpv6AddressesAssigns one or more IPv6 addresses to an elastic network interface (ENI).
UnassignIpv6AddressesUnassignIpv6AddressesUnassign one or more IPv6 addresses from an elastic network interface (ENI).
DeleteNetworkInterfaceDeleteNetworkInterfaceDeletes an elastic network interface (ENI).

System events

APITitleDescription
DescribeInstancesFullStatusDescribeInstancesFullStatusQueries the full status information of Elastic Compute Service (ECS) instances. The full status information includes instance states and system event states. The instance states are the lifecycle states of instances. The system event states are the health states of maintenance events that occur on ECS instances.
DescribeDisksFullStatusDescribeDisksFullStatusQueries the full status information about one or more Elastic Block Storage (EBS) devices.
DescribeInstanceHistoryEventsDescribeInstanceHistoryEventsQueries historical system events that are inactive.
CreateSimulatedSystemEventsCreateSimulatedSystemEventsSchedules simulated system events for one or more Elastic Compute Service (ECS) instances. The simulated system events do not actually occur on or affect ECS instances.
CancelSimulatedSystemEventsCancelSimulatedSystemEventsCancels 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.
AcceptInquiredSystemEventAcceptInquiredSystemEventAccepts the default operation for a system event in the Inquiring state and authorizes the system to perform the default operation.

OM and monitoring

APITitleDescription
GetInstanceScreenshotGetInstanceScreenshotObtains the screenshots of an Elastic Compute Service (ECS) instance.
GetInstanceConsoleOutputGetInstanceConsoleOutputQueries the command output of an Elastic Compute Service (ECS) instance. The returned command output is encoded in Base64.
DescribeDiskMonitorDataDescribeDiskMonitorDataQueries the monitoring data of a disk in a specific period of time.
DescribeInstanceMonitorDataDescribeInstanceMonitorDataQueries the monitoring data of an Elastic Compute Service (ECS) instance. The monitoring data can include the vCPU utilization, CPU credits of the burstable instance, amount of received data traffic, amount of sent data traffic, and average bandwidth.
DescribeEniMonitorDataDescribeEniMonitorDataQueries the monitoring data of a secondary elastic network interface (ENI) over a specific period of time.
DescribeSnapshotMonitorDataDescribeSnapshotMonitorDataQueries the monitoring data of snapshot sizes in a region over the last 30 days.
DescribeInstanceMaintenanceAttributesDescribeInstanceMaintenanceAttributesQueries the maintenance attributes of an instance.
ModifyInstanceMaintenanceAttributesModifyInstanceMaintenanceAttributesModifies the maintenance attributes of an instance.
RedeployInstanceRedeployInstanceRedeploys an Elastic Compute Service (ECS) instance when you receive an event notification for the instance.
ReportInstancesStatusReportInstancesStatusReports the same exception on multiple Elastic Compute Service (ECS) instances or on multiple disks of an ECS instance.

Cloud Assistant

APITitleDescription
RunCommandRunCommandRuns a shell, PowerShell, or batch command on Elastic Compute Service (ECS) instances.
CreateCommandCreateCommandCreates a Cloud Assistant command.
InvokeCommandInvokeCommandTriggers a Cloud Assistant command on one or more Elastic Compute Service (ECS) instances.
DescribeInvocationsDescribeInvocationsQueries the execution list and states of Cloud Assistant commands.
DescribeInvocationResultsDescribeInvocationResultsQueries the execution results of one or more Cloud Assistant commands on Elastic Compute Service (ECS) instances.
ModifyInvocationAttributeModifyInvocationAttributeModifies the execution information of a Cloud Assistant command that is run on schedule.
StopInvocationStopInvocationStops the process of a Cloud Assistant command that is running on one or more Elastic Compute Service (ECS) instances.
DescribeCommandsDescribeCommandsQueries the Cloud Assistant commands that you created or the common Cloud Assistant commands that Alibaba Cloud provides.
ModifyCommandModifyCommandModifies the parameters and content of a Cloud Assistant command.
DeleteCommandDeleteCommandDeletes a Cloud Assistant command.
SendFileSendFileSends a file to one or more Elastic Compute Service (ECS) instances.
DescribeSendFileResultsDescribeSendFileResultsQueries the files sent by Cloud Assistant and their status.
DescribeCloudAssistantStatusDescribeCloudAssistantStatusQueries whether Cloud Assistant Agent is installed on Elastic Compute Service (ECS) instances. If Cloud Assistant Agent is installed, the system queries the total number of Cloud Assistant commands that have been run, the number of Cloud Assistant commands that are being run, and the time when Cloud Assistant commands were last run.
InstallCloudAssistantInstallCloudAssistantInstalls the Cloud Assistant client on one or more Elastic Compute Service (ECS) instances. After the Cloud Assistant client is installed on ECS instances, you must restart the instances for the Cloud Assistant client to take effect.
StartTerminalSessionStartTerminalSessionCreates a session by using the session management feature. When you call this operation, you can include the ID of an Elastic Compute Service (ECS) instance in the request to create a WebSocket session for the instance. The URL of the WebSocket session returned by the operation can be used to connect to the instance.
DescribeTerminalSessionsDescribeTerminalSessionsQueries the session records of Elastic Compute Service (ECS) Session Manager.
ModifyCloudAssistantSettingsModifyCloudAssistantSettingsModifies the configurations of a Cloud Assistant feature.
DescribeCloudAssistantSettingsDescribeCloudAssistantSettingsQueries the configurations of Cloud Assistant features.
CreateActivationCreateActivationCreates an activation code. The activation code is used to register servers that are not provided by Alibaba Cloud as Alibaba Cloud managed instances.
DescribeActivationsDescribeActivationsQueries existing activation codes and their usage information.
DisableActivationDisableActivationDisables an activation code.
DeleteActivationDeleteActivationDeletes an unused activation code.
DescribeManagedInstancesDescribeManagedInstancesQueries a list of managed instances.
ModifyManagedInstanceModifyManagedInstanceModifies the information about a managed instance.
DeregisterManagedInstanceDeregisterManagedInstanceDeregisters a managed instance. After you deregister the managed instance, you can no longer use Cloud Assistant to send commands or files to the instance.
ListPluginStatusListPluginStatusQueries the states of Cloud Assistant plug-ins on Elastic Compute Service (ECS) instances.

HPC clusters

APITitleDescription
CreateHpcClusterCreateHpcClusterCreates a high performance computing (HPC) cluster.
DescribeHpcClustersDescribeHpcClustersQueries available high performance computing (HPC) clusters. You can specify multiple request parameters to be queried. Specified parameters have logical AND relations and are included in the filter conditions. The request parameters are not dependent on each other.
ModifyHpcClusterAttributeModifyHpcClusterAttributeYou can call this operation to modify the description of an Alibaba Cloud HPC (HPC) cluster.
DeleteHpcClusterDeleteHpcClusterYou can call this operation to delete an HPC cluster.

Tags and ResourceGroup

APITitleDescription
TagResourcesTagResourcesCreates and adds tags to specified Elastic Compute Service (ECS) resources.
ListTagResourcesListTagResourcesQueries the tags that are added to one or more Elastic Compute Service (ECS) resources.
UntagResourcesUntagResources
JoinResourceGroupJoinResourceGroupAdds an Elastic Compute Service (ECS) resource or service to a resource group.

Regions

APITitleDescription
DescribeRegionsDescribeRegionsQueries available Alibaba Cloud regions.
DescribeZonesDescribeZonesQueries the zones in a specific region.
DescribeAvailableResourceDescribeAvailableResourceQueries the availability of resources in a zone. You can call this operation before you create or modify instances to ensure that sufficient resources are available.
DescribeAccountAttributesDescribeAccountAttributesQueries the quotas of Elastic Compute Service (ECS) resources that you can create in an Alibaba Cloud region. For a specific region, you can query the maximum numbers of security groups, elastic network interfaces (ENIs), vCPUs for pay-as-you-go instances, vCPUs for preemptible instances, the capacity quotas for pay-as-you-go disks that you can create and the number of dedicated hosts that you can create. You can also query information such as network types or whether an account has completed real-name verification.
DescribeResourcesModificationDescribeResourcesModificationQueries available resources within a specific zone when you upgrade or downgrade instance types or replace system disks.

Inquiry

APITitleDescription
DescribePriceDescribePriceQueries the most recent prices of Elastic Compute Resource (ECS) resources.
DescribeRenewalPriceDescribeRenewalPriceQueries the renewal price of a subscription Elastic Compute Service (ECS) resource. Only the renewal prices of subscription resources can be queried.
DescribeInstanceModificationPriceDescribeInstanceModificationPriceQueries the pricing information about newly attached subscription data disks or about the new instance types when you upgrade the configurations of unexpired subscription Elastic Compute Service (ECS) instances.

Tasks

APITitleDescription
DescribeTasksDescribeTasksQueries the progress of one or more asynchronous requests.
DescribeTaskAttributeDescribeTaskAttributeYou can call this operation to query the details of an asynchronous task. You can query the asynchronous tasks including importing images, exporting images, and modifying disk categories. The asynchronous tasks are generated by the ImportImage, ExportImage, and ModifyDiskSpec operations.
CancelTaskCancelTaskCancels a running task. You can cancel the running tasks generated by the ImportImage or ExportImage operation.