API standards and multilingual preset SDKs
The OpenAPI of this product (Ens/2017-11-10) 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.
Instances
|
API |
Title |
Description |
| RunInstances | Batch create instances | Creates pay-as-you-go or subscription ENS compute instances. |
| CreateInstance | Create a subscription instance | Creates a subscription instance. This operation can be replaced by RunInstances. No new features will be added to CreateInstance. |
| ReleasePostPaidInstance | ReleasePostPaidInstance | Deletes a pay-as-you-go instance. |
| ReleasePrePaidInstance | ReleasePrePaidInstance | Call ReleasePrePaidInstance to delete a subscription instance. |
| ReinitInstance | ReinitInstance | Resets an instance based on specific parameters. |
| ModifyInstanceAttribute | Modify instance attributes | Modifies the attributes of an instance, including the instance password and name. |
| ModifyPrepayInstanceSpec | Change instance specifications | Calls ModifyPrepayInstanceSpec to upgrade or downgrade the instance type of a subscription ENS instance. The new instance type takes effect for the entire lifecycle of the instance. |
| ModifyInstanceAutoRenewAttribute | ModifyInstanceAutoRenewAttribute | Configures auto-renewal for instances. |
| AttachEnsInstances | Join a container cluster | Adds an Edge Node Service (ENS) instance to Container Service for Kubernetes. |
| RebootInstance | RebootInstance | Reboots an instance. |
| StartInstance | StartInstance | Starts an instance. |
| StopInstance | StopInstance | Stops an instance. |
| AddNetworkInterfaceToInstance | Add an iPv6 network interface | Adds an IPv6 network interface and automatically assigns a public IP address. |
| DescribeAvailableResource | Query available instance resources | Queries the instance resources that can be created by calling DescribeAvailableResource. |
| DescribeInstances | Query instance information | Queries the details of one or more instances. |
| DescribeAvailableResourceInfo | Query purchasable instance type information | You can call DescribeAvailableResourceInfo to query the specifications of purchasable resources for instance creation. |
| DescribeEnsNetSaleDistrict | Query supported regions and iSPs and their quantities | Queries the supported regions and ISPs and their quantities. |
| DescribeEnsNetLevel | Query supported network levels | Queries the supported network levels. |
| DescribeBandWithdChargeType | DescribeBandWithdChargeType | Queries available bandwidth metering methods. |
| DescribeInstanceSpec | DescribeInstanceSpec | Queries the instance specifications that you can purchase. |
| DescribeEnsRegionIdIpv6Info | Query whether an edge zone supports iPv6 | Queries whether an edge zone supports IPv6. |
| DescribeRegionIsps | Query ENS edge node ISP information | Queries the Internet Service Provider (ISP) information of an ENS edge node. |
| DescribeInstanceAutoRenewAttribute | Query instance auto-renewal information | Queries the auto-renewal information of instances. |
| DescribeInstanceMonitorData | Query instance CPU and memory usage | Queries the CPU and memory usage of an instance. |
| DescribeInstanceTypes | Query instance type families | Queries the list of instance types by calling DescribeInstanceTypes. |
| DescribeInstanceVncUrl | Query the VNC URL of an instance | Queries the web management terminal URL of an ENS instance. |
| DescribeCreatePrePaidInstanceResult | DescribeCreatePrePaidInstanceResult | Queries the results of creating an instance. |
Images
|
API |
Title |
Description |
| ExportImage | Export an image to OSS | Exports a custom image to an Object Storage Service (OSS) bucket in the same region as the image. |
| DescribeSelfImages | DescribeSelfImages | Queries custom images. |
| DeleteImage | Delete an image | Deletes a custom image. |
| ModifyImageSharePermission | ModifyImageSharePermission | Shares or unshares an image. |
| DescribeImageInfos | Query available image resources | Queries available image resources. |
| DescribeImageSharePermission | DescribeImageSharePermission | Queries the accounts with which you share an image specified by the ImageId parameter. |
| DescribeExportImageStatus | Query image export status | Queries the export status of an image. |
| DescribeExportImageInfo | DescribeExportImageInfo | Queries the export result of an image. |
Cloud disks
|
API |
Title |
Description |
| CreateDisk | Create a data cloud disk | Creates a pay-as-you-go or subscription data cloud disk by calling CreateDisk. |
| DeleteDisk | DeleteDisk | Deletes a disk. |
| AttachDisk | Mount a cloud disk | Mounts a data cloud disk to an ENS instance. |
| DetachDisk | Detach a disk | Detaches a pay-as-you-go data cloud disk from an ENS instance. Only separately purchased pay-as-you-go disks can be detached. Disks created along with the instance are not supported. |
| ResizeDisk | Resize a cloud disk | Invokes the ResizeDisk operation to resize a separately purchased pay-as-you-go cloud disk instance. |
| DescribeDisks | Query disk information | Queries information about one or more created disks. |
| ReInitDisk | ReInitDisk | Initializes a disk. |
| ResetDisk | ResetDisk | Rolls back a disk by using a snapshot. |
| DescribeDiskIopsList | Query cloud disk monitoring | Queries disk IOPS monitoring data. |
Snapshots
|
API |
Title |
Description |
| ModifySnapshotAttribute | Modify snapshot attributes | Modifies the attributes of a snapshot. |
| CopySnapshot | Copy snapshot across edge zones | Calls CopySnapshot to copy a snapshot across edge zones. |
Network
|
API |
Title |
Description |
| CreateNetwork | Create a network | Creates a VPC. |
| CreateClassicNetwork | Create a classic VPC | Creates a classic virtual private cloud (VPC). |
| DeleteNetwork | DeleteNetwork | Deletes a virtual private cloud (VPC). |
| ModifyNetworkAttribute | ModifyNetworkAttribute | Modifies the network information. |
| DescribeNetworkInterfaces | List elastic network interfaces | Queries a list of elastic network interfaces (ENIs). |
| DescribeNetworkAttribute | Query network information | Queries the configuration information of a specified network. |
| CreateEnsRouteEntry | Create a custom route entry | Creates a custom route entry. |
| DeleteEnsRouteEntry | DeleteEnsRouteEntry | Deletes a custom route entry. |
| DescribeEnsRouteEntryList | List routing entries | Queries the routing entry list. |
vSwitches
|
API |
Title |
Description |
| CreateVSwitch | Create a vSwitch | Creates a vSwitch. |
| DeleteVSwitch | DeleteVSwitch | Deletes a vSwitch. |
| ModifyVSwitchAttribute | Modify vSwitch attributes | Modifies the attributes of a vSwitch. |
Security groups
|
API |
Title |
Description |
| CreateSecurityGroup | CreateSecurityGroup | Creates a security group. |
| DeleteSecurityGroup | DeleteSecurityGroup | Deletes a security group. |
| JoinSecurityGroup | JoinSecurityGroup | Adds an Edge Node Service (ENS) instance to a specified security group. |
| LeaveSecurityGroup | Remove an ENS instance from a security group | Removes an ENS instance from the specified security group. |
| DescribeSecurityGroups | DescribeSecurityGroups | Queries details about created security groups. |
| AuthorizeSecurityGroup | Add inbound security group rules | Calls AuthorizeSecurityGroup to configure inbound access permissions for a security group, allowing or denying other devices from sending inbound traffic to instances in the security group. |
| RevokeSecurityGroup | Delete an inbound security group rule | Revokes an inbound rule of a security group to remove the inbound access permission settings. |
| AuthorizeSecurityGroupEgress | Add an outbound security group rule | Invokes AuthorizeSecurityGroupEgress to specify the outbound access permissions for a security group, allowing or denying instances in the security group to send outbound traffic to other devices. |
| RevokeSecurityGroupEgress | Delete an outbound security group rule | Calls RevokeSecurityGroupEgress to delete an outbound security group rule and revoke outbound access permissions of the security group. |
Elastic IP addresses
|
API |
Title |
Description |
| DeleteEip | DeleteEip | Deletes a pay-as-you-go elastic IP address (EIP). |
| CreateEipInstance | Create an EIP | Creates an elastic IP address (EIP) by calling the CreateEipInstance operation. |
| AssociateEnsEipAddress | Associate an EIP with a cloud product instance | Associates an Elastic IP Address (EIP) with a cloud product instance on the same edge node. |
| UnAssociateEnsEipAddress | Disassociate an EIP | Disassociates an elastic IP address (EIP) from the cloud resource to which it is bound. |
| ModifyEnsEipAddressAttribute | ModifyEnsEipAddressAttribute | Modifies the name, description, and peak bandwidth of a specified elastic IP address (EIP). |
| DescribeEnsEipAddresses | List eIPs | Queries elastic IP addresses (EIPs). |
NAT gateways
|
API |
Title |
Description |
| ModifyForwardEntry | ModifyForwardEntry | Modifies a Destination Network Address Translation (DNAT) rule. |
| DescribeSnatAttribute | DescribeSnatAttribute | Queries a specific source network address translation (SNAT) entry. |
| AddSnatIpForSnatEntry | Add a public EIP to a SNAT rule | Adds a public elastic IP address (EIP) to a SNAT rule. |
| DeleteSnatIpForSnatEntry | Delete a public EIP from an SNAT rule | Deletes a public EIP from an SNAT rule. |
| StartSnatIpForSnatEntry | StartSnatIpForSnatEntry | Starts the elastic IP address (EIP) specified in a source network address translation (SNAT) entry. |
| StopSnatIpForSnatEntry | StopSnatIpForSnatEntry | Disables an elastic IP address (EIP) in a source network address translation (SNAT) entry. |
Edge load balancers
|
API |
Title |
Description |
| ModifyLoadBalancerAttribute | Modify load balancing attributes | Invokes ModifyLoadBalancerAttribute to modify the information of a load balancing instance. |
| DescribeLoadBalancerListenMonitor | Query layer 4 listener-level monitoring data for a load balancer | Queries Layer 4 listener-level monitoring data for a load balancer. |
| DescribeServerLoadBalancerMonitor | Query layer 7 monitoring data at the ESLB instance level | Queries request monitoring data of an ESLB instance. |
| DescribeServerLoadBalancerListenMonitor | Query ESLB listener-level layer 7 monitoring data | Queries listener-level monitoring data for an ESLB instance. |
Elastic network interfaces
|
API |
Title |
Description |
| CreateNetworkInterface | CreateNetworkInterface | Create an Elastic Network Interface (ENI). |
| DeleteNetworkInterfaces | Delete elastic network interface controllers (NICs) | Deletes one or more elastic network interface controllers (NICs). |
| AttachNetworkInterface | Attach elastic network interfaces (ENIs) to an instance | Attaches elastic network interfaces (ENIs) to an ENS instance. |
| DetachNetworkInterface | DetachNetworkInterface | Detach an elastic network interface (ENI) from an instance. |
| ModifyNetworkInterfaceAttribute | ModifyNetworkInterfaceAttribute | Modifies the attributes of an elastic network interface (ENI), such as its name and description. |
| DescribeSecondaryPublicIpAddresses | Query secondary public IP addresses | Queries the secondary public IP addresses that have been created. |
High-availability vIPs
|
API |
Title |
Description |
| CreateHaVip | CreateHaVip | Creates a high-availability virtual IP address (HAVIP). |
| ModifyHaVipAttribute | ModifyHaVipAttribute | Modifies the name of a high-availability virtual IP address (HAVIP). |
| DescribeHaVips | Query high-availability virtual IP addresses | Queries high-availability virtual IP addresses (HaVips). |
| AssociateHaVip | Associate a haVip with an ENS instance | Invokes the AssociateHaVip operation to associate a high availability virtual IP address (HaVip) with an Edge Node Service (ENS) instance or an ENS elastic network interface controller (NIC). |
| UnassociateHaVip | Disassociate a haVip from an ENS instance | Disassociates a HaVip from an ENS instance or a network interface controller (NIC). |
Network aCLs
|
API |
Title |
Description |
| CreateNetworkAcl | CreateNetworkAcl | Creates a network access control list (ACL). |
| DeleteNetworkAcl | Delete a network ACL | Deletes a network ACL. |
| DescribeNetworkAcls | View network aCLs | Queries created network ACLs. |
| AccosicateNetworkAcl | Associate a network ACL with a network | Calls the AccosicateNetworkAcl operation to attach a network ACL to a network. |
| UnassociateNetworkAcl | Disassociate a network ACL | Invokes the UnassociateNetworkAcl operation to disassociate a network ACL from a network, which reverses the attach of the network ACL. |
| CreateNetworkAclEntry | Create a network ACL rule | You can invoke the CreateNetworkAclEntry API to create a network ACL rule. |
| DeleteNetworkAclEntry | Delete a network ACL rule | Invokes the DeleteNetworkAclEntry operation to delete network ACL rules. |
Collaborative storage NAS
|
API |
Title |
Description |
| CreateFileSystem | Create a file system | Creates a NAS file system by calling the CreateFileSystem operation. |
| DeleteFileSystem | Delete a NAS file system | Deletes a NAS file system. |
| ModifyFileSystem | ModifyFileSystem | Modifies the description of a NAS file system. |
| DescribeFileSystems | Query file system information | Invokes DescribeFileSystems to query NAS file system info. |
| CreateMountTarget | CreateMountTarget | Creates a mount target. |
| DeleteMountTarget | Delete a mount target | Deletes an existing mount target. |
| DescribeMountTargets | Query mount target information | Queries the details of mount targets. |
Collaborative storage EOS
|
API |
Title |
Description |
| GetOssUsageData | Query storage and bandwidth usage | Queries the calculated storage and bandwidth usage for a specified time period. |
| GetOssStorageAndAccByBuckets | Query storage usage in the previous cycle and number of calls for the current month | Queries the storage usage in the previous billing cycle and the cumulative number of calls for the current month. |
Storage gateways
|
API |
Title |
Description |
| DescribeStorageGateway | DescribeStorageGateway | Queries storage gateways. |
| CreateStorageGateway | CreateStorageGateway | Creates a storage gateway. |
| DeleteStorageGateway | DeleteStorageGateway | Deletes a storage gateway. |
Storage volumes
|
API |
Title |
Description |
| DescribeStorageVolume | DescribeStorageVolume | Queries volumes. |
| CreateStorageVolume | CreateStorageVolume | Creates a storage volume. |
| DeleteStorageVolume | DeleteStorageVolume | Deletes a storage volume. |
Secondary IP addresses
|
API |
Title |
Description |
| AssignPrivateIpAddresses | Assign secondary private IP addresses | Invokes AssignPrivateIpAddresses to assign secondary private IP addresses to an elastic network interface controller (NIC). |
| UnassignPrivateIpAddresses | Unassign secondary private IP addresses | Unassigns one or more secondary private IP addresses from an elastic network interface (ENI). |
Edge containers
|
API |
Title |
Description |
| CreateCluster | Create an edge container cluster | Creates an edge container cluster. |
| DeleteCluster | Delete a cluster | Deletes a cluster. |
| DescribeClustersV1 | List clusters | Queries a list of clusters. |
| DescribeClusterDetail | Query specified cluster information | Queries the details of a cluster. |
| DescribeClusterUserKubeconfig | Query cluster kubeConfig | Retrieves the KubeConfig of a specified cluster. KubeConfig is used to configure access credentials for an ECK cluster on the client side, including identity and authentication data for accessing the target cluster. When you use kubectl for cluster management, you must first connect to the cluster by using KubeConfig. You can invoke the DescribeClusterUserKubeconfig operation to query the KubeConfig of the specified cluster. |
| UpdateClusterCertificate | Update cluster certificate | Updates the cluster certificate. |
| CreateClusterNodePool | Create a node pool | A node pool is a logical collection of nodes with identical attributes that enables unified management and O&M operations such as node upgrades and elastic scaling. You can further leverage the automated O&M capabilities of node pools to reduce O&M costs through features such as automatic OS CVE vulnerability remediation, automatic recovery of faulty nodes, and automatic version upgrades for kubelet and containerd. You can call the CreateClusterNodePool operation to create a node pool for a cluster. |
| ScaleClusterNodePool | Scale out a node pool | Scales out a node pool to ensure that the number of nodes is sufficient to support your workloads. The Count parameter must be greater than the current number of nodes in the node pool. If the node pool contains nodes that failed to scale out, you must call the DeleteClusterNodes operation to delete the failed nodes before you scale out the node pool. A scale-out task typically takes 5 to 10 minutes. If the task takes more than 1 hour, the scale-out fails. In this case, contact technical support. |
| ModifyClusterNodePool | Modify node configurations in a node pool | Modifies the node configuration in a cluster node pool, such as kubelet configurations and node rotation configurations. Modifying node configurations changes the configurations in batches and restarts kubelet, which may affect node and workload operations. Perform this operation during off-peak hours. |
| DeleteClusterNodePool | Delete a node pool | Deletes an unused node pool. When a node pool is deleted, all pods on the nodes in the node pool are deleted. This may trigger rescheduling. If rescheduling fails, your services may be affected. Make sure that the cluster has sufficient resources for rescheduling. |
| AttachInstancesToNodePool | Add existing nodes to a node pool | Adds existing instances to a node pool. You can call this operation to add existing Edge Node Service (ENS) instances to an ECK cluster as worker nodes, or to re-add node instances to a node pool after they are removed. |
| DescribeClusterAttachScripts | Retrieve the script for adding existing nodes to a cluster node pool | Retrieves the script for adding existing nodes to a cluster node pool. If you need to add existing ENS instances to an ECK cluster as worker nodes, or re-add node instances to a node pool after removing worker nodes, ECK supports manually adding existing nodes to a node pool. You can call the DescribeClusterAttachScripts operation to retrieve the script for adding existing nodes. |
| DescribeClusterNodes | List cluster nodes | Queries a list of nodes that meet specific conditions. |
| DescribeClusterNodePools | List node pools | Queries all node pools in a cluster. |
| DeleteClusterNodes | Remove cluster nodes | Removes nodes from a cluster when the nodes are no longer needed. The ReleaseNode parameter specifies whether to release the underlying Edge Node Service (ENS) compute instances. Default value: false. If the node to be removed is in the failed state, this parameter does not take effect and the corresponding compute instance is released by default. For ENS compute instances that you manually connect to the cluster by using the script obtained from the DescribeAttachScript operation, this parameter does not take effect and the corresponding compute instances are not released by default. |
| InitializeENSECKServiceRole | InitializeENSECKServiceRole | Creates a service-linked role (SLR) that grants ENS the permissions to manage your resources. |
| ListAddons | List available components | Queries the details of cluster components. |
| InstallClusterAddons | Install cluster components | Installs components in an ECK cluster to enhance Kubernetes capabilities. ECK clusters support various components, such as managed core components, as well as application, logging and monitoring, networking, storage, and security components. You can call the InstallClusterAddons operation to install components by specifying the component name and version. |
| UpgradeClusterAddons | Upgrade cluster instance add-ons | Upgrades the versions of cluster add-on instances. |
| ModifyClusterAddon | Modify the configuration of a cluster add-on instance | Modifies the configuration of an installed cluster add-on instance. Modifying the configuration may affect your services. Evaluate the impact, perform this operation during off-peak hours, and back up your data in advance. |
| GetClusterAddonInstance | Query details of a specified add-on instance in a cluster | Queries the details of a specified add-on in a cluster, including the version, parameter settings, and status of the add-on instance. |
| ListClusterAddonInstances | List installed add-on instances in a cluster | Retrieves a list of installed add-on instances in a specified cluster and queries related information about the add-on instances, such as the add-on version and status. |
| UnInstallClusterAddons | Uninstall cluster add-ons | Uninstalls specified add-ons from a cluster. |
| DescribeAddon | Query the details of a specified add-on | Queries the details of a specified add-on. |
Scenario-based computing
|
API |
Title |
Description |
| DescribeInstanceSDGStatus | Query the deployment status of sDGs on an instance | Queries the mount status of SDGs under a specified AIC instance. |
| MountInstanceSDG | Mount an SDG to an instance | Deploys the attached SDG to the corresponding AIC. |
| UnmountInstanceSDG | Unmount an SDG from an instance | Unmounts an SDG from the corresponding instance and restores it to the attached state. |
| AttachInstanceSDG | Mount an SDG to an instance | Attaches an SDG to the corresponding AIC instance. |
| DetachInstanceSDG | Unmount the SDG from the instance | Unmounts the SDG. |
| CreateSDG | Create an SDG | Creates an SDG on an AIC instance. |
| DeploySDG | Deploy an SDG | Deploys an SDG. |
| DeployInstanceSDG | Deploy an SDG to instances | Deploys an SDG to compute instances. |
| CopySDG | Copy an SDG across edge zones | Copies an SDG across edge zones. |
| PreloadRegionSDG | Preload an SDG | Preloads an SDG. |
| DescribeSDGs | Query SDG information | Queries information about created shared data groups (SDGs). |
| DescribeSDG | Query SDG information | Queries basic SDG information, including node preload information. |
| DescribeSDGDeploymentStatus | Query SDG deployment status | Queries the deployment status of an SDG. |
| DeleteSDG | Delete an SDG | Deletes an SDG. |
| UnloadRegionSDG | Unload preloaded SDG | Deletes preloaded data. |
| RemoveSDG | Remove an SDG | Removes a deployed SDG and restores local storage. |
| RemoveInstanceSDG | Delete SDG deployed to instances | Unmounts an SDG from compute instances. |
| SaveSDG | Save an SDG | Saves the cloud disk of a specified device as an SDG. |
| RemoveSDGs | Fully uninstall sDGs from instances | Removes all versions of SDGs and restores local disk mounting. |
Edge cloud android (AIC)
|
API |
Title |
Description |
| ModifyAICInstanceType | Modify AIC container instance specifications | Modifies the specifications of an Android in Container (AIC) instance. |
| ResetAICInstance | Reset an AIC instance | Resets an AIC instance. |
| UpgradeAICInstanceImage | UpgradeAICInstanceImage | Updates the image of an Android in Container (AIC) instance. |
| RebootAICInstance | RebootAICInstance | Restarts an Android in Container (AIC) instance. |
| DescribeARMServerInstances | Retrieve ARM server and AIC instance information | Retrieves information about ARM servers and AIC instances. |
| RebootARMServerInstance | Restart an AIC server | Restarts an AIC server. |
| ReleaseARMServerInstance | Release a cloud application server | Releases a cloud application server. |
| CreateARMServerInstances | Create ARM board card servers | Creates ARM board card servers by calling CreateARMServerInstances. |
| RenewARMServerInstance | Renew a subscription AIC instance | Renews a subscription AIC instance. |
| DescribeAICImages | Retrieve image information | Retrieves image information. |
| RecoverAICInstance | Resume an AIC on a card | Resumes an AIC on a card by calling RecoverAICInstance. |
| ReleaseAICInstance | Release an AIC on a card | Releases an AIC on a card. |
Edge application hosting
|
API |
Title |
Description |
| RunServiceSchedule | Schedule device services | Optimally schedules idle resources (instances or container pods) for a terminal device based on the customer ID and IP address, and initializes the virtual device environment. |
| DescribeServcieSchedule | Query end-user scheduling information | Queries the real-time status of instance devices or containers that are being scheduled for the specified UUID. |
| RescaleDeviceService | Scale out service | Rescales bare metal devices. |
| DescribeDeviceService | Query device service information | Queries the list of basic property information such as instances and virtual device network status under an edge application. |
| DescribeDataPushResult | Query application data pre-push results | Queries the pre-push status of data files for an application on edge nodes. |
| DescribeDataDownloadURL | Query application data download URL | Retrieves the download URL of application data from file servers and returns the list of file servers to which the data has been successfully pre-pushed. |
| DescribeDataDistResult | Query application data distribution results | Retrieves the distribution status of data files across edge resource instances of an application by calling DescribeDataDistResult. |
| DistApplicationData | DistApplicationData | Distributes pushed data to the Edge Node Service (ENS) instances of the application. You can specify multiple canary release policies, decompress files, and restart containers. |
| DescribeApplication | Query application information | Queries the basic attributes, resources, and container statuses of an application. |
| UpgradeApplication | UpgradeApplication | Updates the container in an asynchronous manner. You can configure multiple canary release policies. |
| RollbackApplication | Roll back to a historical application version | Rolls back the container version of edge resources under an application to a historical version. |
| RescaleApplication | Scale an application | Calls the RescaleApplication operation to asynchronously scale resources in or out and complete container deployment or release operations. |
| PushApplicationData | Pre-push application data | Pre-pushes the business or service data of an application to a file server. |
Edge zone resource information
|
API |
Title |
Description |
| DescribeEnsRegions | DescribeEnsRegions | Queries a list of available ENS nodes. |
| DescribeEnsRegionIdResource | Query edge zone resource details | Queries edge zone resource information by calling DescribeEnsRegionIdResource. |
| DescribeReservedResource | Query specifications of resources available for purchase | Queries the specifications of resources available for purchase. |
| DescribePrePaidInstanceStock | DescribePrePaidInstanceStock | Queries the specifications of resources that can be purchased in subscription billing mode. |
| DescribeLoadBalancerSpec | Query load balancing specifications | Invokes DescribeLoadBalancerSpec to query load balancing specifications. |
| DescribeCloudDiskTypes | DescribeCloudDiskTypes | The specifications of available resources are queried when you create a disk. |
| DescribeCloudDiskAvailableResourceInfo | Query available cloud disk resources | Queries the available cloud disk resources in a region. |
Bandwidth
|
API |
Title |
Description |
| DescribeBandwitdhByInternetChargeType | DescribeBandwitdhByInternetChargeType | Queries the metering method for the bandwidth. |
| DescribeUserBandWidthData | DescribeUserBandWidthData | Queries the bandwidth that you use within a specified period of time. |
Metering and billing
|
API |
Title |
Description |
| DescribeMeasurementData | Retrieve user metering data | Retrieves user metering data. |
| ExportBillDetailData | ExportBillDetailData | Exports billing details within a specific time range. |
| ExportMeasurementData | ExportMeasurementData | Exports the metering data within a specific time range. |
O&M and monitoring
|
API |
Title |
Description |
| BatchEventRebootInstance | Batch restart instances | Batch restarts specified resources immediately or at a scheduled time. |
| EventRebootInstance | Restart an instance | Restarts an instance after an O&M event occurs. |
| EventMigrateInstance | Migrate an instance | Migrates an instance across nodes after an O&M event occurs on the instance. |
| BatchEventMigrateInstance | Batch migrate instances | Batch migrates instances under a specified event. Supports immediate or scheduled execution. |
| EventRedeployInstance | EventRedeployInstance | Redeploys a specified instance either immediately or at a scheduled time. |
| BatchEventRedeployInstance | Batch deploy instances | Batch redeploys specified resources immediately or at a scheduled time. |
Other
|
API |
Title |
Description |
| ReleaseInstance | ReleaseInstance | Releases an instance. to release only Elastic IP Addresses (EIPs), Edge Load Balancer (ELB) instances, and cloud disk-based instances. We recommend that you call service-specific operations to release or unsubscribe from instances. |
| CreateEnsService | Create an edge service | Creates an edge service. |
| DescribeNASAvailableResourceInfo | Query available resources for purchase when creating a NAS file system | Queries the available resources for purchase when creating a NAS file system. |
| CreateEpnInstance | Create an edge-to-Edge network instance | Creates an Edge-to-Edge network instance. |
| DeleteEpnInstance | DeleteEpnInstance | Deletes an edge private network (EPN) instance. |
| DescribeEnsNetDistrict | Query regions where EPS resources can be created | Invokes the DescribeEnsNetDistrict operation to query the regions where EPS resources can be created. |
| DescribeEpnBandWidthData | Query edge-to-edge network bandwidth usage | Invokes DescribeEpnBandWidthData to query the network bandwidth usage of an edge-to-edge network. |
| DescribeEpnBandwitdhByInternetChargeType | DescribeEpnBandwitdhByInternetChargeType | Queries the metering method of the EPN bandwidth within a time period. |
| DescribeEpnInstanceAttribute | DescribeEpnInstanceAttribute | Queries networking information about an EPN instance. |
| DescribeEpnInstances | DescribeEpnInstances | Queries EPN instances. |
| DescribeEpnMeasurementData | DescribeEpnMeasurementData | Queries the metering data of the edge private network (EPN). |
| JoinPublicIpsToEpnInstance | JoinPublicIpsToEpnInstance | Assigns public IP addresses to an EPN instance. |
| JoinVSwitchesToEpnInstance | Configure networking | Joins vSwitches to an Edge Private Network (EPN) instance for networking. |
| ModifyEpnInstance | ModifyEpnInstance | Modifies an Edge Private Network (EPN) instance. |
| RemovePublicIpsFromEpnInstance | Delete instances from a public network | Removes instances from a public network. |
| RemoveVSwitchesFromEpnInstance | Remove networking information | Removes networking information from an Edge Private Network (EPN) instance. This operation applies only to internal networks. |
| StartEpnInstance | Start an edge-to-edge communication instance | Starts an edge-to-edge communication instance. |
| StopEpnInstance | Stop an edge-to-Edge communication instance | Stops an Edge-to-Edge communication instance. |
| DescribeEnsResourceUsage | Query resource usage | Queries the summary of virtual machine, disk, and network usage in Edge Node Service (ENS). |
| DescribeInstanceBandwidthDetail | Query bandwidth details by page | Queries the bandwidth details of an instance at a 5-minute granularity. |
| ModifyInstanceBootConfiguration | Modify instance boot configuration | Modifies the boot configuration of a heterogeneous instance (PCFarm bare metal instance). |
| DescribeEnsRouteTables | List route tables | Queries the list of route tables. |
| DeleteHaVips | DeleteHaVips | Deletes a high-availability VIP (HAVIP). |
| ModifySnatEntry | Modify an SNAT entry | Invoke the ModifySnatEntry API to modify an SNAT entry. |
| DescribeVSwitchAttributes | Query vSwitch configuration | Queries the configuration information of a specified vSwitch. |
| ModifyEnsRouteEntry | ModifyEnsRouteEntry | Modifies the name and description of a custom route. |
| ListProductAbilities | ListProductAbilities | Lists all service capabilities. |
| DescribeInstanceBootConfiguration | Query instance boot configuration | Queries the boot configuration. Only heterogeneous instances (PCFarm bare metal instances) are supported. |
| DescribeForwardEntryAttribute | Retrieve DNAT entry details | Invokes DescribeForwardEntryAttribute to query the details of a specified DNAT rule. |
| ModifyInstanceNetworkAttribute | Modify instance network attributes | Modifies the private IP address and vSwitch of an Edge Node Service (ENS) instance. |
| CreateSecurityGroupPermissions | Create a security group rule | Creates a security group rule for Edge Node Service (ENS). |
| DeleteSecurityGroupPermissions | DeleteSecurityGroupPermissions | Deletes an ENS security group rule. |
| ManageAICLogin | Manage AIC instance logon | Manages the logon of AIC instances by associating or dissociating instances based on uploaded AIC public keys. |
| ListAICPublicKeys | Query AIC public key information list | Queries a list of AIC public key information that meets the specified conditions. Paging is supported. |
| DeleteAICPublicKey | Delete an AIC public key | Deletes a specified AIC public key. The public key can be deleted only when it is not associated with any resource. |
| ListAICPublicKeyDeliveries | Query AIC public key association information list | Queries the list of association information for AIC public keys. Paging is supported. |
| ShareAICImage | Share an AIC image | Shares a specified AIC image with other users. |
| UploadAICPublicKey | Upload an AIC public key | Uploads a new AIC public key. |
| DescribeSDGSharedDisks | Query shared disks for an SDG | Queries the information about shared disks in a specified SDG. |
| DescribeClusterKubeConfig | Query edge container cluster certificate | Queries the certificate of an edge container cluster. |
| DescribeCluster | Query edge container clusters | Queries edge container clusters. |
| DeleteNetworkPeerConnection | DeleteNetworkPeerConnection | Deletes a network peer connection. |
| DescribeNetworkPeerConnections | DescribeNetworkPeerConnections | Call `DescribeNetworkPeerConnections` to query network peer connections. |
| AttachKeyPair | Attach an SSH key pair to multiple instances | Attaches an SSH key pair to a batch of specified instances. A maximum of 30 instances can be specified in a single call. |
| CreateForwardEntry | Add a DNAT entry | Adds a DNAT entry by calling CreateForwardEntry. |
| CreateImage | Create an image | Creates an image from a specified instance. |
| CreateKeyPair | CreateKeyPair | Creates an SSH key pair. |
| CreateNatGateway | Create a NAT gateway | Creates a NAT gateway. |
| CreateSnapshot | Create a snapshot | Creates a snapshot by calling CreateSnapshot. |
| CreateSnatEntry | CreateSnatEntry | Adds a source network address translation (SNAT) entry to a specified SNAT table. |
| DeleteForwardEntry | DeleteForwardEntry | Deletes a Destination Network Address Translation (DNAT) entry from a specified DNAT table. |
| DeleteKeyPairs | DeleteKeyPairs | Deletes SSH key pairs. |
| DeleteNatGateway | DeleteNatGateway | Deletes an Internet network address translation (NAT) gateway. |
| DeleteSnapshot | DeleteSnapshot | Deletes a snapshot. |
| DeleteSnatEntry | Delete an SNAT entry | Deletes a specified SNAT entry. |
| DescribeForwardTableEntries | List DNAT entries | Queries created DNAT entries. |
| DescribeHistoryEvents | Query system events | Queries system event information. |
| DescribeImages | DescribeImages | Queries available images. |
| DescribeKeyPairs | Query one or more key pairs | Queries one or more key pairs. |
| DescribeNatGateways | Query NAT Gateway properties | Invoke DescribeNatGateways to query created NAT Gateways. |
| DescribeNetworks | List networks | Queries a list of networks. |
| DescribePrice | Query ENS instance prices | Queries the latest prices of Edge Node Service (ENS) resources. |
| DescribeSecurityGroupAttribute | Query security group rules | You can invoke DescribeSecurityGroupAttribute to query the security group rules of a security group. |
| DescribeSnapshots | Query snapshot information | Queries snapshot information by calling DescribeSnapshots. |
| DescribeSnatTableEntries | DescribeSnatTableEntries | Queries source network address translation (SNAT) entries. |
| DescribeVSwitches | Query vSwitch information | Queries information about vSwitches available for networking. Internal networks are organized by vSwitch. |
| DetachKeyPair | DetachKeyPair | Detaches a key pair from up to 30 instances in a single request. You can specify the key pair by its key pair name or key pair ID. |
| ImportImage | Import an image | Imports image information. |
| ImportKeyPair | Import the public key of an RSA key pair | Imports the public key of an RSA key pair generated by other tools. |
| ListTagResources | Query tags bound to resources | Queries the tags bound to one or more Edge Node Service (ENS) resources. Currently, only instance resources are supported. |
| ModifyImageAttribute | ModifyImageAttribute | Modifies the image attributes. |
| ModifyInstanceChargeType | Convert instance billing type | Invokes ModifyInstanceChargeType to convert the billing method of one or more Edge Node Service (ENS) instances. You can convert between instance-level pay-as-you-go and subscription instances. For instance-level pay-as-you-go instances, you can also convert pay-as-you-go cloud disks created with the instances to subscription cloud disks. |
| ModifySecurityGroupAttribute | ModifySecurityGroupAttribute | Modifies the information about a security group. |
| RenewInstance | Renew a subscription instance | Renews a subscription instance. |
| TagResources | TagResources | Creates and adds tags to specific Edge Node Service (ENS) resources. |
| UntagResources | Remove tags from specified ENS resources | Removes tags from resources. |
| AddBackendServers | Add backend servers | Adds backend servers. |
| CreateApplication | Create an edge application hosting service | Creates an edge application service to host edge services on containers (virtual devices), bare metal instances, or virtual machines. |
| CreateLoadBalancer | Create a load balancing instance | Creates a load balancing instance. |
| CreateLoadBalancerHTTPListener | CreateLoadBalancerHTTPListener | Creates an HTTP listener. |
| CreateLoadBalancerHTTPSListener | CreateLoadBalancerHTTPSListener | Creates an HTTPS listener. |
| CreateLoadBalancerTCPListener | CreateLoadBalancerTCPListener | To create a TCP listener, call `CreateLoadBalancerTCPListener`. |
| CreateLoadBalancerUDPListener | CreateLoadBalancerUDPListener | To create a UDP listener, call `CreateLoadBalancerUDPListener`. |
| DeleteApplication | DeleteApplication | Releases all containers and resource instances related to a specific application in an asynchronous manner. |
| DeleteBucket | DeleteBucket | You can call the DeleteBucket operation to delete a bucket. |
| DeleteBucketLifecycle | DeleteBucketLifecycle | Deletes the lifecycle rules of a bucket. |
| DeleteLoadBalancerListener | DeleteLoadBalancerListener | Deletes a listener. |
| DeleteObject | DeleteObject | Deletes an object. |
| DescribeLoadBalancerAttribute | Query the details of a specified load balancing instance | Invokes the DescribeLoadBalancerAttribute operation to query the details of a specified load balancing instance. |
| DescribeLoadBalancerHTTPListenerAttribute | Query HTTP listener attributes | Queries the configurations of an HTTP listener. |
| DescribeLoadBalancerHTTPSListenerAttribute | Query HTTPS listener attributes | Queries the configurations of an HTTPS listener. |
| DescribeLoadBalancerListeners | List load balancing listeners | Invokes DescribeLoadBalancerListeners to query the listeners of a load balancing instance. |
| DescribeLoadBalancerTCPListenerAttribute | Query TCP listener attributes | Queries the configuration of a TCP listener. |
| DescribeLoadBalancerUDPListenerAttribute | DescribeLoadBalancerUDPListenerAttribute | Call `DescribeLoadBalancerUDPListenerAttribute` to get a UDP listener's configuration. |
| DescribeLoadBalancers | List created load balancing instances | Invokes DescribeLoadBalancers to query the list of created load balancing instances. |
| GetBucketAcl | GetBucketAcl | Queries the access control list (ACL) of a bucket. |
| GetBucketInfo | GetBucketInfo | You can call GetBucketInfo to retrieve detailed Bucket information. |
| GetBucketLifecycle | View object lifecycle rules | Retrieves lifecycle rule information. |
| ListApplications | ListApplications | Queries the created applications. |
| ListBuckets | ListBuckets | Queries all buckets of a user. |
| ListObjects | ListObjects | Queries the information about all objects in a bucket. |
| PrepareUpload | PrepareUpload | Prepares for an upload and retrieves information about the physical storage location. |
| PutBucket | PutBucket | Create a bucket for collaborative storage. |
| PutBucketAcl | PutBucketAcl | Modifies the access control list (ACL) of a bucket. |
| PutBucketLifecycle | Configure object lifecycle rules | Configures lifecycle rules for objects. |
| RemoveBackendServers | Remove backend servers | Removes backend servers. |
| SetBackendServers | Set backend server weights | Sets the weights of backend servers by calling SetBackendServers. |
| SetLoadBalancerHTTPListenerAttribute | Modify HTTP listener attributes | Modifies the configuration of an HTTP listener. |
| SetLoadBalancerHTTPSListenerAttribute | Modify HTTPS listener attributes | Modifies the configurations of an HTTPS listener. |
| SetLoadBalancerStatus | Set the instance status of a load balancing instance | Invokes SetLoadBalancerStatus to modify the instance status of a load balancing instance. |
| SetLoadBalancerTCPListenerAttribute | Modify TCP listener attributes | Modifies the configuration of a TCP listener. |
| SetLoadBalancerUDPListenerAttribute | Modify UDP listener attributes | Modifies the configurations of a UDP listener. |
| StartLoadBalancerListener | StartLoadBalancerListener | Enables a listener. |
| StopLoadBalancerListener | StopLoadBalancerListener | Disables a listener. |
Others
|
API |
Title |
Description |
| AssociateNetworkCidrBlock | Add a secondary CIDR block to a network | Adds a secondary CIDR block to a network. |
| UnassociateNetworkCidrBlock | Delete a secondary CIDR block from a network | Deletes a secondary CIDR block from a network. |