API standards and multilingual preset SDKs
The OpenAPI of this product (Ecs/2014-05-26) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Region
|
API |
Title |
Description |
| DescribeRegions | Query regions | Queries a list of regions based on parameters such as billing method and resource type. |
| DescribeZones | Query zones | Queries the list of zones based on parameter query conditions such as region ID and billing method. |
| DescribeAvailableResource | Query resource inventory in a zone | Queries the inventory status of resources in a specified zone. This operation is primarily used to check whether target resources (such as instance types and system disk types) are sufficiently stocked in a specific zone before you create instances (RunInstances) or modify instance specifications (ModifyInstanceSpec). |
| DescribeAccountAttributes | Query resource quotas | Queries the resource quotas that you can create in an Alibaba Cloud region. The quotas include the maximum numbers of security groups, Elastic Network Interfaces (ENIs), pay-as-you-go instance vCPUs, spot instance vCPUs, pay-as-you-go cloud disk capacity, dedicated hosts, network interface controllers (NICs), network types, and whether the account has completed real-name registration. |
| DescribeResourcesModification | Query resource inventory before changing instance type or system disk type | Queries the inventory of instance types or system disk types in a zone before you change the instance type or system disk type of an instance. |
| DescribeRecommendInstanceType | Find alternative instance types | (Beta) Queries one or more alternative instance types based on a specified instance type. For retired or soon-to-be-retired instance types, DescribeRecommendInstanceType lists all instance types that can serve as replacements. |
Price inquiry
|
API |
Title |
Description |
| DescribePrice | Query prices | Queries the latest prices of specified resources. You can query the latest prices of ECS instances, disks, dedicated hosts, elasticity assurance services, and capacity reservation services based on resource types. The prices include information such as campaign rules, prices, and discounts. |
| DescribeRenewalPrice | Query resource renewal price | Queries the renewal price of Elastic Compute Service (ECS) resources. Only subscription resources are supported. |
| DescribeInstanceModificationPrice | Query pricing for upgrading an unexpired subscription ECS instance | Queries the pricing information of the target instance type and new subscription data disks when you upgrade an unexpired subscription ECS instance. |
Instance
|
API |
Title |
Description |
| RunInstances | Create instances in a batch | Creates multiple ECS instances in a batch, with support for automatic startup, public IP address assignment, and automatic release time configuration. |
| CreateInstance | Creates an instance. | Creates a subscription or pay-as-you-go ECS instance. You can use this operation to configure various parameters based on your requirements to create a customized instance. |
| StartInstance | Start an instance | Starts an ECS instance. You can start an instance by specifying the instance ID and optionally setting parameters such as InitLocalDisk. |
| StartInstances | Start instances in a batch | Starts multiple ECS instances in a batch. You can specify parameters to select different batch operation modes for flexible startup. |
| StopInstance | Stop an instance | Stops an ECS instance. You can choose different shutdown methods, stop modes, and batch operation modes to stop the instance. |
| StopInstances | Stop instances in batches | Stops one or more ECS instances. You can specify different stop methods, stop modes, and batch operation modes. |
| RebootInstance | Restart an instance | Restarts an ECS instance. |
| RebootInstances | Restarts multiple instances at a time. | Restarts one or more ECS instances. You can specify whether to force restart instances and set different batch operation modes. |
| DeleteInstance | Delete an instance | Deletes or releases a specified ECS instance. |
| DeleteInstances | Release instances in a batch | Releases multiple pay-as-you-go instances or expired subscription instances in a batch. You can specify whether to release or convert associated disks to pay-as-you-go disks. |
| DescribeInstanceStatus | Query instance status information | Queries the status information of one or more specified ECS instances and supports querying instance lists based on specified conditions. |
| DescribeInstances | Query detailed information about instances | Queries a list of instances based on specified request conditions and retrieves the associated detailed information of the instances. |
| DescribeInstanceTypeFamilies | Query instance families | Queries the list of instance families provided by Alibaba Cloud ECS. This operation retrieves instance family information across different series to help you understand available instance type resources and select appropriate instance types for creating ECS instances. |
| DescribeInstanceTypes | Query instance type information | Queries the information list of all instance types provided by Elastic Compute Service (ECS) and retrieves the detailed information of instance types. You can also perform a conditional query for information about specific instance types to understand the configurations and performance of different instance types and select instance types that meet your business requirements. |
| DescribeInstanceAttribute | Query instance attribute information | Queries the attribute information of a specified ECS instance. |
| ModifyInstanceAttribute | Modify instance attributes | Modifies some properties of an ECS instance, such as the password, instance name, hostname, security groups, MTU, and instance user data. |
| ModifyInstanceClockOptions | Modify instance clock options | Modifies the clock options of an instance as needed. |
| ModifyInstanceNetworkOptions | Modify instance network options | Modifies the network options of an instance. |
| ModifyInstanceChargeType | Modify instance billing method | Modifies the billing method of ECS instances. Batch modification is supported. |
| ModifyInstanceSpec | Modify the instance type or public bandwidth of an instance | Modifies the instance type or public bandwidth of a pay-as-you-go ECS instance. |
| ModifyPrepayInstanceSpec | Modify the instance type of a subscription instance | Modifies the instance type of a subscription ECS instance, allowing you to upgrade or downgrade the instance type. The modification takes effect for the entire lifecycle of the instance. |
| ModifyInstanceAutoReleaseTime | Modify the automatic release time of an instance | Modifies the automatic release time of a specified pay-as-you-go or spot instance. You can also use this operation to cancel the automatic release feature. |
| AttachInstanceRamRole | Attach an instance RAM role to instances | Attaches an instance RAM role to one or more ECS instances. |
| DescribeInstanceRamRole | Queries the RAM roles assigned to an instance. | Queries the instance RAM roles that are assigned to one or more ECS instances by instance ID, or queries the instances that are assigned a specific instance RAM role by role name. |
| DetachInstanceRamRole | Detach instance RAM roles from instances | Detaches instance RAM roles from one or more ECS instances. |
| DescribeInstanceVncUrl | Query the VNC logon URL of an instance | Queries the VNC logon URL of an ECS instance. |
| ModifyInstanceVncPasswd | Modify the VNC logon password of an instance | Modifies the VNC logon password of an ECS instance. |
| ModifyInstanceMetadataOptions | Modify instance metadata access settings | Modifies the metadata access settings for an instance in a specified region, including whether to enable the metadata access channel and whether to enable the security hardening mode for metadata access. |
| DescribeUserData | Query instance user data | Queries the user data of an ECS instance. |
| RenewInstance | Renew an instance | Renews a subscription Elastic Compute Service (ECS) instance. You can specify a renewal period or renew the instance to a unified expiration date. |
| DescribeInstanceAutoRenewAttribute | Query auto-renewal attributes of instances | Queries the auto-renewal attributes of one or more subscription ECS instances, including whether auto-renewal is enabled and the renewal period. |
| ModifyInstanceAutoRenewAttribute | Modify the auto-renewal attributes of instances | Modifies the auto-renewal attributes of one or more subscription instances to help reduce the maintenance costs of expiring resources. |
| ReActivateInstances | Reactivate an expired or recycled instance | Restarts a pay-as-you-go ECS instance that has expired or been recycled due to an overdue payment. |
| DescribeSpotPriceHistory | Query historical prices of spot instances | Queries the historical prices of spot instances. You can query price data for up to the last 30 days. The historical price data helps you set a reasonable maximum price for a spot instance. |
| DescribeSpotAdvice | Query average release rate and discount rate of spot instances | Queries the average release rate, average discount rate, and other information about spot instances in a specified region over the last 30 days. |
Image
|
API |
Title |
Description |
| CreateImage | Create a custom image | Creates a custom image. You can use the created custom image to create ECS instances (RunInstances) or replace the system disk of an instance (ReplaceSystemDisk). |
| DescribeImages | Query image resources | Queries the list of image resources available to you by specifying parameters such as ImageId, image usage scenarios, and Filter conditions. |
| ModifyImageAttribute | Modify custom image attributes | Modifies the attributes of a custom image, such as the image family, name, boot mode, status, and NVMe support, by calling the ModifyImageAttribute operation with parameters such as ImageId and ImageFamily. |
| DeleteImage | Delete a custom image | Deletes a custom image. You can specify the ImageId and Force parameters. |
| DescribeImageFromFamily | DescribeImageFromFamily | Queries the latest available image in a specified image family. |
| DescribeImageSupportInstanceTypes | Query instance types supported by a specified image | Queries the instance types supported by a specified image. |
| DescribeImageSharePermission | Query all users with whom a custom image is shared | Queries all users with whom a custom image has been shared. The results are displayed by page, with 10 entries per page by default. |
| ModifyImageSharePermission | Manage image sharing permissions | Manages image sharing permissions. You can share your custom images with other Alibaba Cloud accounts or publish them as community images for others to use. |
| ModifyImageShareGroupPermission | Modify image sharing group permissions | Modifies the permissions of an image sharing group. |
| ImportImage | Import a local image file | Imports a local image file to Elastic Compute Service (ECS) as a custom image that appears in the specified region. You can then use the imported image to create ECS instances (RunInstances) or replace the system disk of an instance (ReplaceSystemDisk). |
| ExportImage | Export a custom image to OSS | Exports a custom image to an OSS bucket in the same region as the custom image. |
| CopyImage | Copy a custom image to another region | Copies a custom image from one region to another region. You can use this operation to deploy ECS instances across regions or replicate ECS instances across regions. |
| CancelCopyImage | Cancel an ongoing image copy task | Cancels an ongoing CopyImage task. |
| CreateImageComponent | Create an image component | Creates an image component. Image components are used to store commonly used build template commands for image building. |
| DescribeImageComponents | Query image component details | Queries the details of one or more image components. |
| DeleteImageComponent | Delete an image component | Deletes an image component by specifying the RegionId and ImageComponentId parameters. |
| CreateImagePipeline | Create an image build template | Creates an image template. Image templates can be used to build images. |
| DescribeImagePipelines | Query image template details | Queries the details of one or more image templates. |
| DeleteImagePipeline | Delete an image template | Deletes an image template. |
| StartImagePipelineExecution | Runs an image build task by using an image template. | Executes an image building task by using an image template. |
| DescribeImagePipelineExecutions | Query details of an image build task | Queries the details of an image build task. |
| CancelImagePipelineExecution | Cancel an image building task | Cancels an image building task. |
Block storage
|
API |
Title |
Description |
| CreateDisk | Create a data disk | Creates a pay-as-you-go or subscription data disk. |
| DescribeDisks | Query block storage | Queries information about one or more created block storage devices, including disks, local disks, and elastic ephemeral disks. |
| AttachDisk | Attach a disk to an instance | Attaches a data disk or system disk to an ECS instance. |
| DetachDisk | Detach a pay-as-you-go data disk or system disk | Detaches a pay-as-you-go data disk or system disk from an ECS instance. |
| ResizeDisk | Expand a disk | Expands the capacity of a disk, including system disks and data disks. |
| ModifyDiskAttribute | Modify block storage attributes | Modifies the name, description, release behavior, automatic snapshot deletion policy, automatic snapshot policy, performance burst settings, and other attributes of one or more block storage devices. |
| ModifyDiskChargeType | Change the billing method of a disk | Converts the billing method of data disks attached to a subscription ECS instance between pay-as-you-go and subscription. |
| ModifyDiskSpec | Change the disk type or performance level | Changes the type of a disk or modifies the performance level (PL) of an enterprise SSD (ESSD). Regional Enterprise SSDs (ESSDs), basic disks, elastic ephemeral disks, and local disks do not support disk type changes. |
| ReplaceSystemDisk | Replace the system disk (replace the operating system) | Replaces the operating system of an ECS instance by replacing its system disk. After the replacement, the disk ID of the system disk changes and the original disk is released. |
| ResetDisk | Roll back a disk by using a snapshot | Rolls back a disk to a previous state by using a disk snapshot. |
| ResetDisks | Batch reset disks | Rolls back one or more cloud disks by using an instance snapshot. |
| ReInitDisk | Re-initialize a disk to its initial state | Re-initializes a disk to its initial state when it was created. |
| ModifyDiskDeployment | Migrate a disk | Migrates a disk into or out of a dedicated block storage cluster, or migrates a disk between dedicated block storage clusters. |
| DeleteDisk | Release a pay-as-you-go data disk | Releases a pay-as-you-go data disk. Disk types include basic disks, ultra disks, standard SSDs, and enterprise SSDs. |
| CloneDisks | Clone a disk | Disk cloning allows you to quickly create a new disk with the same data as the source disk in the same zone. The cloned disk supports custom capacity, type, and encryption attributes. After the cloned disk is attached to an instance, you can quickly replicate business data or scale out services. |
| EnableDiskEncryptionByDefault | Enable account-level default encryption for block storage | Enables account-level default encryption for block storage in a specified region. |
| DescribeDiskEncryptionByDefaultStatus | Query the service status of account-level default encryption for block storage | Queries the service status of account-level default encryption for block storage in a specified region. |
| DescribeDiskDefaultKMSKeyId | Query the key used for account-level default encryption of block storage | Queries the key used for account-level default encryption of block storage. |
| ModifyDiskDefaultKMSKeyId | Modify the key used for block storage account-level default encryption | Modifies the KMS key ID used for block storage account-level default encryption in a specified region. |
| ResetDiskDefaultKMSKeyId | Reset the key used for account-level default encryption of block storage | Resets the KMS key ID used for account-level default encryption of block storage in a specified region to the service key. |
| DisableDiskEncryptionByDefault | Disable account-level default encryption for block storage | Disables account-level default encryption for block storage in a specified region. |
Snapshots
|
API |
Title |
Description |
| OpenSnapshotService | Activate the snapshot service | Activates the snapshot service. |
| CreateSnapshot | Create a snapshot | Creates a snapshot for a disk. |
| DescribeSnapshots | Query disk snapshot list | Queries the snapshot list of a disk, including snapshot status, remaining time for a snapshot being created, and automatic snapshot retention days. |
| DescribeSnapshotsUsage | Query snapshot count and size | Queries the number of snapshots and the total snapshot size in a region. |
| ModifySnapshotAttribute | Modify snapshot attributes | Modifies the name, description, or retention period of a snapshot. |
| ModifySnapshotCategory | Modify snapshot type | Modifies the type of a snapshot. You can call this operation to convert a standard snapshot to an archive snapshot. |
| CopySnapshot | Copy a snapshot | Copies a standard snapshot or an encrypted snapshot from one region to another. |
| DeleteSnapshot | Deletes a snapshot. | Deletes a specified snapshot. You can also call this operation to cancel a snapshot that is being created. |
| DescribeSnapshotLinks | Query disk snapshot chains | Queries snapshot chains of disks. A snapshot chain consists of all snapshots of a disk. Each disk corresponds to one snapshot chain. |
| CreateSnapshotGroup | Create a snapshot-consistent group | Creates a snapshot-consistent group for disks in a specified ECS instance. A snapshot-consistent group contains snapshots of one or more disks. |
| DescribeSnapshotGroups | Query snapshot-consistent groups | Queries information about one or more snapshot-consistent groups, such as the status, instance ID, and snapshot creation progress. |
| ModifySnapshotGroup | Modify a snapshot-consistent group | Modifies the name and description of a snapshot-consistent group. |
| DeleteSnapshotGroup | Delete a snapshot-consistent group | Deletes a snapshot-consistent group. |
| CreateAutoSnapshotPolicy | Create an automatic snapshot policy | Creates an automatic snapshot policy in a specified region. You can specify the repeat cycle, retention period, and cross-region backup settings for automatic snapshots to back up data on system disks or data disks. |
| DescribeAutoSnapshotPolicyEx | Query automatic snapshot policies | Queries the details of automatic snapshot policies that are created in a specified region. |
| DescribeAutoSnapshotPolicyAssociations | Query automatic snapshot policy associations | Queries the associate relationships of an automatic snapshot policy. |
| ModifyAutoSnapshotPolicyEx | Modify an automatic snapshot policy | Modifies an automatic snapshot policy, such as the snapshot creation time, repeat date, and retention period. |
| ApplyAutoSnapshotPolicy | Apply automatic snapshot policy to cloud disks | Applies an automatic snapshot policy to one or more cloud disks. |
| CancelAutoSnapshotPolicy | Cancel the automatic snapshot policy for cloud disks | Cancels the automatic snapshot policy for one or more cloud disks. |
| DeleteAutoSnapshotPolicy | Delete an automatic snapshot policy | Deletes an automatic snapshot policy. If the target automatic snapshot policy has been applied to cloud disks, the cloud disks no longer execute the policy after it is deleted. |
| LockSnapshot | Locks a snapshot | Locks a snapshot in compliance mode to prevent the snapshot from being accidentally or maliciously deleted. During the lock period, no user can delete the snapshot. |
| DescribeLockedSnapshots | Query snapshot lock information | Queries the lock information of snapshots, such as the lock status and lock configurations. |
| UnlockSnapshot | Unlock a snapshot | Unlocks a snapshot that is locked in compliance mode but is still within the cooling-off period. If the snapshot is locked in compliance mode and the cooling-off period has ended, the snapshot cannot be unlocked. |
Networking
|
API |
Title |
Description |
| DescribeBandwidthLimitation | Query public bandwidth limits for different instance types | Queries the maximum public bandwidth that can be purchased, upgraded, or downgraded for different instance types. |
| ModifyInstanceNetworkSpec | Modify ECS instance bandwidth or assign a public IP address | Modifies the bandwidth configuration of an ECS instance, allocates a public IP address, converts the network billing method. Both upgrades and downgrades are supported. |
| AllocatePublicIpAddress | Assign a public IP address | Assigns a public IP address to an ECS instance. We recommend that you call the ModifyInstanceNetworkSpec operation to assign a public IP address. |
| ConvertNatPublicIpToEip | Convert a public IP address to an elastic IP address | Converts the public IP address (PublicIP) of a VPC-type ECS instance to an Elastic IP Address (EIP). |
| ModifyInstanceVpcAttribute | Modify the VPC attributes of an instance | Modifies the VPC, private IP address, security group, or vSwitch of a VPC-type ECS instance. |
| DescribeClassicLinkInstances | Query classic network type instances connected to a VPC | Queries one or more classic network type instances that are connected to a virtual private cloud (VPC). |
| AttachClassicLinkVpc | Connect a classic network-type instance to a VPC | Invokes AttachClassicLinkVpc to connect a classic network type instance to a virtual private cloud (VPC) so that the instance can communicate with cloud resources in the VPC through private network peering. |
| DetachClassicLinkVpc | Disconnect a classic network-type instance from a VPC | Invokes DetachClassicLinkVpc to disconnect a classic network type ECS instance from a virtual private cloud (VPC) by removing the ClassicLink connection. After the ClassicLink connection is removed, the classic network type instance cannot communicate with instances in the VPC. |
Elastic network interfaces
|
API |
Title |
Description |
| CreateNetworkInterface | Create an ENI | Creates an Elastic Network Interface (ENI) with support for specifying a primary private IP address. |
| DescribeNetworkInterfaces | Query ENI list | Queries the details of one or more Elastic Network Interfaces (ENIs). |
| DescribeNetworkInterfaceAttribute | Query ENI attributes | Queries the details of an Elastic Network Interface (ENI) by ENI ID. |
| ModifyNetworkInterfaceAttribute | Modify ENI attributes | Modifies the attributes of an Elastic Network Interface (ENI), such as the queue number, associated security groups, queue depth, communication mode, and whether to retain the ENI when the associated instance is released. |
| DeleteNetworkInterface | Delete an ENI | Asynchronously deletes an Elastic Network Interface (ENI). |
| AttachNetworkInterface | Attach an ENI to a VPC-type instance | Attaches an Elastic Network Interface (ENI) to a VPC-type ECS instance by calling the AttachNetworkInterface operation with parameters such as NetworkInterfaceId, InstanceId, and NetworkCardIndex. |
| DetachNetworkInterface | Detach an ENI from an instance | Detaches an Elastic Network Interface (ENI) from an ECS instance. |
| AssignPrivateIpAddresses | Assign secondary private IP addresses to an ENI | Assigns one or more secondary private IP addresses to an elastic network interfaces (ENIs). You can specify idle private IP addresses from the vSwitch to which the elastic network interfaces (ENIs) belongs, or specify the number of private IP addresses to automatically allocate. |
| UnassignPrivateIpAddresses | Remove secondary private IP addresses from an ENI | Removes one or more secondary private IP addresses from an Elastic Network Interface (ENI). |
| AssignIpv6Addresses | Allocate IPv6 addresses to an ENI | Allocates one or more IPv6 addresses to an elastic network interface (ENI). |
| UnassignIpv6Addresses | Revoke IPv6 addresses from an ENI | Revokes one or more IPv6 addresses from a network interface controller (NIC). |
| CreateNetworkInterfacePermission | Grant NIC permissions to a certified ISV or individual user | Grants Elastic Network Interface (ENI) permissions to an Alibaba Cloud partner (certified ISV) or an individual user. |
| DescribeNetworkInterfacePermissions | Query ENI permissions granted to certified ISVs or individual users | Queries the list of Elastic Network Interface (ENI) permissions that you have granted to an Alibaba Cloud partner (certified ISV) or an individual user. |
Prefix lists
|
API |
Title |
Description |
| CreatePrefixList | CreatePrefixList | Creates a prefix list. |
| DescribePrefixLists | Query prefix lists | Queries information about one or more prefix lists. |
| DescribePrefixListAttributes | Query details of a prefix list | Queries the details of a specified prefix list, including the name, address family, maximum number of entries, and entry details. |
| DescribePrefixListAssociations | Query resources associated with a prefix list | Queries the information about resources associated with a specified prefix list, such as resource IDs and resource types. |
| ModifyPrefixList | Modify prefix list attributes | Modifies the name, description, and other attributes of a specified prefix list, and supports adding, modifying, and deleting entries. |
| DeletePrefixList | Delete a prefix list | Deletes a specified prefix list and all entries in the prefix list. |
Port lists
|
API |
Title |
Description |
| CreatePortRangeList | Create a port list | Creates a port list that can be associated with resources such as security groups. |
| DescribePortRangeLists | Query port range lists | Queries a list of port range lists. |
| DescribePortRangeListEntries | Query entries of a port range list | Queries the entries of a specified port range list. |
| DescribePortRangeListAssociations | Queries the resources associated with a port list. | Queries the resources associated with a specified port range list, such as security groups. |
| ModifyPortRangeList | Modify port range list attributes | Modifies the name and entries of a specified port range list. You can add, modify, and delete entries. |
| DeletePortRangeList | Delete a port list | Deletes a specified port list. All port list entries in the port list are also deleted. |
Security groups
|
API |
Title |
Description |
| CreateSecurityGroup | Create a security group | Creates a security group. |
| DescribeSecurityGroups | Query basic information about security groups | Queries the basic information about security groups. You can filter results by region, security group ID, security group type, and other parameter query conditions. |
| DescribeSecurityGroupAttribute | Query a security group and its rules | Queries the details of a specified security group, including the list of security group rules. |
| ModifySecurityGroupPolicy | Modify the intra-group connectivity policy of a basic security group | Modifies the intra-group connectivity policy of a basic security group. |
| ModifySecurityGroupAttribute | Modify the name or description of a security group | Modifies the name or description of a specified security group. |
| DeleteSecurityGroup | Delete a security group | Deletes a security group and all security group rules within it. |
| AuthorizeSecurityGroup | Add inbound security group rules | Adds one or more inbound rules to a security group. You can use this operation to specify inbound access permissions for a security group, allowing or denying other devices from sending inbound traffic to instances in the security group, which enables fine-grained network access control. |
| ModifySecurityGroupRule | Modify an inbound security group rule | Modifies an inbound security group rule of a specified security group. |
| RevokeSecurityGroup | Delete inbound security group rules | Deletes one or more inbound security group rules from a specified security group. |
| AuthorizeSecurityGroupEgress | Add outbound security group rules | Adds one or more outbound rules to a security group. This operation allows you to specify outbound access permissions for a security group to allow or deny instances in the security group from sending outbound traffic to other devices, enabling fine-grained control over network access. |
| ModifySecurityGroupEgressRule | Modify an outbound security group rule | Modifies an outbound security group rule. |
| RevokeSecurityGroupEgress | Delete outbound security group rules | Deletes one or more outbound security group rules from a specified security group. |
| DescribeSecurityGroupReferences | Query authorized security group list | Queries the list of other security groups that have been authorized by one or more specified security groups. |
| JoinSecurityGroup | Join a security group | Adds an ECS instance or an Elastic Network Interface (ENI) to a specified security group. |
| LeaveSecurityGroup | Remove from a security group | Removes an ECS instance or an Elastic Network Interface (ENI) from a specified security group. |
Key pairs
|
API |
Title |
Description |
| CreateKeyPair | Create a key pair | Calls CreateKeyPair to create an SSH key pair. The system stores the public key and returns the private key in unencrypted PEM-encoded PKCS#8 format. You must securely store the private key on your own. |
| ImportKeyPair | Import the public key of a key pair | Imports the public key of an RSA key pair generated by another tool. After you import the key pair, Alibaba Cloud stores the public key. You must store the private key on your own. |
| DescribeKeyPairs | Query key pairs | Queries one or more SSH key pairs. |
| AttachKeyPair | Attach an SSH key pair to linux instances | Attaches an SSH key pair to one or more Linux instances. |
| DetachKeyPair | Unbind SSH key pairs from linux instances | Unbinds SSH key pairs from one or more Linux instances. |
| DeleteKeyPairs | Batch delete key pairs | Deletes one or more SSH key pairs. |
Launch templates
|
API |
Title |
Description |
| CreateLaunchTemplate | Create a launch template | Creates an ECS instance launch template. A launch template eliminates the need to configure a large number of parameters every time you create an instance. |
| DescribeLaunchTemplates | Query one or more available launch templates | Calls the DescribeLaunchTemplates operation to query information about one or more launch templates. You can specify parameters such as TemplateTag, TemplateResourceGroupId, and LaunchTemplateId. The returned information includes the total number of launch templates, template creation time, and latest template version number. |
| DeleteLaunchTemplate | Delete a launch template | Deletes a launch template in a specified region by specifying the LaunchTemplateId or LaunchTemplateName parameter. |
| CreateLaunchTemplateVersion | Create a new version of a launch template | Creates a new version of a specified ECS launch template for subsequent creation of ECS instances, elastic scaling groups, or auto provisioning groups. |
| DescribeLaunchTemplateVersions | Query launch template version information | Queries information about ECS instance launch template versions, such as the total number of instance launch templates, template names, and template version numbers. |
| ModifyLaunchTemplateDefaultVersion | Switch the default version of a launch template | Calls the ModifyLaunchTemplateDefaultVersion operation to switch the default version of a launch template by specifying the DefaultVersionNumber parameter. If you do not specify a template version number when you create an instance by calling the RunInstances operation, the default version is used. |
| DeleteLaunchTemplateVersion | Delete launch template versions | Deletes one or more versions of a specified launch template by specifying parameters such as LaunchTemplateId and DeleteVersion. |
The auto provisioning group
|
API |
Title |
Description |
| CreateAutoProvisioningGroup | Create an auto provisioning group | Creates an auto provisioning group. |
| DescribeAutoProvisioningGroups | Query auto-provisioning groups | Queries one or more auto-provisioning groups. |
| DescribeAutoProvisioningGroupInstances | Query instances in an auto-provisioning group | Queries the instances in an auto-provisioning group. |
| ModifyAutoProvisioningGroup | Modify the configurations of an auto provisioning group | Modifies the configurations of an auto provisioning group. |
| DescribeAutoProvisioningGroupHistory | Query scheduling node information of an auto provisioning group | Invokes the DescribeAutoProvisioningGroupHistory operation to query the scheduling node information of an auto provisioning group. |
| DeleteAutoProvisioningGroup | Delete an auto provisioning group | Deletes an auto provisioning group by specifying the AutoProvisioningGroupId and TerminateInstances parameters. |
Deployment sets
|
API |
Title |
Description |
| CreateDeploymentSet | Create a deployment set in a specified region | Creates a deployment set in a specified region. |
| DescribeDeploymentSetSupportedInstanceTypeFamily | Query instance families that support deployment sets | Calls DescribeDeploymentSetSupportedInstanceTypeFamily to query the instance families that support each deployment set strategy by specifying the RegionId and Strategy parameters. |
| DescribeDeploymentSets | Query deployment set attributes | Queries the details of one or more deployment sets. |
| ModifyInstanceDeployment | Modify instance deployment set | Modifies the deployment set of an ECS instance or migrates an ECS instance to a dedicated host. You can also change the instance type while migrating the instance. |
| ModifyDeploymentSetAttribute | Modify the name and description of a deployment set | Modifies the name and description of a deployment set. |
| DeleteDeploymentSet | Delete a deployment set | Deletes a deployment set. |
Resource assurance
|
API |
Title |
Description |
| CreateElasticityAssurance | Creates an elasticity assurance. | Creates an elasticity assurance service by specifying parameters such as the zone, instance type, purchase duration, and auto-renewal settings within the region of the elasticity assurance service. |
| DescribeElasticityAssurances | Query elasticity assurance information | Queries the details of an elasticity assurance. For example, you can query the status, match mode, effective mode, expiration time, and number of used instances of an elasticity assurance. |
| DescribeElasticityAssuranceInstances | Query instances matched to an elasticity assurance | Queries the list of running instances that are matched to an elasticity assurance. |
| ModifyElasticityAssurance | Modify elasticity assurance information | Modifies some information about an elasticity assurance, including its name, description, and capacity (only capacity reduction is supported). |
| RenewElasticityAssurances | Renew elasticity assurance services | Renews one or more purchased elasticity assurance services. |
| ModifyElasticityAssuranceAutoRenewAttribute | Modify auto-renewal of elasticity assurance services | Modifies the auto-renewal attributes of one or more elasticity assurance services. |
| DescribeElasticityAssuranceAutoRenewAttribute | Query auto-renewal of elasticity assurance services | Queries the auto-renewal attributes of one or more elasticity assurance services. |
| CreateCapacityReservation | Create a capacity reservation | Creates a capacity reservation by specifying the instance type, total quantity, effective mode, and zone. |
| DescribeCapacityReservations | Query capacity reservation information | Queries the details of one or more capacity reservations, such as the status, effective and expiration time, private pool mode, and number of consumed instances. |
| DescribeCapacityReservationInstances | Query instances matched by a capacity reservation | Queries the list of instances that match a capacity reservation. |
| ModifyCapacityReservation | Modify partial information of a capacity reservation | Modifies partial information of a capacity reservation, including the name, description, expiration method, and total number of reserved instances. |
| DescribeInstanceAttachmentAttributes | Query private pool information matched by instances | Queries the private pool information matched by instances, such as the matching mode and private pool ID. |
| ModifyInstanceAttachmentAttributes | Modify private pool attributes of an instance | Modifies the private pool matching mode of an instance. |
| ReleaseCapacityReservation | Release a capacity reservation | Releases a capacity reservation. |
Reserved instances
|
API |
Title |
Description |
| PurchaseReservedInstancesOffering | Purchase a reserved instance | Purchases a reserved instance to offset bills of pay-as-you-go instances that match the specified instance type at the regional or zonal level. |
| DescribeReservedInstances | Query reserved instance details | Queries the list of reserved instances that you have purchased in a specified region. You can filter reserved instances by tags, reserved instance attributes, and other parameters. |
| ModifyReservedInstances | Modify reserved instance configurations | Splits, merges, or changes the scope of reserved instances by modifying configurations such as instance type, quantity, and zone. |
| ModifyReservedInstanceAttribute | Modify reserved instance attributes | Modifies the attributes of a reserved instance, including its name and description. |
| RenewReservedInstances | Renew reserved instances | Renews one or more reserved instances. You can specify the purchase duration and auto-renewal attribute during renewal. |
| DescribeReservedInstanceAutoRenewAttribute | Query auto-renewal attributes of reserved instances | Queries the auto-renewal attributes of one or more reserved instances, including the auto-renewal duration and auto-renewal status. |
| ModifyReservedInstanceAutoRenewAttribute | Modify auto-renewal attributes of reserved instances | Modifies the auto-renewal attributes of one or more reserved instances, allowing you to cancel or disable auto-renewal. |
Storage capacity units
|
API |
Title |
Description |
| PurchaseStorageCapacityUnit | Purchase storage capacity units | Purchases one or more storage capacity units (SCUs). |
| DescribeStorageCapacityUnits | Query storage capacity units | Queries the details of storage capacity units (SCUs). You can filter results by name, status, and capacity. |
| ModifyStorageCapacityUnitAttribute | Modify storage capacity unit attributes | Modifies the name or description of a storage capacity unit (SCU). |
Cloud assistant
|
API |
Title |
Description |
| RunCommand | Create and run a Cloud assistant command | Creates and executes a Cloud Assistant command on one or more ECS instances. This operation supports Shell, PowerShell, and Bat scripts, and provides features such as scheduled execution, custom parameters, and command execution in containers on instances. |
| CreateCommand | Creates a Cloud Assistant command. | Creates a Cloud Assistant command of the Shell, PowerShell, or Bat script type. |
| InvokeCommand | Run a Cloud assistant command | Triggers a Cloud Assistant command on one or more ECS instances by specifying parameters such as CommandId, InstanceId, and ResourceGroupId. |
| DescribeInvocations | Query Cloud assistant command execution information | Queries the execution list and status of Cloud Assistant commands. |
| DescribeInvocationResults | Query Cloud assistant command execution results | Queries the execution results of one or more Cloud Assistant commands, which are the actual execution results on ECS instances. |
| ModifyInvocationAttribute | Modify execution attributes of a Cloud assistant command | Modifies the execution information of a Cloud Assistant scheduled task, including the command content, scheduled execution method, and adding ECS instances or managed instances to the task. |
| StopInvocation | Stop a Cloud assistant command | Stops a Cloud Assistant command that is in the Running state on one or more ECS instances. |
| DescribeCommands | Query created Cloud assistant commands | Queries Cloud Assistant commands that you manually created or public commands provided by Alibaba Cloud. |
| ModifyCommand | Modifies a Cloud assistant command | Modifies the parameters of a Cloud Assistant command. |
| DeleteCommand | Delete a Cloud assistant command | Deletes a Cloud Assistant command by specifying the RegionId and CommandId parameters. A command that is being executed cannot be deleted. |
| SendFile | Upload local files to ECS instances | Sends remote files to one or more ECS instances. |
| DescribeSendFileResults | Query Cloud assistant file sending list and status | Queries the list and status of files sent by Cloud Assistant. |
| DescribeCloudAssistantStatus | Query Cloud assistant installation status | Calls DescribeCloudAssistantStatus to query whether Cloud Assistant Agent is installed on one or more instances. If Cloud Assistant is installed, the operation also returns the total number of Cloud Assistant command executions, the number of ongoing executions, and the time of the most recent command execution. |
| InstallCloudAssistant | Install Cloud assistant agent on instances | Installs Cloud Assistant Agent on one or more ECS instances. You must restart the instances to complete the installation of Cloud Assistant Agent. |
| StartTerminalSession | Start a terminal session | Invokes StartTerminalSession to create a session based on the session management feature. You can establish a WebSocket session with an ECS instance by specifying the instance ID. The WebSocketUrl returned by this operation allows you to establish a remote connection to the ECS instance. |
| EndTerminalSession | Close a terminal session | Permanently closes the data connection of a specified session. |
| DescribeTerminalSessions | View session manager session history | Queries the session history of Session Manager. |
| ModifyCloudAssistantSettings | Modify Cloud assistant service configurations | Modifies Cloud Assistant service configurations. |
| DescribeCloudAssistantSettings | Query Cloud assistant service configurations | Queries Cloud Assistant service configurations. |
| CreateActivation | Creates an activation code. | Creates an activation code that is used to register non-Alibaba Cloud servers as Alibaba Cloud managed instances. |
| DescribeActivations | Query activation code usage | Queries the activation codes that have been created and their usage. |
| DisableActivation | Manually disables a specified activation code | Disables a specified activation code. |
| DeleteActivation | Delete an unused activation code | Deletes an unused activation code. |
| DescribeManagedInstances | Query managed instances | Queries a list of managed instances. |
| ModifyManagedInstance | Modify a managed instance | Modifies the information of a managed instance. |
| DeregisterManagedInstance | Unregister a managed instance | Unregisters a managed instance by calling DeregisterManagedInstance. After the instance is unregistered, you can no longer use Cloud Assistant to send commands or files to the instance. |
| ListPluginStatus | Query the status of Cloud assistant plugins on instances | Queries the status of Cloud Assistant plugins on instances. |
System events
|
API |
Title |
Description |
| DescribeInstancesFullStatus | Query full status information of instances | Queries the full status information of one or more ECS instances. The full status information includes the instance status and instance system event status. The instance status refers to the lifecycle status of the instance, and the instance system event refers to the health status of maintenance events. |
| DescribeDisksFullStatus | Query the full status information of one or more block storage devices | Queries the full status information of one or more block storage devices. |
| DescribeInstanceHistoryEvents | Query system events of a specified instance | Queries the system event information of a specified instance by calling the DescribeInstanceHistoryEvents operation. You can specify parameters such as InstanceId and EventType. By default, this operation queries historical system events in inactive states. |
| CreateSimulatedSystemEvents | Schedule simulated system events for instances | Schedules simulated system events for one or more ECS instances. Simulated system events serve as event drills and do not actually execute events or affect ECS instances. |
| CancelSimulatedSystemEvents | Cancel simulated system events | Cancels one or more simulated system events that are in the Scheduled or Executing state. After a system event is canceled, the simulated event enters the Canceled state. |
| AcceptInquiredSystemEvent | Accept and authorize a system event operation | Accepts and authorizes the execution of a system event operation. For a system event in the Inquiring state, this operation accepts the default action of the system event and authorizes the system to execute the default action. |
Resource diagnostics
|
API |
Title |
Description |
| DescribeDiagnosticMetrics | Query the list of diagnostic metrics | Calls DescribeDiagnosticMetrics to query the list of diagnostic metrics. |
| CreateDiagnosticMetricSet | Create a resource diagnostic metric set | Creates a diagnostic metric set for resources. You can flexibly combine diagnostic metrics as needed. |
| DescribeDiagnosticMetricSets | Query the list of resource diagnostic metric sets | Calls DescribeDiagnosticMetricSets to query the list of resource diagnostic metric sets. |
| ModifyDiagnosticMetricSet | Modify a diagnostic metric set | Modifies a diagnostic metric set for resources. |
| DeleteDiagnosticMetricSets | Delete diagnostic metric sets | Deletes diagnostic metric sets for resources. |
| CreateDiagnosticReport | Create a resource diagnostic report | Creates a resource diagnostic report. Based on the diagnostic metric set ID that you specify, a diagnostic report is generated for multiple diagnostic metrics. You can call DescribeDiagnosticReportAttributes with the returned diagnostic report ID to query the details of the resource diagnostic report. |
| DescribeDiagnosticReports | Query resource diagnostic reports | Queries a list of resource diagnostic reports. |
| DescribeDiagnosticReportAttributes | Query resource diagnostic report details | Queries the details of a resource diagnostic report by calling DescribeDiagnosticReportAttributes. |
| DeleteDiagnosticReports | Delete resource diagnostic reports | Deletes resource diagnostic reports. |
O&M and monitoring
|
API |
Title |
Description |
| GetInstanceScreenshot | Retrieve instance screenshot information | Retrieves the screenshot information of an instance. |
| GetInstanceConsoleOutput | Retrieve instance system command line output | Retrieves the system command line output of an instance. The data is returned in Base64-encoded format. |
| DescribeDiskMonitorData | Query cloud disk monitoring data | Queries the usage information of a cloud disk within a specified time period, such as read IOPS, write IOPS, read bandwidth (B/s), write bandwidth (B/s), read latency (μs), and write latency (μs). |
| DescribeInstanceMonitorData | Query instance monitoring data | Queries the monitoring data of an ECS instance. The metrics that you can query include the vCPU utilization, burstable instance credits, inbound data traffic, outbound data traffic, and average bandwidth of the ECS instance. |
| DescribeEniMonitorData | Query secondary ENI monitoring data | Queries the traffic information of a secondary ENI within a specified time range by calling DescribeEniMonitorData. |
| DescribeSnapshotMonitorData | Query snapshot size change monitoring data within the last 30 days | Queries the snapshot size change monitoring data within the last 30 days in a region. |
| DescribeInstanceMaintenanceAttributes | Query maintenance attributes of an instance | Queries the maintenance attributes of an instance. |
| ModifyInstanceMaintenanceAttributes | Modify the maintenance attributes of an instance | Modifies the maintenance attributes of an instance. |
| RedeployInstance | Redeploy an instance | Invokes the RedeployInstance operation to redeploy an ECS instance when the ECS instance receives a system event notification. |
| ReportInstancesStatus | Report anomalous issues for one or more ECS instances | Reports anomalous issues for one or more ECS instances. You can report the same issue that occurs on multiple ECS instances or the same issue that occurs on multiple disks attached to a single ECS instance. |
Tags and resource groups
|
API |
Title |
Description |
| TagResources | Create and bind tags | Creates and binds tags to specified ECS resources in a single operation. |
| ListTagResources | Query tags bound to resources | Queries the tags that are bound to one or more ECS resources. |
| UntagResources | Unbind tags from specified resources | Unbinds tags from specified ECS resources. After a tag is unbound, the tag is automatically deleted if it is not bound to any other resources. |
| JoinResourceGroup | Add an ECS resource or service to a resource group | Adds an ECS resource or service to a resource group. |
Dedicated hosts
|
API |
Title |
Description |
| AllocateDedicatedHosts | Create one or more pay-as-you-go or subscription dedicated hosts | Creates one or more pay-as-you-go or subscription dedicated hosts. A dedicated host is a physical server exclusively used by a single tenant. You can create ECS instances on a dedicated host and view the attributes of the physical server. |
| DescribeDedicatedHosts | Query dedicated host details | Queries the details of one or more dedicated hosts. You can retrieve information such as the physical performance metrics, machine code, usage status, and the list of created ECS instances on the dedicated hosts. You can specify parameters such as dedicated host IDs, dedicated host cluster ID, hostname, and status to precisely query the details of dedicated hosts, providing strong support for efficient management and optimization of cloud computing compute resources. |
| DescribeDedicatedHostTypes | Query dedicated host type details | Invokes DescribeDedicatedHostTypes to query the detailed parameters of dedicated host types supported in a specified region, or queries the ECS instance families supported by dedicated hosts. |
| ModifyDedicatedHostAttribute | Modifies the information of a dedicated host. | Modifies the information about a dedicated host, such as the name, description, and service availability attributes. |
| ModifyDedicatedHostsChargeType | Modify the billing method of dedicated hosts | Modifies the billing method of dedicated hosts. |
| DescribeDedicatedHostAutoRenew | Query auto-renewal status of dedicated hosts | Queries the auto-renewal status of one or more subscription dedicated hosts. |
| ModifyDedicatedHostAutoRenewAttribute | Set or cancel auto-renewal for dedicated hosts | Configures auto-renewal for one or more subscription dedicated hosts, or cancels the auto-renewal that has been configured. |
| RenewDedicatedHosts | Renew one or more subscription dedicated hosts | Renews one or more subscription dedicated hosts. |
| ModifyDedicatedHostAutoReleaseTime | Set the automatic release time for a dedicated host | Sets or cancels the automatic release time for a pay-as-you-go dedicated host. |
| RedeployDedicatedHost | Perform failover migration for a dedicated host | Performs failover migration for a dedicated host. |
| ReleaseDedicatedHost | Release a dedicated host | Releases a pay-as-you-go dedicated host or an expired subscription dedicated host. |
| CreateDedicatedHostCluster | Create a dedicated host cluster | Creates a dedicated host cluster. |
| ModifyDedicatedHostClusterAttribute | Modify dedicated host cluster information | Modifies some information about a dedicated host cluster, including the name, description, and properties of the dedicated host cluster. |
| DescribeDedicatedHostClusters | Query dedicated host cluster details | Queries the details of one or more dedicated host clusters. |
| DeleteDedicatedHostCluster | Delete a dedicated host cluster | Deletes a dedicated host cluster. Before you perform this operation, migrate the dedicated hosts in the dedicated host cluster to another dedicated host cluster. |
High-performance clusters
|
API |
Title |
Description |
| CreateHpcCluster | Create an HPC cluster | Creates an HPC cluster. |
| DescribeHpcClusters | Query HPC clusters | Queries available HPC clusters. The request parameters are used as filters. The filters are evaluated by using a logical AND. The parameters are independent of each other. |
| ModifyHpcClusterAttribute | Modify the description of an HPC cluster | Modifies the description of an HPC cluster. |
| DeleteHpcCluster | Delete an HPC cluster | Deletes an HPC cluster. |
Tasks
|
API |
Title |
Description |
| DescribeTasks | Query tasks | Queries the progress of one or more asynchronous requests. |
| DescribeTaskAttribute | Query task details | Queries the details of an asynchronous task. Currently, the asynchronous tasks that can be queried include ImportImage, ExportImage, and ModifyDiskSpec. |
| CancelTask | Cancel a task | Cancels a running task. You can cancel running image import tasks (ImportImage) and image export tasks (ExportImage). |
Deprecated
|
API |
Title |
Description |
| DescribeUserBusinessBehavior | DescribeUserBusinessBehavior | Retrieves the default attributes at the user level. |
| ModifyUserBusinessBehavior | Modify user business behavior | Sets user-level default attributes. |
| DescribeLimitation | Query resource quota limits | Queries account quota limits. |
| DescribeClusters | Query cluster information | Queries clusters. |
| DeleteNetworkInterfacePermission | DeleteNetworkInterfacePermission | Deletes the permission to operate an Elastic Network Interface (ENI). |
| DeleteBandwidthPackage | DeleteBandwidthPackage | Deletes a bandwidth package. |
| ModifyBandwidthPackageSpec | ModifyBandwidthPackageSpec | Modifies the bandwidth of a bandwidth package. |
| DescribeBandwidthPackages | DescribeBandwidthPackages | Queries bandwidth packages. |
| CreateVSwitch | CreateVSwitch | Creates a vSwitch. |
| DeleteVSwitch | DeleteVSwitch | Deletes a specified VSwitch. |
| ModifyVSwitchAttribute | ModifyVSwitchAttribute | Modifies the attributes of a vSwitch. |
| DescribeVSwitches | DescribeVSwitches | Queries the details of vSwitches. |
| CreatePhysicalConnection | CreatePhysicalConnection | CreatePhysicalConnection. |
| DeletePhysicalConnection | DeletePhysicalConnection | DeletePhysicalConnection. |
| ModifyPhysicalConnectionAttribute | ModifyPhysicalConnectionAttribute | Modifies the attributes of a physical connection. |
| EnablePhysicalConnection | EnablePhysicalConnection | Enables a physical connection. |
| DescribePhysicalConnections | DescribePhysicalConnections | DescribePhysicalConnections. |
| CancelPhysicalConnection | CancelPhysicalConnection | Cancels an application for an Express Connect circuit. You can cancel an Express Connect circuit only when it is in the `Initial` or `Approved` state. |
| TerminatePhysicalConnection | TerminatePhysicalConnection | Terminates a physical connection. |
| CreateVpc | CreateVpc | CreateVpc. |
| DeleteVpc | DeleteVpc | Deletes a VPC. |
| DescribeVpcs | DescribeVpcs | Queries a VPC. |
| ModifyVpcAttribute | ModifyVpcAttribute | Modifies the attributes of a virtual private cloud (VPC). |
| RemoveBandwidthPackageIps | RemoveBandwidthPackageIps | RemoveBandwidthPackageIps |
| CreateHaVip | CreateHaVip | Creates a high-availability virtual IP address (HaVip). |
| DeleteHaVip | DeleteHaVip | Deletes an HaVip instance. |
| AssociateHaVip | AssociateHaVip | Associates a high-availability virtual IP address (HaVip) with an ECS instance or an elastic network interface (ENI). |
| ModifyHaVipAttribute | ModifyHaVipAttribute | Modifies the attributes of a specified HAVIP instance. |
| DescribeHaVips | DescribeHaVips | Queries the details of high-availability virtual IP addresses (HAVIPs). |
| UnassociateHaVip | UnassociateHaVip | Disassociates an HaVip from an ECS instance. |
| CreateVirtualBorderRouter | CreateVirtualBorderRouter | Creates a virtual border router (VBR). |
| DeleteVirtualBorderRouter | DeleteVirtualBorderRouter | Deletes a virtual border router (VBR). |
| ModifyVirtualBorderRouterAttribute | ModifyVirtualBorderRouterAttribute | ModifyVirtualBorderRouterAttribute. |
| RecoverVirtualBorderRouter | RecoverVirtualBorderRouter | RecoverVirtualBorderRouter |
| TerminateVirtualBorderRouter | TerminateVirtualBorderRouter | Terminates a virtual border router (VBR). |
| DescribeVirtualBorderRouters | DescribeVirtualBorderRouters | DescribeVirtualBorderRouters |
| DescribeVirtualBorderRoutersForPhysicalConnection | DescribeVirtualBorderRoutersForPhysicalConnection | DescribeVirtualBorderRoutersForPhysicalConnection. |
| CreateRouterInterface | CreateRouterInterface | CreateRouterInterface. |
| DeleteRouterInterface | DeleteRouterInterface | Deletes a router interface. |
| ActivateRouterInterface | ActivateRouterInterface | Activates a router interface. |
| DeactivateRouterInterface | DeactivateRouterInterface | DeactivateRouterInterface |
| ModifyRouterInterfaceAttribute | ModifyRouterInterfaceAttribute | Modifies the attributes of a router interface. |
| ModifyRouterInterfaceSpec | ModifyRouterInterfaceSpec | Modifies the specification of a router interface. |
| ModifyVRouterAttribute | ModifyVRouterAttribute | ModifyVRouterAttribute |
| DescribeRouterInterfaces | DescribeRouterInterfaces | DescribeRouterInterfaces |
| UnassociateEipAddress | UnassociateEipAddress | UnassociateEipAddress. |
| AllocateEipAddress | Allocate an elastic IP address (EIP) | Allocates an elastic IP address (EIP). |
| ReleaseEipAddress | ReleaseEipAddress | Releases a specified Elastic IP Address (EIP). |
| AssociateEipAddress | AssociateEipAddress | AssociateEipAddress |
| DescribeEipMonitorData | DescribeEipMonitorData | DescribeEipMonitorData |
| CreateNatGateway | CreateNatGateway | CreateNatGateway. |
| DeleteNatGateway | DeleteNatGateway | DeleteNatGateway |
| DescribeNatGateways | DescribeNatGateways | DescribeNatGateways |
| DescribeNewProjectEipMonitorData | DescribeNewProjectEipMonitorData | Queries the monitoring data of an Elastic IP Address (EIP) in the new BGP (Multi-ISP) network. |
| DeleteRouteEntry | DeleteRouteEntry | DeleteRouteEntry. |
| DeleteForwardEntry | DeleteForwardEntry | Deletes a DNAT entry. |
| CreateForwardEntry | CreateForwardEntry | CreateForwardEntry |
| AddBandwidthPackageIps | AddBandwidthPackageIps | AddBandwidthPackageIps. |
| DescribeVRouters | Query the list of routers in a specified region | Queries a list of routers. |
| CreateRouteEntry | CreateRouteEntry | CreateRouteEntry |
| DescribeForwardTableEntries | DescribeForwardTableEntries | Queries DNAT entries in a DNAT table. |
| ModifyForwardEntry | ModifyForwardEntry | Modifies the properties of a specified forward entry. |
| DescribeAccessPoints | DescribeAccessPoints | DescribeAccessPoints. |
| DescribeRouteTables | DescribeRouteTables | List route tables |
| ConnectRouterInterface | ConnectRouterInterface | ConnectRouterInterface |
| ExportSnapshot | ExportSnapshot | Exports a snapshot to a specified Object Storage Service (OSS) bucket. |
| ReleasePublicIpAddress | ReleasePublicIpAddress | Releases a public IP from an instance. |
| AddTags | Add or overwrite tags on ECS resources | Adds or overwrites one or more tags on Elastic Compute Service (ECS) resources. You can add tags to instances, cloud disks, snapshots, images, security groups, and other resources for easier management. |
| DescribeResourceByTags | Retrieve resources by tag | Retrieves resources based on tags. You can retrieve resources by tag or by resource type. |
| DescribeTags | Queries available tags. | Queries tags available to you. You can perform a conditional query for tags by resource type, resource ID, tag key, or tag value. The filter conditions are evaluated by using a logical AND (&&) operator, and only tags that match all filter conditions are returned. |
| RemoveTags | Disassociates tags from a resource | Unbinds one or more tags from resources such as instances, cloud disks, snapshots, images, or security groups. |
Others
|
API |
Title |
Description |
| EnableNetworkInterfaceQoS | Enable or modify ENI QoS rate limiting settings | Enables or modifies the QoS rate limiting settings of an Elastic Network Interface (ENI). |
| DisableNetworkInterfaceQoS | Disable ENI QoS rate limiting settings | Disables the QoS rate limiting settings for an Elastic Network Interface (ENI). |
| DescribePlanMaintenanceWindows | Query O&M windows | Queries O&M windows. |
| CreatePlanMaintenanceWindow | Create an O&M window | Creates an O&M window. When the TargetResource parameter of the O&M window is set to associate with ECS instances and a hardware risk is detected at the underlying layer that requires scheduled O&M to mitigate, the execution time of the scheduled O&M is determined based on the time range specified by the TimePeriod parameter. When the execution time of the O&M event is reached, the platform automatically performs the corresponding O&M operation based on the event type. |
| ModifyPlanMaintenanceWindow | Modify an O&M window | Updates an O&M window. |
| DeletePlanMaintenanceWindow | Delete an O&M window | Deletes an O&M window. |