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
API | Title | Description |
---|---|---|
RunInstances | RunInstances | Creates pay-as-you-go or subscription Elastic Compute Service (ECS) instances. |
CreateInstance | CreateInstance | Creates a subscription or pay-as-you-go Elastic Compute Service (ECS) instance. |
StartInstance | StartInstance | Starts an Elastic Compute Service (ECS) instance. After the operation is called, the instance enters the Starting state. |
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 the operation is called, the state of the instance changes to Stopping and then to Stopped. |
StopInstances | StopInstances | Stops Elastic Compute Service (ECS) instances. After the operation is called, the state of the instances changes to Stopping and then to Stopped. |
RebootInstance | RebootInstance | Restarts an Elastic Compute Service (ECS) instance that is in the Running state. |
RebootInstances | RebootInstances | Restarts Elastic Compute Service (ECS) instances. After this API operation is called, the ECS instances enter the Stopping state and then the Running state. |
AttachInstanceRamRole | AttachInstanceRamRole | Attaches 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. |
DescribeInstanceRamRole | DescribeInstanceRamRole | Queries the instance RAM roles that are attached to Elastic Compute Service (ECS) instances. |
DetachInstanceRamRole | DetachInstanceRamRole | Detaches an instance RAM role from one or more ECS instances. |
DescribeInstanceStatus | DescribeInstanceStatus | Queries the status information of multiple Elastic Compute Service (ECS) instances. |
DescribeInstances | DescribeInstances | Queries the details of one or more Elastic Compute Service (ECS) instances. |
DescribeInstanceVncUrl | DescribeInstanceVncUrl | Queries the Virtual Network Computing (VNC) logon address of an Elastic Compute Service (ECS) instance. |
ModifyInstanceVncPasswd | ModifyInstanceVncPasswd | Modifies the Virtual Network Computing (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 status of subscription Elastic Compute Service (ECS) instances. |
ModifyInstanceAutoRenewAttribute | ModifyInstanceAutoRenewAttribute | Configures auto-renewal for one or more subscription instances. To reduce maintenance workloads after subscription instances expire, you can configure auto-renewal for the instances. |
RenewInstance | RenewInstance | Renews a subscription Elastic Compute Service (ECS) instance. |
DescribeSpotPriceHistory | DescribeSpotPriceHistory | Queries the price history of a preemptible instance within the previous 30 days. |
DescribeSpotAdvice | DescribeSpotAdvice | Queries 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. |
DescribeInstanceTypeFamilies | DescribeInstanceTypeFamilies | You can call this operation to query the instance families provided by 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 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. |
ModifyInstanceMetadataOptions | ModifyInstanceMetadataOptions | Modifies the metadata of an Elastic Compute Service (ECS) instance. |
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 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. |
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. |
DescribeInstanceTopology | DescribeInstanceTopology | Queries the topology of the host on which an Elastic Compute Service (ECS) instance resides. |
DeleteInstance | DeleteInstance | Releases a pay-as-you-go instance or an expired subscription Elastic Compute Service (ECS) instance. |
DeleteInstances | DeleteInstances | Releases pay-as-you-go instances or expired subscription instances. |
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 service states of the dedicated hosts, and Elastic Compute Service (ECS) instances that are created on the dedicated hosts. |
DescribeDedicatedHostTypes | DescribeDedicatedHostTypes | You 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. |
ModifyDedicatedHostClusterAttribute | ModifyDedicatedHostClusterAttribute | Modifies the attributes of a dedicated host cluster, such as its name and description. |
ModifyDedicatedHostAttribute | ModifyDedicatedHostAttribute | Modifies some properties of 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 states of one or more subscription dedicated hosts. |
ModifyDedicatedHostAutoRenewAttribute | ModifyDedicatedHostAutoRenewAttribute | Enables or disables auto-renewal for 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 | You can call this operation to create a dedicated host cluster. |
DescribeDedicatedHostClusters | DescribeDedicatedHostClusters | Queries the details of one or more dedicated host clusters. |
Launch templates
API | Title | Description |
---|---|---|
CreateLaunchTemplate | CreateLaunchTemplate | Creates 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. |
DescribeLaunchTemplates | DescribeLaunchTemplates | Queries available launch templates. |
DeleteLaunchTemplate | DeleteLaunchTemplate | Deletes an instance launch template. |
CreateLaunchTemplateVersion | CreateLaunchTemplateVersion | Creates a version for a launch template. |
DescribeLaunchTemplateVersions | DescribeLaunchTemplateVersions | Queries the versions of a launch template. |
ModifyLaunchTemplateDefaultVersion | ModifyLaunchTemplateDefaultVersion | Changes 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. |
DeleteLaunchTemplateVersion | DeleteLaunchTemplateVersion | Deletes a version of an instance launch template. This operation cannot delete the default version of an instance launch template. To delete the default version, you must call the DeleteLaunchTemplate operation to delete the instance launch template and all of its versions. |
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. |
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. |
CreateCapacityReservation | CreateCapacityReservation | Creates a capacity reservation. |
DescribeCapacityReservations | DescribeCapacityReservations | Queries the details of capacity reservations. |
DescribeCapacityReservationInstances | DescribeCapacityReservationInstances | Queries the instances that match a capacity reservation. |
ModifyCapacityReservation | ModifyCapacityReservation | Modifies 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. |
DescribeInstanceAttachmentAttributes | DescribeInstanceAttachmentAttributes | Queries the information about the private pools that Elastic Compute Service (ECS) instances match. |
ModifyInstanceAttachmentAttributes | ModifyInstanceAttachmentAttributes | Modifies the attributes of the private pool of an instance. |
ReleaseCapacityReservation | ReleaseCapacityReservation | Releases a capacity reservation. |
Auto provisioning groups
API | Title | Description |
---|---|---|
CreateAutoProvisioningGroup | CreateAutoProvisioningGroup | Creates an auto provisioning group. |
DescribeAutoProvisioningGroups | DescribeAutoProvisioningGroups | Queries information of 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. |
Elastic Block Storage (EBS) devices
API | Title | Description |
---|---|---|
CreateDisk | CreateDisk | Creates a pay-as-you-go or subscription data disk. |
DescribeDisks | DescribeDisks | Queries one or more block storage devices that you created, including cloud disks and local 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 one or more block storage devices (disks). The attributes include names, descriptions, and whether the attributes are released together with the associated instances. |
ReplaceSystemDisk | ReplaceSystemDisk | Replaces 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. |
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 a specific point in time based on a snapshot of the disk. |
ModifyDiskChargeType | ModifyDiskChargeType | Changes 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. |
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. Reserved instances can be automatically matched to pay-as-you-go instances to offset the fees of the pay-as-you-go instances. |
DescribeReservedInstances | DescribeReservedInstances | Queries purchased reserved instances. |
ModifyReservedInstances | ModifyReservedInstances | Splits, 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. |
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 created 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 disks of ECS instances 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. |
ModifyImageAttribute | ModifyImageAttribute | Modifies the name, description, status, or image family of a custom image. |
ModifyImageSharePermission | ModifyImageSharePermission | Manages the sharing of a custom image. |
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. |
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 details of one or more image components. |
DescribeImagePipelines | DescribeImagePipelines | Queries the details of 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 normal snapshot from one region to another. |
DescribeSnapshots | DescribeSnapshots | Queries all the snapshots of an Elastic Compute Service (ECS) instance or a disk. |
DescribeSnapshotsUsage | DescribeSnapshotsUsage | You can call this operation to query the number of snapshots 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 within 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. These policies can be applied to both system disks and data disks. |
DescribeAutoSnapshotPolicyEx | DescribeAutoSnapshotPolicyEx | Queries existing automatic snapshot policies in a region. |
ModifyAutoSnapshotPolicyEx | ModifyAutoSnapshotPolicyEx | The operation that you want to perform. Set the value to \*\*ModifyAutoSnapshotPolicyEx\*\*. |
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 cloud disks of an Elastic Compute Service (ECS) instance. A snapshot-consistent group contains snapshots of one or more cloud disks. |
DescribeSnapshotGroups | DescribeSnapshotGroups | Queries the information of one or more snapshot-consistent groups. |
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 about security groups. |
DescribeSecurityGroupAttribute | DescribeSecurityGroupAttribute | Queries the rules of a security group. |
ModifySecurityGroupPolicy | ModifySecurityGroupPolicy | Modifies the internal access control policy of a basic security group. The internal access control policies of advanced security groups cannot be modified. |
ModifySecurityGroupAttribute | ModifySecurityGroupAttribute | Modifies the name or description of a security group. |
ModifySecurityGroupRule | ModifySecurityGroupRule | Modifies 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. |
ModifySecurityGroupEgressRule | ModifySecurityGroupEgressRule | Modifies 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. |
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 instances in the security group to other objects. |
JoinSecurityGroup | JoinSecurityGroup | Adds an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) to a security group. |
LeaveSecurityGroup | LeaveSecurityGroup | Removes an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) from a security group. |
DescribeSecurityGroupReferences | DescribeSecurityGroupReferences | Checks whether a security group is referenced by the rules of other security groups. |
RevokeSecurityGroup | RevokeSecurityGroup | Deletes one or more inbound security group rules. |
RevokeSecurityGroupEgress | RevokeSecurityGroupEgress | Deletes outbound security group rules. |
DeleteSecurityGroup | DeleteSecurityGroup | Deletes a security group. |
Deployment sets
API | Title | Description |
---|---|---|
CreateDeploymentSet | CreateDeploymentSet | Creates a deployment set in a specific region. |
DescribeDeploymentSetSupportedInstanceTypeFamily | DescribeDeploymentSetSupportedInstanceTypeFamily | Queries the instance families that support deployment sets. |
DescribeDeploymentSets | DescribeDeploymentSets | Queries the attributes of one or more deployment sets. |
ModifyDeploymentSetAttribute | ModifyDeploymentSetAttribute | You can call this operation to modify the name and description of a deployment set. |
DeleteDeploymentSet | DeleteDeploymentSet | You can call this operation to delete a deployment set. |
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 are responsible for storing the private key and ensuring 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 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. |
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 one or more 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). |
AttachNetworkInterface | AttachNetworkInterface | Attaches an elastic network interface (ENI) to an Elastic Compute Service (ECS) instance that resides in a virtual private cloud (VPC). |
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). |
DescribeNetworkInterfaceAttribute | DescribeNetworkInterfaceAttribute | Queries the details of an elastic network interface (ENI). |
ModifyNetworkInterfaceAttribute | ModifyNetworkInterfaceAttribute | Modifies the attributes, such as the name, description, and security group of an elastic network interface (ENI). |
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 hosts the ENI. Alternatively, you can specify the number of private IP addresses for Elastic Compute Service (ECS) to automatically assign them. |
UnassignPrivateIpAddresses | UnassignPrivateIpAddresses | Unassigns one or more 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 | Unassign one or more IPv6 addresses from an elastic network interface (ENI). |
DeleteNetworkInterface | DeleteNetworkInterface | Deletes an elastic network interface (ENI). |
System events
API | Title | Description |
---|---|---|
DescribeInstancesFullStatus | DescribeInstancesFullStatus | Queries 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. |
DescribeDisksFullStatus | DescribeDisksFullStatus | Queries the full status information about one or more Elastic Block Storage (EBS) devices. |
DescribeInstanceHistoryEvents | DescribeInstanceHistoryEvents | Queries historical system events that are inactive. |
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 | Accepts the default operation for a system event in the Inquiring state and authorizes the system to perform the default operation. |
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. |
DescribeInstanceMonitorData | DescribeInstanceMonitorData | Queries the monitoring data of an Elastic Compute Service (ECS) instance. The monitoring data includes the vCPU utilization, CPU credits of the burstable instance, received data traffic, 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 within 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 Elastic Compute Service (ECS) instance when you receive an event notification for the instance. |
ReportInstancesStatus | ReportInstancesStatus | Reports the same exception on multiple Elastic Compute Service (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 Elastic Compute Service (ECS) instances. |
CreateCommand | CreateCommand | Creates a Cloud Assistant command. |
InvokeCommand | InvokeCommand | Triggers a Cloud Assistant command on one or more Elastic Compute Service (ECS) instances. |
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 command that is run on schedule. |
StopInvocation | StopInvocation | Stops the process of a Cloud Assistant command that is running on one or more Elastic Compute Service (ECS) instances. |
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 and content of a Cloud Assistant command. |
DeleteCommand | DeleteCommand | Deletes a Cloud Assistant command. |
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 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. |
InstallCloudAssistant | InstallCloudAssistant | Installs 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. |
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. |
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 a list of 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 | |
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 of resources in a zone. You can call this operation before you create or modify instances to ensure that sufficient resources are available. |
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 resources within a specific zone when you upgrade or downgrade instance types or replace system disks. |
DescribeRecommendInstanceType | DescribeRecommendInstanceType | Queries alternative instance types for an instance type. |
Inquiry
API | Title | Description |
---|---|---|
DescribePrice | DescribePrice | Queries the most recent prices of Elastic Compute Resource (ECS) resources. |
DescribeRenewalPrice | DescribeRenewalPrice | Queries the renewal price of a subscription Elastic Compute Service (ECS) resource. Only the renewal prices of 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. |