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 (78410016550) 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
| API | Title | Description |
|---|---|---|
| RunInstances | RunInstances | Creates pay-as-you-go or subscription Elastic Compute Service (ECS) instances. This operation provides a wide array of features and functions and helps simplify the procedure to create and manage ECS instances. When you call this operation, you can choose to create multiple ECS instances at a time, automatically start the instances, and assign public IP addresses to them. You can also use the features provided by the operation, such as configuring an automatic release time for instances, using a launch template, and configuring custom CPU options, to customize instance configurations for better management of instances. |
| CreateInstance | CreateInstance | Creates a subscription or pay-as-you-go Elastic Compute Service (ECS) instance. When you call this operation, you can specify different parameters to create instances based on your business requirements. |
| StartInstance | StartInstance | Starts an Elastic Compute Service (ECS) instance. You can specify the ID of an ECS instance and parameters, such as InitLocalDisk, in the request based on your business requirements to start the instance. |
| StartInstances | StartInstances | Starts Elastic Compute Service (ECS) instances that are in the Stopped state. |
| StopInstance | StopInstance | Stops an Elastic Compute Service (ECS) instance in the Running state. After you call this operation, the state of the instance changes to Stopping and then to Stopped. |
| StopInstances | StopInstances | Stops Elastic Compute Service (ECS) instances. You can specify parameters to determine whether to forcefully stop the instances, the stop mode, and the batch operation mode. |
| RebootInstance | RebootInstance | Restarts an Elastic Compute Service (ECS) instance that is in the Running state. |
| RebootInstances | RebootInstances | Restarts Elastic Compute Service (ECS) instances that are in the Running state. After you call this API operation, the instances enter the Stopping state and then the Running state. |
| AttachInstanceRamRole | AttachInstanceRamRole | Attaches an instance Resource Access Management (RAM) role to Elastic Compute Service (ECS) instances. |
| DescribeInstanceRamRole | DescribeInstanceRamRole | Queries the instance Resource Access Management (RAM) roles that are attached to Elastic Compute Service (ECS) instances based on the instance IDs, or queries the ECS instances to which a specific instance RAM role is attached based on the name of the instance RAM role. |
| DetachInstanceRamRole | DetachInstanceRamRole | Detaches instance Resource Access Management (RAM) roles from Elastic Compute Service (ECS) instances. |
| DescribeInstanceStatus | DescribeInstanceStatus | Queries the status of one or more Elastic Compute Service (ECS) instances. You can also call this operation to query the list of ECS instances that match the specified filter conditions. |
| DescribeInstances | DescribeInstances | Queries the information about Elastic Compute Service (ECS) instances. |
| DescribeInstanceVncUrl | DescribeInstanceVncUrl | Queries the Virtual Network Computing (VNC) logon address of an Elastic Compute Service (ECS) instance. |
| ModifyInstanceVncPasswd | ModifyInstanceVncPasswd | Changes the VNC password of an Elastic Compute Service (ECS) instance. |
| DescribeUserData | DescribeUserData | Queries the user data of an Elastic Compute Service (ECS) instance. |
| DescribeInstanceAutoRenewAttribute | DescribeInstanceAutoRenewAttribute | Queries the auto-renewal attribute of subscription Elastic Compute Service (ECS) instances, including whether auto-renewal is enabled for the instances and the auto-renewal durations of the instances. |
| ModifyInstanceAutoRenewAttribute | ModifyInstanceAutoRenewAttribute | Configures auto-renewal for one or more subscription instances. To reduce the maintenance workloads when instances expire, you can configure auto-renewal for subscription instances. |
| RenewInstance | RenewInstance | Renews a subscription Elastic Compute Service (ECS) instance. When you call this operation, you can specify parameters, such as InstanceId, Period, and ExpectedRenewDay, in the request. |
| DescribeSpotPriceHistory | DescribeSpotPriceHistory | Queries the price history of a preemptible instance within the previous 30 days. |
| DescribeSpotAdvice | DescribeSpotAdvice | Queries information about preemptible instances in a region in the previous 30 days. The information includes 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. |
| DescribeInstanceTypeFamilies | DescribeInstanceTypeFamilies | Queries the instance families provided by Elastic Compute Service (ECS). |
| DescribeInstanceTypes | DescribeInstanceTypes | Queries the details of all instance types or a specific instance type provided by Elastic Compute Service (ECS). |
| DescribeInstanceAttribute | DescribeInstanceAttribute | Queries the details of an instance by instance ID. |
| ModifyInstanceAttribute | ModifyInstanceAttribute | Modifies the attributes of an Elastic Compute Service (ECS) instance, such as the password, name, description, hostname, security groups, maximum transmission unit (MTU), and user data. If the instance is a burstable instance, you can also change the performance mode of the instance. |
| ModifyInstanceMetadataOptions | ModifyInstanceMetadataOptions | Modifies the metadata of an Elastic Compute Service (ECS) instance. When you call this operation, you can specify parameters, such as InstanceID and HttpEndpoint, in the request. |
| ModifyInstanceAutoReleaseTime | ModifyInstanceAutoReleaseTime | Sets 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. |
| ModifyInstanceChargeType | ModifyInstanceChargeType | Changes the billing method of one or more Elastic Compute Service (ECS) instances. You can change the billing methods of ECS instances between pay-as-you-go and subscription or change the billing method of all disks that are attached to an ECS instance from pay-as-you-go to subscription. |
| ModifyInstanceSpec | ModifyInstanceSpec | Changes the instance type and public bandwidth of a pay-as-you-go Elastic Compute Service (ECS) instance. |
| ModifyPrepayInstanceSpec | ModifyPrepayInstanceSpec | Upgrades 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. |
| ReActivateInstances | ReActivateInstances | Reactivates a pay-as-you-go Elastic Compute Service (ECS) instance that has expired or has been recycled due to overdue payments. |
| DeleteInstance | DeleteInstance | Releases a pay-as-you-go Elastic Compute Service (ECS) instance or an expired subscription ECS instance. You can configure parameters to specify whether to release the disks attached to the instance or retain the disks as pay-as-you-go disks. |
| DeleteInstances | DeleteInstances | Releases multiple pay-as-you-go Elastic Compute Service (ECS) instances or expired subscription ECS instances at a time. You can configure parameters to specify whether to release the disks attached to the instances or retain the disks as pay-as-you-go disks. |
Dedicated hosts
| API | Title | Description |
|---|---|---|
| AllocateDedicatedHosts | AllocateDedicatedHosts | Creates 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. |
| DescribeDedicatedHosts | DescribeDedicatedHosts | Queries the information about dedicated hosts, including the physical performance specifications, machine codes, and status of the dedicated hosts, and Elastic Compute Service (ECS) instances that are created on the dedicated hosts. |
| DescribeDedicatedHostTypes | DescribeDedicatedHostTypes | Queries the details of dedicated host types supported in a region, or the Elastic Compute Service (ECS) instance families supported by a specific dedicated host type. |
| ModifyDedicatedHostClusterAttribute | ModifyDedicatedHostClusterAttribute | Modifies the attributes of a dedicated host cluster, such as its name and description. |
| ModifyDedicatedHostAttribute | ModifyDedicatedHostAttribute | Modifies the information about a dedicated host, such as the name, description, and instance migration policy that is applied when the dedicated host fails. |
| ModifyDedicatedHostsChargeType | ModifyDedicatedHostsChargeType | Changes the billing method of dedicated hosts. |
| DescribeDedicatedHostAutoRenew | DescribeDedicatedHostAutoRenew | Queries the auto-renewal status of subscription dedicated hosts. |
| ModifyDedicatedHostAutoRenewAttribute | ModifyDedicatedHostAutoRenewAttribute | Enables or disables auto-renewal for one or more subscription dedicated hosts. |
| RenewDedicatedHosts | RenewDedicatedHosts | Renews one or more subscription dedicated hosts. |
| ModifyDedicatedHostAutoReleaseTime | ModifyDedicatedHostAutoReleaseTime | Sets or cancels automatic release time for a pay-as-you-go dedicated host. |
| ModifyInstanceDeployment | ModifyInstanceDeployment | Changes 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. |
| RedeployDedicatedHost | RedeployDedicatedHost | Migrates Elastic Compute Service (ECS) instances away from a failed dedicated host. |
| ReleaseDedicatedHost | ReleaseDedicatedHost | Releases a pay-as-you-go dedicated host. |
| CreateDedicatedHostCluster | CreateDedicatedHostCluster | Creates a dedicated host cluster. When you call this operation, you can specify parameters, such as ResourceGroupId, DedicatedHostClusterName, and ZoneId, in the request. |
| DescribeDedicatedHostClusters | DescribeDedicatedHostClusters | Queries the information about one or more dedicated host clusters. |
| DeleteDedicatedHostCluster | DeleteDedicatedHostCluster | Deletes a dedicated host cluster. Before you call this operation, migrate the dedicated hosts in the dedicated host cluster that you want to delete to another dedicated host cluster. When you call this operation, you can specify RegionId and DedicatedHostClusterId in the request. |
Launch templates
| API | Title | Description |
|---|---|---|
| CreateLaunchTemplate | CreateLaunchTemplate | Creates a launch template. When you call this operation, you can specify parameters, such as TemplateTag, LaunchTemplateName, and ImageId, in the request. A launch template eliminates the need to configure a large number of parameters every time you create an Elastic Compute Service (ECS) instance. |
| DescribeLaunchTemplates | DescribeLaunchTemplates | Queries the information of one or more launch templates, such as the total number of launch templates, the creation time of each launch template, and the latest version number of each launch template. When you can this operation, you can specify parameters, such as TemplateTag, TemplateResourceGroupId, and LaunchTemplateId, in the request. |
| DeleteLaunchTemplate | DeleteLaunchTemplate | Deletes a launch template. You can use the LaunchTemplateId or LaunchTemplateName parameter to specify the launch template that you want to delete from the specified region. |
| CreateLaunchTemplateVersion | CreateLaunchTemplateVersion | Creates a version for a launch template. You can use the created version to create Elastic Compute Service (ECS) instances, scaling groups, or auto provisioning groups. When you call this operation, you can specify parameters, such as LaunchTemplateId, VersionDescription, and instance-related parameters, in the request. |
| DescribeLaunchTemplateVersions | DescribeLaunchTemplateVersions | Queries the information of launch template versions, such as the total number of launch templates, launch template names, and launch template version numbers. When you call this operation, you can specify parameters, such as LaunchTemplateVersion, LaunchTemplateId, and DetailFlag, in the request. |
| ModifyLaunchTemplateDefaultVersion | ModifyLaunchTemplateDefaultVersion | Changes the default version of a launch template. When you call this operation, you can specify DefaultVersionNumber in the request. If you do not specify a version when you create Elastic Compute Service (ECS) instances based on a launch template, the default version of the launch template is used. |
| DeleteLaunchTemplateVersion | DeleteLaunchTemplateVersion | Deletes versions of a launch template. When you call this operation, you can specify parameters, such as LaunchTemplateId and DeleteVersion, in the request. |
Resource diagnostic
| API | Title | Description |
|---|---|---|
| CreateDiagnosticReport | CreateDiagnosticReport | Creates a diagnostic report for a resource. |
| DescribeDiagnosticReports | DescribeDiagnosticReports | Queries diagnostic reports. |
| DescribeDiagnosticReportAttributes | DescribeDiagnosticReportAttributes | Queries the details of a diagnostic report. |
| DeleteDiagnosticReports | DeleteDiagnosticReports | Deletes diagnostic reports. |
| CreateDiagnosticMetricSet | CreateDiagnosticMetricSet | Creates a diagnostic metric set. You can group diagnostic metrics into diagnostic metric sets. |
| DescribeDiagnosticMetricSets | DescribeDiagnosticMetricSets | Queries diagnostic metric sets. |
| DescribeDiagnosticMetrics | DescribeDiagnosticMetrics | Queries diagnostic metrics. |
| ModifyDiagnosticMetricSet | ModifyDiagnosticMetricSet | Modifies a diagnostic metric set. |
| DeleteDiagnosticMetricSets | DeleteDiagnosticMetricSets | Delete diagnostic metric sets. |
Elasticity assurances
| API | Title | Description |
|---|---|---|
| CreateElasticityAssurance | CreateElasticityAssurance | Creates an elasticity assurance in a region. When you call this operation, you can specify parameters, such as ZoneId and InstanceType, in the request. |
| DescribeElasticityAssurances | DescribeElasticityAssurances | Queries the details of elasticity assurances. |
| DescribeElasticityAssuranceInstances | DescribeElasticityAssuranceInstances | Queries the running Elastic Compute Service (ECS) instances that match and use the elasticity assurance service. |
| ModifyElasticityAssurance | ModifyElasticityAssurance | You can call this operation to modify the name and description of an elasticity assurance. |
| RenewElasticityAssurances | RenewElasticityAssurances | Renews one or more elasticity assurances that you purchased. When you call this operation, you can specify parameters, such as PrivatePoolOptionsId and Period, in the request. |
| PurchaseElasticityAssurance | PurchaseElasticityAssurance | Purchases an elasticity assurance that is not in the Active state and for which resources are prepared. |
| CreateCapacityReservation | CreateCapacityReservation | Creates a capacity reservation. When you call this operation, you can specify parameters in the request, such as InstanceAmount, InstanceType, StartTime, and ZoneId. |
| DescribeCapacityReservations | DescribeCapacityReservations | Queries the details of one or more capacity reservations. The details of a capacity reservation that you can query include the status, effective time, expiration time, and private pool type of the capacity reservation and the number of instances that have used the capacity reservation. |
| DescribeCapacityReservationInstances | DescribeCapacityReservationInstances | Queries the instances that match a capacity reservation. |
| ModifyCapacityReservation | ModifyCapacityReservation | Modifies the information of a capacity reservation, including the name, description, release mode, and the total number of Elastic Compute Service (ECS) instances for which capacity is reserved. |
| DescribeInstanceAttachmentAttributes | DescribeInstanceAttachmentAttributes | Queries the information about the private pools that Elastic Compute Service (ECS) instances match, such as the private pool types and IDs. |
| ModifyInstanceAttachmentAttributes | ModifyInstanceAttachmentAttributes | The type of the new private pool. |
| ReleaseCapacityReservation | ReleaseCapacityReservation | Releases a capacity reservation. |
Auto provisioning groups
| API | Title | Description |
|---|---|---|
| CreateAutoProvisioningGroup | CreateAutoProvisioningGroup | Creates an auto provisioning group. When you call this operation, you can specify parameters, such as ResourceGroupId, AutoProvisioningGroupType, and ValidFrom, in the request. |
| DescribeAutoProvisioningGroups | DescribeAutoProvisioningGroups | Queries the information of one or more auto provisioning groups. |
| DescribeAutoProvisioningGroupInstances | DescribeAutoProvisioningGroupInstances | You can call this operation to query instances in an auto provisioning group. |
| ModifyAutoProvisioningGroup | ModifyAutoProvisioningGroup | Modifies the configurations of an auto-provisioning group. |
| DescribeAutoProvisioningGroupHistory | DescribeAutoProvisioningGroupHistory | Queries the scheduling tasks of an auto provisioning group. |
| DeleteAutoProvisioningGroup | DeleteAutoProvisioningGroup | Deletes an auto provisioning group. When you call this operation, you can specify AutoProvisioningGroupId and TerminateInstances in the request. |
Elastic Block Storage (EBS) devices
| API | Title | Description |
|---|---|---|
| CreateDisk | 创建一块按量付费或包年包月数据盘 | 创建一块按量付费或包年包月数据盘。 |
| DescribeDisks | DescribeDisks | Queries block storage devices that you created, including cloud disks, local disks, and elastic ephemeral disks. |
| AttachDisk | AttachDisk | Attaches 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. |
| DetachDisk | DetachDisk | Detaches a pay-as-you-go data disk or a system disk from an Elastic Compute Service (ECS) instance. |
| ModifyDiskAttribute | ModifyDiskAttribute | Modifies the attributes of block storage devices, including the names and descriptions of the devices and whether to release the devices together with the associated instances. |
| ReplaceSystemDisk | ReplaceSystemDisk | Replaces the operating system of an Elastic Compute Service (ECS) instance. After you perform an operating system replacement operation, the original disk is released and a new system disk is created. This causes the ID of the system disk to change. |
| ReInitDisk | ReInitDisk | Re-initializes a disk to the state that it was in when it was created. |
| ResizeDisk | ResizeDisk | Resizes a system disk or data disk. |
| ResetDisk | ResetDisk | Rolls back a disk to the state at a specific point in time based on a snapshot of the disk. |
| ModifyDiskChargeType | ModifyDiskChargeType | Changes the billing method of data disks that are attached to a subscription Elastic Compute Service (ECS) instance. |
| ModifyDiskSpec | ModifyDiskSpec | You can call this operation to change the category of a disk or modify the performance level of an enhanced SSD (ESSD). |
| DeleteDisk | 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 (ESSD). |
Reserved instances
| API | Title | Description |
|---|---|---|
| PurchaseReservedInstancesOffering | PurchaseReservedInstancesOffering | Purchases a reserved instance. When you call this operation, you can specify parameters, such as InstanceType and Scope, in the request. Reserved instances can be applied to automatically offset fees for pay-as-you-go Elastic Compute Service (ECS) instances. |
| DescribeReservedInstances | DescribeReservedInstances | Queries purchased reserved instances. |
| ModifyReservedInstances | ModifyReservedInstances | Splits, merges, or modifies reserved instances. When you call this operation, you can specify parameters, such as ReservedInstanceId, ZoneId, InstanceType, and InstanceAmount, in the request. |
| ModifyReservedInstanceAttribute | ModifyReservedInstanceAttribute | Modifies the attributes of a reserved instance, such as its name and description. |
| RenewReservedInstances | RenewReservedInstances | Renews existing reserved instances. |
| DescribeReservedInstanceAutoRenewAttribute | DescribeReservedInstanceAutoRenewAttribute | Queries the auto-renewal status of one or more subscription reserved instances. |
| ModifyReservedInstanceAutoRenewAttribute | ModifyReservedInstanceAutoRenewAttribute | Enables or disables auto-renewal for one or more reserved instances. |
Storage capacity units (SCUs)
| API | Title | Description |
|---|---|---|
| PurchaseStorageCapacityUnit | PurchaseStorageCapacityUnit | Purchases one or more storage capacity units (SCUs). |
| DescribeStorageCapacityUnits | DescribeStorageCapacityUnits | Queries the details of one or more SCUs. |
| ModifyStorageCapacityUnitAttribute | ModifyStorageCapacityUnitAttribute | Changes the name or modifies the description of a storage capacity unit (SCU). |
Images
| API | Title | Description |
|---|---|---|
| CreateImage | CreateImage | Creates 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 custom image or call the ReplaceSystemDisk operation to replace system disks by using the custom image. |
| ImportImage | ImportImage | Imports 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 disk of an ECS instance by calling the ReplaceSystemDisk operation. |
| ExportImage | ExportImage | Exports a custom image to an Object Storage Service (OSS) bucket in the same region. |
| CopyImage | CopyImage | Copies a custom image from one region to another. You can deploy or copy Elastic Compute Service (ECS) instances across regions by copying custom images. |
| CancelCopyImage | CancelCopyImage | Cancels an ongoing image copy task. |
| DescribeImages | DescribeImages | Queries available images. When you call this operation, you can specify parameters, such as ImageId, ImageFamily, and InstanceType, in the request. |
| DescribeImageSharePermission | DescribeImageSharePermission | Queries the accounts with which a custom image is shared. When you call this operation, you can specify parameters, such as RegionId and ImageId, in the request. The response can be displayed by page. By default, 10 entries are displayed on each page. |
| ModifyImageAttribute | ModifyImageAttribute | Modifies the attributes of a custom image, such as the image family, name, boot mode, and status and whether the image supports the Non-Volatile Memory Express (NVMe) protocol. When you call this operation, you can specify parameters, such as ImageId and ImageFamily, in the request. |
| ModifyImageSharePermission | ModifyImageSharePermission | Manages 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. |
| DescribeImageSupportInstanceTypes | DescribeImageSupportInstanceTypes | Queries the instance types supported by an image. |
| DescribeImageFromFamily | DescribeImageFromFamily | You can call this operation to query available custom images that are newly created in a specific image family. |
| DeleteImage | DeleteImage | Deletes a custom image. When you call this operation, you can specify ImageId and Force in the request. |
Image components
| API | Title | Description |
|---|---|---|
| CreateImageComponent | CreateImageComponent | Creates an image component. Image components are used to store the image template commands that are commonly used to create images. |
| CreateImagePipeline | CreateImagePipeline | Creates an image template. Image templates can be used to create images. |
| DescribeImageComponents | DescribeImageComponents | Queries the information about one or more image components. |
| DescribeImagePipelines | DescribeImagePipelines | Queries the information about one or more image templates. |
| StartImagePipelineExecution | StartImagePipelineExecution | Executes a pipeline task by using an image template. |
| DescribeImagePipelineExecutions | DescribeImagePipelineExecutions | Queries the details of an image creation task. |
| CancelImagePipelineExecution | CancelImagePipelineExecution | You can call this operation to cancel an image build task. |
| DeleteImageComponent | DeleteImageComponent | Deletes an image component. |
| DeleteImagePipeline | DeleteImagePipeline | Deletes an image template. |
Snapshots
| API | Title | Description |
|---|---|---|
| CreateSnapshot | CreateSnapshot | The 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. |
| CopySnapshot | CopySnapshot | Copies a standard or encrypted snapshot from one region to another. |
| DescribeSnapshots | DescribeSnapshots | Queries the details of all snapshots of an Elastic Compute Service (ECS) instance or a cloud disk. The details include the status of the snapshots, amount of remaining time required to create the snapshots, and the retention period of the automatic snapshots in days. |
| DescribeSnapshotsUsage | DescribeSnapshotsUsage | Queries the number of snapshots that are stored in a region and the total size of the snapshots. |
| DescribeSnapshotPackage | DescribeSnapshotPackage | Queries purchased Object Storage Service (OSS) storage plans in a specified Alibaba Cloud region. |
| DescribeSnapshotLinks | DescribeSnapshotLinks | Queries 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. |
| ModifySnapshotAttribute | ModifySnapshotAttribute | Modifies the name, description, or retention period of a snapshot. |
| DeleteSnapshotGroup | DeleteSnapshotGroup | Deletes a snapshot-consistent group. |
| DeleteSnapshot | DeleteSnapshot | Deletes a snapshot. If you call this operation to delete a snapshot that is being created, the snapshot creation task is canceled. |
| CreateAutoSnapshotPolicy | CreateAutoSnapshotPolicy | Creates 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. |
| DescribeAutoSnapshotPolicyEx | DescribeAutoSnapshotPolicyEx | Queries automatic snapshot policies in a region. |
| ModifyAutoSnapshotPolicyEx | ModifyAutoSnapshotPolicyEx | Modifies 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. |
| ApplyAutoSnapshotPolicy | ApplyAutoSnapshotPolicy | Applies an automatic snapshot policy to one or more disks. You can call this operation to replace the automatic snapshot policy of a disk. |
| CancelAutoSnapshotPolicy | CancelAutoSnapshotPolicy | Disables automatic snapshot policies for one or more disks. |
| DeleteAutoSnapshotPolicy | DeleteAutoSnapshotPolicy | You 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. |
| CreateSnapshotGroup | CreateSnapshotGroup | Creates a snapshot-consistent group for the disks of an Elastic Compute Service (ECS) instance. A snapshot-consistent group contains snapshots of one or more disks. |
| DescribeSnapshotGroups | DescribeSnapshotGroups | Queries the information of one or more snapshot-consistent groups, such as the status of the groups, IDs of the instances associated with the groups, and snapshot creation progress. |
| ModifySnapshotGroup | ModifySnapshotGroup | Modifies the name and description of a snapshot-consistent group. |
PrefixList
| API | Title | Description |
|---|---|---|
| CreatePrefixList | CreatePrefixList | Creates a prefix list. |
| DescribePrefixLists | DescribePrefixLists | Queries the information of one or more prefix lists. |
| DescribePrefixListAssociations | DescribePrefixListAssociations | Queries the information of resources that are associated with a specific prefix list. |
| DescribePrefixListAttributes | DescribePrefixListAttributes | Queries the details of a prefix list, including the name, address family, maximum number of entries, and details of the entries. |
| ModifyPrefixList | ModifyPrefixList | Modifies the name, description, or entries of a specific prefix list. |
| DeletePrefixList | DeletePrefixList | Deletes a prefix list and all entries in the prefix list. |
Security groups
| API | Title | Description |
|---|---|---|
| CreateSecurityGroup | CreateSecurityGroup | Creates 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. |
| DescribeSecurityGroups | DescribeSecurityGroups | Queries the basic information of security groups. |
| DescribeSecurityGroupAttribute | DescribeSecurityGroupAttribute | Queries the rules of a security group. |
| ModifySecurityGroupPolicy | ModifySecurityGroupPolicy | Modifies the internal access control policy of instances in a basic security group. The internal access control policy of instances in an advanced security group cannot be modified. |
| ModifySecurityGroupAttribute | ModifySecurityGroupAttribute | Modifies the name or description of a security group. When you call this operation, you can specify parameters, such as SecurityGroupId, SecurityGroupName, and Description, in the request. |
| ModifySecurityGroupRule | ModifySecurityGroupRule | Modifies an inbound rule in a security group. |
| ModifySecurityGroupEgressRule | ModifySecurityGroupEgressRule | Modifies outbound rules in a security group. |
| AuthorizeSecurityGroup | AuthorizeSecurityGroup | Creates 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. |
| AuthorizeSecurityGroupEgress | AuthorizeSecurityGroupEgress | Creates outbound rules in a security group. You can use the created rules to allow or deny outbound traffic from Elastic Compute Service (ECS) instances in the security group to other objects for fine-grained network access control. |
| JoinSecurityGroup | JoinSecurityGroup | Adds an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) to a security group. When you call this operation, you can specify parameters, such as SecurityGroupId, InstanceId, and NetworkInterfaceId, in the request. |
| LeaveSecurityGroup | LeaveSecurityGroup | Removes an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) from a security group. To remove an ECS instance from a security group, specify SecurityGroupId and InstanceId in the request. To remove an ENI from a security group, specify SecurityGroupId and NetworkInterfaceId in the request. |
| DescribeSecurityGroupReferences | DescribeSecurityGroupReferences | Queries the security groups that are referencing specific security groups. When you call this operation, you can specify SecurityGroupId. |
| RevokeSecurityGroup | RevokeSecurityGroup | Deletes one or more inbound security group rules. |
| RevokeSecurityGroupEgress | RevokeSecurityGroupEgress | Deletes outbound security group rules. |
| DeleteSecurityGroup | DeleteSecurityGroup | Deletes a security group. When you call this operation, you can specify RegionId and SecurityGroupId in the request. When a security group is deleted, the rules in the security group are also deleted. |
Deployment sets
| API | Title | Description |
|---|---|---|
| CreateDeploymentSet | CreateDeploymentSet | Creates a deployment set in a region. |
| DescribeDeploymentSetSupportedInstanceTypeFamily | DescribeDeploymentSetSupportedInstanceTypeFamily | Queries the instance families that support different deployment strategies. When you call this operation, specify parameters, such as RegionId and Strategy, in the request. |
| DescribeDeploymentSets | DescribeDeploymentSets | Queries the details of one or more deployment sets. When you call this operation, you can specify parameters, such as DeploymentSetIds, Strategy, and DeploymentSetName, in the request. |
| ModifyDeploymentSetAttribute | ModifyDeploymentSetAttribute | Modifies the name and description of a deployment set. When you call this operation, you can specify parameters, such as DeploymentSetId and DeploymentSetName, in the request. |
| DeleteDeploymentSet | DeleteDeploymentSet | Deletes a deployment set in a region. When you call this operation, specify parameters such as RegionId and DeploymentSetId in the request. |
SSH key pairs
| API | Title | Description |
|---|---|---|
| CreateKeyPair | CreateKeyPair | Creates 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 must properly store the private key and ensure its confidentiality. |
| ImportKeyPair | ImportKeyPair | Imports the public key of a Rivest–Shamir–Adleman (RSA)-encrypted key pair that is generated by a third-party tool. After the key pair is imported, Alibaba Cloud stores the public key. You must securely lock away the private key. |
| DescribeKeyPairs | DescribeKeyPairs | Queries one or more key pairs. |
| AttachKeyPair | AttachKeyPair | Binds an SSH key pair to one or more Linux instances. |
| DetachKeyPair | DetachKeyPair | Unbinds an SSH key pair from Linux instances. |
| DeleteKeyPairs | DeleteKeyPairs | Deletes one or more SSH key pairs. |
Networks
| API | Title | Description |
|---|---|---|
| ModifyInstanceVpcAttribute | ModifyInstanceVpcAttribute | Changes the virtual private cloud (VPC), private IP address, or vSwitch of an Elastic Compute Service (ECS) instance that resides in a VPC. |
| AllocatePublicIpAddress | AllocatePublicIpAddress | Assigns a public IP address to an Elastic Compute Service (ECS) instance. |
| ConvertNatPublicIpToEip | ConvertNatPublicIpToEip | Converts the public IP address of an Elastic Compute Service (ECS) instance located in a virtual private cloud (VPC) into an elastic IP address (EIP). |
| AttachClassicLinkVpc | AttachClassicLinkVpc | Links 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. |
| DetachClassicLinkVpc | DetachClassicLinkVpc | You 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. |
| DescribeBandwidthLimitation | DescribeBandwidthLimitation | Queries the maximum public bandwidth that can be purchased, upgraded, or downgraded for various Elastic Compute Service (ECS) instance types. |
| DescribeClassicLinkInstances | DescribeClassicLinkInstances | Queries Elastic Compute Service (ECS) instances that reside in the classic network and have established ClassicLink connections with virtual private clouds (VPCs). |
| ModifyInstanceNetworkSpec | ModifyInstanceNetworkSpec | Modifies 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)
| API | Title | Description |
|---|---|---|
| CreateNetworkInterface | CreateNetworkInterface | Creates an elastic network interface (ENI). When you call this operation, you can specify parameters, such as VSwitchId and PrimaryIpAddress, in the request. |
| AttachNetworkInterface | AttachNetworkInterface | Attaches an elastic network interface (ENI) to an Elastic Compute Service (ECS) instance that resides in a virtual private cloud (VPC). When you call this operation, you can specify parameters, such as NetworkInterfaceId, InstanceId, and NetworkCardIndex, in the request. |
| DetachNetworkInterface | DetachNetworkInterface | Detach an elastic network interface (ENI) from an Elastic Compute Service (ECS) instance. |
| DescribeNetworkInterfaces | DescribeNetworkInterfaces | Queries the details of one or more elastic network interfaces (ENIs). When you call this operation, you can specify parameters, such as ResourceGroupId, VSwitchId, and InstanceId, in the request. |
| DescribeNetworkInterfaceAttribute | DescribeNetworkInterfaceAttribute | Queries the details of an elastic network interface (ENI). When you call this operation, you can specify parameters, such as NetworkInterfaceId and Attribute, in the request. |
| ModifyNetworkInterfaceAttribute | ModifyNetworkInterfaceAttribute | Modifies the attributes, such as the name, description, and security groups, of an elastic network interface (ENI). When you call this operation, you can specify parameters, such as NetworkInterfaceId and SecurityGroupId, in the request. |
| AssignPrivateIpAddresses | AssignPrivateIpAddresses | Assigns 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 is connected to the ENI. Alternatively, you can specify a number of private IP addresses to automatically assign from the CIDR block of the vSwitch to the ENI. |
| UnassignPrivateIpAddresses | UnassignPrivateIpAddresses | Unassigns secondary private IP addresses from an elastic network interface (ENI). |
| AssignIpv6Addresses | AssignIpv6Addresses | Assigns one or more IPv6 addresses to an elastic network interface (ENI). |
| UnassignIpv6Addresses | UnassignIpv6Addresses | Unassigns IPv6 addresses from an elastic network interface (ENI). |
| DeleteNetworkInterface | DeleteNetworkInterface | Deletes an elastic network interface (ENI) in a region. DeleteNetworkInterface is an asynchronous operation. |
System events
| API | Title | Description |
|---|---|---|
| DescribeInstancesFullStatus | DescribeInstancesFullStatus | Queries the full status information of one or more Elastic Compute Service (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 instances. The status of instance system events is the health status of maintenance events. |
| DescribeDisksFullStatus | DescribeDisksFullStatus | Queries the full status information about one or more Elastic Block Storage (EBS) devices. |
| DescribeInstanceHistoryEvents | DescribeInstanceHistoryEvents | Queries the system events of Elastic Compute Service (ECS) instances. When you call this operation, you can specify parameters, such as InstanceId and EventType, in the request. By default, non-active system events are queried. |
| CreateSimulatedSystemEvents | CreateSimulatedSystemEvents | Schedules 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. |
| CancelSimulatedSystemEvents | CancelSimulatedSystemEvents | Cancels 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. |
| AcceptInquiredSystemEvent | AcceptInquiredSystemEvent | in the Inquiring state and authorizes the system to perform the default operations. |
OM and monitoring
| API | Title | Description |
|---|---|---|
| GetInstanceScreenshot | GetInstanceScreenshot | Obtains the screenshots of an Elastic Compute Service (ECS) instance. |
| GetInstanceConsoleOutput | GetInstanceConsoleOutput | Queries the command output of an Elastic Compute Service (ECS) instance. The returned command output is encoded in Base64. |
| DescribeDiskMonitorData | DescribeDiskMonitorData | Queries the monitoring data of a disk in a specific period of time. When you call this operation, you can specify parameters, such as DiskId, StartTime, and EndTime, in the request. |
| DescribeInstanceMonitorData | DescribeInstanceMonitorData | Queries 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. |
| DescribeEniMonitorData | DescribeEniMonitorData | Queries the monitoring data of a secondary elastic network interface (ENI) over a specific period of time. |
| DescribeSnapshotMonitorData | DescribeSnapshotMonitorData | Queries the monitoring data of snapshot sizes in a region over the last 30 days. |
| DescribeInstanceMaintenanceAttributes | DescribeInstanceMaintenanceAttributes | Queries the maintenance attributes of an instance. |
| ModifyInstanceMaintenanceAttributes | ModifyInstanceMaintenanceAttributes | Modifies the maintenance attributes of an instance. |
| RedeployInstance | RedeployInstance | Redeploys an instance when the instance receives a system event notification. |
| ReportInstancesStatus | ReportInstancesStatus | Reports an exception on Elastic Compute Service (ECS) instances. You can report the same exception on multiple ECS instances or on multiple disks of an ECS instance. |
Cloud Assistant
| API | Title | Description |
|---|---|---|
| RunCommand | RunCommand | Runs a shell, PowerShell, or batch command on one or more Elastic Compute Service (ECS) instances. When you call this operation, you can specify parameters, such as Type and CommandContent, in the request. |
| CreateCommand | CreateCommand | Creates a Cloud Assistant command, which can be a Shell, PowerShell, or batch command. |
| InvokeCommand | InvokeCommand | Runs a Cloud Assistant command on one or more Elastic Compute Service (ECS) instances. When you call this operation, you can specify parameters, such as CommandId, InstanceId, and ResourceGroupId, in the request. |
| DescribeInvocations | DescribeInvocations | Queries the execution list and states of Cloud Assistant commands. |
| DescribeInvocationResults | DescribeInvocationResults | Queries the execution results of one or more Cloud Assistant commands on Elastic Compute Service (ECS) instances. |
| ModifyInvocationAttribute | ModifyInvocationAttribute | Modifies the execution information of a Cloud Assistant scheduled command task, including modifying the content and execution frequency of the command and adding Elastic Compute Service (ECS) instances or Alibaba Cloud managed instances to the command task. |
| StopInvocation | StopInvocation | \* If you stop the process of a command that runs only once, the executions that have started are not interrupted. The executions that have not started are canceled. \* If you stop the process of a scheduled invocation command, the executions that have started are not interrupted. However, the execution does not start in the next period. |
| DescribeCommands | DescribeCommands | Queries the Cloud Assistant commands that you created or the common Cloud Assistant commands that Alibaba Cloud provides. |
| ModifyCommand | ModifyCommand | Modifies the parameters of a Cloud Assistant command. |
| DeleteCommand | DeleteCommand | Deletes a Cloud Assistant command in a region. This operation cannot delete Cloud Assistant commands that are being run. |
| SendFile | SendFile | Sends a file to one or more Elastic Compute Service (ECS) instances. |
| DescribeSendFileResults | DescribeSendFileResults | Queries the files sent by Cloud Assistant and their status. |
| DescribeCloudAssistantStatus | DescribeCloudAssistantStatus | Queries whether Cloud Assistant Agent is installed on 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. |
| InstallCloudAssistant | InstallCloudAssistant | Installs Cloud Assistant Agent on Elastic Compute Service (ECS) instances. After you install Cloud Assistant Agent on ECS instances, restart the instances for the installation to take effect. |
| StartTerminalSession | StartTerminalSession | Creates 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. |
| DescribeTerminalSessions | DescribeTerminalSessions | Queries the session records of Elastic Compute Service (ECS) Session Manager. |
| ModifyCloudAssistantSettings | ModifyCloudAssistantSettings | Modifies the configurations of a Cloud Assistant feature. |
| DescribeCloudAssistantSettings | DescribeCloudAssistantSettings | Queries the configurations of Cloud Assistant. |
| CreateActivation | CreateActivation | Creates an activation code. The activation code is used to register servers that are not provided by Alibaba Cloud as Alibaba Cloud managed instances. |
| DescribeActivations | DescribeActivations | Queries existing activation codes and their usage information. |
| DisableActivation | DisableActivation | Disables an activation code. |
| DeleteActivation | DeleteActivation | Deletes an unused activation code. |
| DescribeManagedInstances | DescribeManagedInstances | Queries managed instances. |
| ModifyManagedInstance | ModifyManagedInstance | Modifies the information about a managed instance. |
| DeregisterManagedInstance | DeregisterManagedInstance | Deregisters a managed instance. After you deregister the managed instance, you can no longer use Cloud Assistant to send commands or files to the instance. |
| ListPluginStatus | ListPluginStatus | Queries the states of Cloud Assistant plug-ins on Elastic Compute Service (ECS) instances. |
HPC clusters
| API | Title | Description |
|---|---|---|
| CreateHpcCluster | CreateHpcCluster | Creates a high performance computing (HPC) cluster. |
| DescribeHpcClusters | DescribeHpcClusters | Queries 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. |
| ModifyHpcClusterAttribute | ModifyHpcClusterAttribute | You can call this operation to modify the description of an Alibaba Cloud HPC (HPC) cluster. |
| DeleteHpcCluster | DeleteHpcCluster | You can call this operation to delete an HPC cluster. |
Tags and ResourceGroup
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Creates and adds tags to specified Elastic Compute Service (ECS) resources. |
| ListTagResources | ListTagResources | Queries the tags that are added to one or more Elastic Compute Service (ECS) resources. |
| UntagResources | UntagResources | Removes tags from Elastic Compute Service (ECS) resources. After a tag is removed from a resource, the tag is automatically deleted if it is not added to other resources. |
| JoinResourceGroup | JoinResourceGroup | Adds an Elastic Compute Service (ECS) resource or service to a resource group. |
Regions
| API | Title | Description |
|---|---|---|
| DescribeRegions | DescribeRegions | Queries available Alibaba Cloud regions. |
| DescribeZones | DescribeZones | Queries the zones in a specific region. |
| DescribeAvailableResource | DescribeAvailableResource | Queries the availability status of resources in zones. You can query the availability status of resources in a zone before you create Elastic Compute Service (ECS) instances by calling the RunInstances operation or before you change instance types by calling the ModifyInstanceSpec operation. |
| DescribeAccountAttributes | DescribeAccountAttributes | Queries 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. |
| DescribeResourcesModification | DescribeResourcesModification | Queries available instance types or system disk categories in a specific zone before you change the instance type or system disk category of an Elastic Compute Service (ECS) instance. |
| DescribeRecommendInstanceType | DescribeRecommendInstanceType | Queries alternative instance types of an instance type. This operation is in internal preview. This operation lists all alternative instance types of an instance type that has been or is planed to be retired. |
Inquiry
| API | Title | Description |
|---|---|---|
| DescribePrice | DescribePrice | Queries information about the most recent prices of Elastic Compute Service (ECS) resources, such as the promotion rules, prices, and discounts. When you call this operation, you can specify parameters, such as ResourceType, ImageId, and InstanceType, in the request. |
| DescribeRenewalPrice | DescribeRenewalPrice | Queries the renewal price of a subscription Elastic Compute Service (ECS) resource. Renewal prices of only subscription resources can be queried. |
| DescribeInstanceModificationPrice | DescribeInstanceModificationPrice | Queries 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
| API | Title | Description |
|---|---|---|
| DescribeTasks | DescribeTasks | Queries the progress of one or more asynchronous requests. |
| DescribeTaskAttribute | DescribeTaskAttribute | You 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. |
| CancelTask | CancelTask | Cancels a running task. You can cancel the running tasks generated by the ImportImage or ExportImage operation. |
| API | Title | Description |
|---|---|---|
| DescribeDiskDefaultKMSKeyId | DescribeDiskDefaultKMSKeyId | Queries the Key Management Service (KMS) key used by the Account-level Elastic Block Storage (EBS) Default Encryption feature in a region. |
| ResetDiskDefaultKMSKeyId | ResetDiskDefaultKMSKeyId | Resets the Key Management Service (KMS) key used by Account-level Elastic Block Storage (EBS) Default Encryption in a region to the service key. |
| DisableDiskEncryptionByDefault | DisableDiskEncryptionByDefault | Disables account-level default encryption of Elastic Block Storage (EBS) resources in a region. After you disable account-level default encryption of EBS resources in a region, the encryption status of existing disks in the region does not change. When you create a disk, you can still choose to encrypt the disk. |
| ModifyDiskDefaultKMSKeyId | ModifyDiskDefaultKMSKeyId | Changes the Key Management Service (KMS) key used by the Account-level Elastic Block Storage (EBS) Default Encryption feature in a region. |
| DescribeDiskEncryptionByDefaultStatus | DescribeDiskEncryptionByDefaultStatus | Queries whether account-level default encryption of Elastic Block Storage (EBS) resources is enabled in a region. |
| EnableDiskEncryptionByDefault | EnableDiskEncryptionByDefault | Enables the Account-level Elastic Block Storage (EBS) Default Encryption feature in a region. |