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.
Instance
|
API |
Title |
Description |
| RunInstances | Create instances in batches | Creates pay-as-you-go or subscription Edge Node Service (ENS) 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 | ModifyInstanceAttribute | Modifies the attributes of an instance, such as its 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 | AttachEnsInstances | Add ENS instances to Container Service for Kubernetes. |
| RebootInstance | RebootInstance | Reboots an instance. |
| StartInstance | StartInstance | Starts an instance. |
| StopInstance | StopInstance | Stops an instance. |
| AddNetworkInterfaceToInstance | AddNetworkInterfaceToInstance | Adds an IPv6 network interface controller (NIC). A public IP address is automatically assigned at the same time. |
| DescribeAvailableResource | DescribeAvailableResource | Queries the resources that can be created. |
| 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 | DescribeEnsNetSaleDistrict | Queries the information about ISPs and number of ISPs in an area. |
| DescribeEnsNetLevel | DescribeEnsNetLevel | Queries the supported network levels. |
| DescribeBandWithdChargeType | DescribeBandWithdChargeType | Queries available bandwidth metering methods. |
| DescribeInstanceSpec | DescribeInstanceSpec | Queries the instance specifications that you can purchase. |
| DescribeEnsRegionIdIpv6Info | DescribeEnsRegionIdIpv6Info | Queries whether a node supports IPv6. |
| DescribeRegionIsps | DescribeRegionIsps | Queries the Internet service providers (ISPs) of edge nodes. |
| DescribeInstanceAutoRenewAttribute | DescribeInstanceAutoRenewAttribute | to query whether auto-renewal is enabled for an instance. |
| DescribeInstanceMonitorData | DescribeInstanceMonitorData | Queries the vCPU and memory usage of an instance. |
| DescribeInstanceTypes | Query instance type families | Queries the list of instance types by calling DescribeInstanceTypes. |
| DescribeInstanceVncUrl | DescribeInstanceVncUrl | Queries the Virtual Network Computing (VNC) URL of an Edge Node Service (ENS) instance. |
| DescribeCreatePrePaidInstanceResult | DescribeCreatePrePaidInstanceResult | Queries the results of creating an instance. |
Image
|
API |
Title |
Description |
| ExportImage | ExportImage | Exports a custom image to an Object Storage Service (OSS) bucket in the same region. |
| 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 | DescribeExportImageStatus | Queries the export status of an image. |
| DescribeExportImageInfo | DescribeExportImageInfo | Queries the export result of an image. |
Cloud disk
|
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 | AttachDisk | Attaches a disk to an Edge Node Service (ENS) instance. |
| DetachDisk | DetachDisk | Detaches a pay-as-you-go disk from an Edge Node Service (ENS) instance. You cannot To detach a disk that is created together with an instance. |
| ResizeDisk | ResizeDisk | Resizes a pay-as-you-go disk that you purchase. |
| 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 | DescribeDiskIopsList | Queries the disk IOPS monitoring data. |
Snapshot
|
API |
Title |
Description |
| ModifySnapshotAttribute | ModifySnapshotAttribute | Modifies the information about a snapshot. |
| CopySnapshot | Copy snapshot across edge zones | Calls CopySnapshot to copy a snapshot across edge zones. |
Network
|
API |
Title |
Description |
| CreateNetwork | CreateNetwork | Call CreateNetwork to create a virtual private cloud (VPC). |
| CreateClassicNetwork | CreateClassicNetwork | Creates a classic network |
| DeleteNetwork | DeleteNetwork | Deletes a virtual private cloud (VPC). |
| ModifyNetworkAttribute | ModifyNetworkAttribute | Modifies the network information. |
| DescribeNetworkInterfaces | View the network interface card list | Call DescribeNetworkInterfaces to retrieve a list of network interfaces. |
| DescribeNetworkAttribute | Query Network Information | Use DescribeNetworkAttribute to query the configuration of a specific network. |
| CreateEnsRouteEntry | CreateEnsRouteEntry | Creates a custom route entry. |
| DeleteEnsRouteEntry | DeleteEnsRouteEntry | Deletes a custom route entry. |
| DescribeEnsRouteEntryList | DescribeEnsRouteEntryList | Queries route entries. |
vSwitch
|
API |
Title |
Description |
| CreateVSwitch | CreateVSwitch | Creates a VSwitch. |
| DeleteVSwitch | DeleteVSwitch | Deletes a vSwitch. |
| ModifyVSwitchAttribute | ModifyVSwitchAttribute | Call ModifyVSwitchAttribute to modify network information. |
Security group
|
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 | LeaveSecurityGroup | Removes an instance from a 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 | AuthorizeSecurityGroupEgress | Creates an outbound security group rule. This operation allows or denies the outbound traffic from the instances in the security group 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 address (EIP)
|
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 | Query eIPs | Queries elastic IP addresses (EIPs) in Edge Node Service (ENS). |
NAT gateway
|
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 | AddSnatIpForSnatEntry | Adds an elastic IP address (EIP) to a Source Network Address Translation (SNAT) entry. |
| DeleteSnatIpForSnatEntry | DeleteSnatIpForSnatEntry | Deletes an elastic IP address (EIP) from a source network address translation (SNAT) entry. |
| 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 balancer (ELB)
|
API |
Title |
Description |
| ModifyLoadBalancerAttribute | ModifyLoadBalancerAttribute | Modifies the information about an Edge Load Balancer (ELB) instance. |
| DescribeLoadBalancerListenMonitor | DescribeLoadBalancerListenMonitor | Queries monitoring data of an edge load balancer (ELB) instance. |
| DescribeServerLoadBalancerMonitor | DescribeServerLoadBalancerMonitor | Queries the request monitoring data of an edge load balancer (ELB) instance. |
| DescribeServerLoadBalancerListenMonitor | DescribeServerLoadBalancerListenMonitor | Queries the monitoring data of an edge load balancer (ELB) instance based on the listener. |
Elastic network interface
|
API |
Title |
Description |
| CreateNetworkInterface | CreateNetworkInterface | Create an Elastic Network Interface (ENI). |
| DeleteNetworkInterfaces | DeleteNetworkInterfaces | Deletes an elastic network interface (ENI). |
| AttachNetworkInterface | AttachNetworkInterface | Attaches an Elastic Network Interface (ENI) to an Edge Node Service (ECS) 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 VIP
|
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 haVips | Queries high-availability virtual IP addresses (HaVips). |
| AssociateHaVip | AssociateHaVip | Associates a high-availability virtual IP address (HAVIP) with an Edge Node Service (ENS) instance or elastic network interface (ENI). |
| UnassociateHaVip | UnassociateHaVip | Disassociates a high-availability virtual IP address (HAVIP) from an Edge Node Service (ENS) instance or Elastic Network Interface (ENI). |
Network ACL
|
API |
Title |
Description |
| CreateNetworkAcl | CreateNetworkAcl | Creates a network access control list (ACL). |
| DeleteNetworkAcl | DeleteNetworkAcl | Deletes a network access control list (ACL). |
| DescribeNetworkAcls | View the list of network ACLs | You can invoke the DescribeNetworkAcls API to query created network ACLs. |
| AccosicateNetworkAcl | Associate a network ACL with a network | Calls the AccosicateNetworkAcl operation to attach a network ACL to a network. |
| UnassociateNetworkAcl | UnassociateNetworkAcl | Disassociates a network access control list (ACL) from a network. |
| CreateNetworkAclEntry | Create a network ACL rule | You can invoke the CreateNetworkAclEntry API to create a network ACL rule. |
| DeleteNetworkAclEntry | DeleteNetworkAclEntry | Deletes a network access control list (ACL) rule. |
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 | Calls DeleteFileSystem to delete a NAS service. |
| ModifyFileSystem | ModifyFileSystem | Modifies the description of a NAS file system. |
| DescribeFileSystems | Query file system information | Query NAS file system information. |
| CreateMountTarget | CreateMountTarget | Creates a mount target. |
| DeleteMountTarget | DeleteMountTarget | Deletes a mount target. |
| DescribeMountTargets | Query mount target information | Queries mount target information by calling DescribeMountTargets. |
Collaborative storage EOS
|
API |
Title |
Description |
| GetOssUsageData | GetOssUsageData | Queries the storage and bandwidth usage within a specific time range. |
| GetOssStorageAndAccByBuckets | GetOssStorageAndAccByBuckets | Queries the storage usage in the previous billing cycle and the cumulative number of calls in this month. |
Storage gateway
|
API |
Title |
Description |
| DescribeStorageGateway | DescribeStorageGateway | Queries storage gateways. |
| CreateStorageGateway | CreateStorageGateway | Creates a storage gateway. |
| DeleteStorageGateway | DeleteStorageGateway | Deletes a storage gateway. |
Storage volume
|
API |
Title |
Description |
| DescribeStorageVolume | DescribeStorageVolume | Queries volumes. |
| CreateStorageVolume | CreateStorageVolume | Creates a storage volume. |
| DeleteStorageVolume | DeleteStorageVolume | Deletes a storage volume. |
Secondary IP address
|
API |
Title |
Description |
| AssignPrivateIpAddresses | AssignPrivateIpAddresses | Assigns secondary private IP addresses to an elastic network interface (ENI). |
| UnassignPrivateIpAddresses | UnassignPrivateIpAddresses | Unassigns secondary private IP addresses from an elastic network interface (ENI). |
Edge container
|
API |
Title |
Description |
| CreateCluster | Create an edge container cluster | Creates an edge container cluster. |
| DeleteCluster | DeleteCluster | Deletes a cluster. |
| DescribeClustersV1 | DescribeClustersV1 | Queries a list of clusters. |
| DescribeClusterDetail | DescribeClusterDetail | Queries details of a cluster. |
| DescribeClusterUserKubeconfig | DescribeClusterUserKubeconfig | A kubeconfig file contains the credentials required for a client to access an Elastic Container instance on Kubernetes (ECK) cluster. The file includes identity and authentication data for accessing the destination cluster. To manage a cluster using kubectl, you must first connect to the cluster with its kubeconfig file. You can call the DescribeClusterUserKubeconfig operation to query the kubeconfig file for a specific cluster. |
| UpdateClusterCertificate | UpdateClusterCertificate | Updates the cluster certificate. |
| CreateClusterNodePool | Create a node pool | Creates a node pool for a cluster. A node pool is a logical collection of nodes that share the same attributes, allowing unified management and O&M operations such as node upgrades and elastic scaling. You can further use the automated O&M capabilities of node pools, including automatic OS CVE vulnerability patching, automatic faulty node recovery, and automatic kubelet and containerd version upgrades, to reduce O&M costs. |
| ScaleClusterNodePool | ScaleClusterNodePool | Call the ScaleClusterNodePool operation to scale out a node pool, which adds more nodes to support your workloads. The count parameter must be greater than the current number of nodes in the pool. If a node pool contains failed nodes, first call the DeleteClusterNodes operation to remove them before scaling out the pool. A scale-out operation typically completes in 5 to 10 minutes. If the operation takes longer than one hour, it has failed. Contact technical support. |
| ModifyClusterNodePool | ModifyClusterNodePool | You can call the ModifyClusterNodePool operation to modify node configurations in a cluster node pool, such as kubelet and node rotation configurations. Modifies configurations in batches and restarts the kubelet, which may affect node and workload operations. Perform this operation during off-peak hours. |
| DeleteClusterNodePool | DeleteClusterNodePool | You can call the DeleteClusterNodePool operation to delete a node pool that you no longer need. When you delete a node pool, all pods on its nodes are also deleted. This action may trigger descheduling. If the pods cannot be rescheduled, your services may be affected. Before you delete the node pool, ensure that the cluster has sufficient resources for rescheduling. |
| AttachInstancesToNodePool | AttachInstancesToNodePool | Adds existing ENS instances to an ECK cluster as worker nodes, or re-adds instances previously removed from a node pool. |
| DescribeClusterAttachScripts | DescribeClusterAttachScripts | To add an existing ENS instance to an ECK cluster as a worker node or re-add a node to a node pool, call the DescribeClusterAttachScripts operation to get the required script. |
| DescribeClusterNodes | DescribeClusterNodes | You can call the DescribeClusterNodes operation to query information about nodes that meet specified criteria. |
| DescribeClusterNodePools | DescribeClusterNodePools | Lists all node pools in a cluster. |
| DeleteClusterNodes | DeleteClusterNodes | You can call this operation to remove one or more nodes from a cluster. The `ReleaseNode` parameter controls whether to release the underlying ENS compute instance, and its default value is `false`. If a node being removed is in the `failed` state, this parameter is ignored and the corresponding compute instance is released by default. For an ENS compute instance attached via a script from the `DescribeAttachScript` operation, this parameter is also ignored, and the instance is not released by default. |
| InitializeENSECKServiceRole | InitializeENSECKServiceRole | Creates a service-linked role (SLR) that grants ENS the permissions to manage your resources. |
| ListAddons | ListAddons | Retrieves details about cluster components. |
| InstallClusterAddons | InstallClusterAddons | To enhance the capabilities of Kubernetes, Edge Kubernetes (ECK) clusters support a variety of components, such as managed core components, applications, logging and monitoring, networking, storage, and security components. You can call the InstallClusterAddons operation to install components by specifying their names and versions. |
| UpgradeClusterAddons | UpgradeClusterAddons | Call the UpgradeClusterAddons operation to upgrade cluster component instances. |
| ModifyClusterAddon | ModifyClusterAddon | Call the ModifyClusterAddon operation to modify the configuration of an installed cluster component. Modifying the configuration may affect your services. We recommend that you assess the impact, perform this operation during off-peak hours, and back up your data in advance. |
| GetClusterAddonInstance | GetClusterAddonInstance | Call the GetClusterAddonInstance operation to query the details of a component in a cluster, including the version, parameter settings, and status of the component instance. |
| ListClusterAddonInstances | List of installed add-on instances in the cluster | Retrieves a list of add-on instances installed in a destination cluster and returns information such as their version and status. |
| UnInstallClusterAddons | UnInstallClusterAddons | The UnInstallClusterAddons operation deletes components from a cluster. You must specify the names of the components that you want to delete. |
| DescribeAddon | DescribeAddon | You can call the DescribeAddon operation to query information about a target component. |
Scenario computing
|
API |
Title |
Description |
| DescribeInstanceSDGStatus | Query the SDG deployment status on an instance | Query the SDG mount status under a specific AIC instance. |
| MountInstanceSDG | MountInstanceSDG | Deploys the SDG that has been attached to instances on the corresponding Android in Container (AIC) instance. |
| UnmountInstanceSDG | UnmountInstanceSDG | Unmounts a shared data group (SDG) from instances. |
| AttachInstanceSDG | Mount an SDG to an instance | Attach an SDG to the corresponding AIC. |
| DetachInstanceSDG | DetachInstanceSDG | Detaches a shared data group (SDG). |
| CreateSDG | Create SDG | Creates a Shared Data Group (SDG) on an AIC instance. |
| DeploySDG | DeploySDG | Deploys shared data groups (SDGs). |
| DeployInstanceSDG | Deploy SDG to an instance | Deploy SDG to a compute instance. |
| CopySDG | CopySDG | Copies a shared data group (SDG) across nodes. |
| PreloadRegionSDG | Preload SDG | Preload the SDG. |
| DescribeSDGs | Query SDG information | Query the information of created shared data groups. |
| DescribeSDG | Query SDG Information | Retrieves the basic information for a Shared Data Group (SDG), including its node preloading details. |
| DescribeSDGDeploymentStatus | Query SDG deployment status | Query the deployment status of SDG. |
| DeleteSDG | DeleteSDG | Deletes a shared data group (SDG). |
| UnloadRegionSDG | UnloadRegionSDG | Deletes preloaded data. |
| RemoveSDG | RemoveSDG | Removes a deployed shared data group (SDG) and restore local storage. |
| RemoveInstanceSDG | RemoveInstanceSDG | Removes a shared data group (SDG) that is attached to the compute instance. |
| SaveSDG | SaveSDG | Saves the disk of a specific device as a shared data group (SDG). |
| RemoveSDGs | RemoveSDGs | Removes all versions of SDG and restores the mount to the local disk. |
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 | Obtain information about ARM servers and AIC instances | Obtain information about ARM servers and AIC instances. |
| RebootARMServerInstance | RebootARMServerInstance | Reboots an Android in Container (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 | RenewARMServerInstance | Renews a subscription Android in Container (AIC) instance. |
| DescribeAICImages | Retrieve image information | Retrieve image information. |
| RecoverAICInstance | RecoverAICInstance | Recovers an Android in Container (AIC) instance on the server. |
| ReleaseAICInstance | ReleaseAICInstance | Releases an Android in Container (AIC) instance from the server. |
Edge application hosting
|
API |
Title |
Description |
| RunServiceSchedule | RunServiceSchedule | Schedules the nearest idle resources including instances and pods for your device based on the user ID and IP address and initializes the virtual environment. |
| DescribeServcieSchedule | DescribeServcieSchedule | You can call the DescribeServcieSchedule to query the real-time status of the instance device or container that is being occupied by the UUID. |
| RescaleDeviceService | RescaleDeviceService | Scales out a bare metal device. |
| DescribeDeviceService | DescribeDeviceService | Queries the properties of instances and virtual devices in a specific edge application. |
| DescribeDataPushResult | Query application data pre-push results | You can invoke DescribeDataPushResult to obtain the pre-push status results of an application's data files on edge zones. |
| DescribeDataDownloadURL | DescribeDataDownloadURL | Queries the download URLs of application data on file servers and returns the file servers on which data is pushed. |
| DescribeDataDistResult | DescribeDataDistResult | Queries the distribution status of data files on edge instances of an application. |
| 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 | DescribeApplication | Queries the basic properties, resources, and container status of an application. |
| UpgradeApplication | UpgradeApplication | Updates the container in an asynchronous manner. You can configure multiple canary release policies. |
| RollbackApplication | RollbackApplication | Rolls back the container version of a specific application. |
| RescaleApplication | Scale an application | Calls the RescaleApplication operation to asynchronously scale resources in or out and complete container deployment or release operations. |
| PushApplicationData | PushApplicationData | Pushes the business or service data of an application to file servers. |
Edge zone resource information
|
API |
Title |
Description |
| DescribeEnsRegions | DescribeEnsRegions | Queries a list of available ENS nodes. |
| DescribeEnsRegionIdResource | DescribeEnsRegionIdResource | Queries node resources. |
| DescribeReservedResource | DescribeReservedResource | Queries the specifications of resources that you can purchase. |
| DescribePrePaidInstanceStock | DescribePrePaidInstanceStock | Queries the specifications of resources that can be purchased in subscription billing mode. |
| DescribeLoadBalancerSpec | DescribeLoadBalancerSpec | Queries the specifications of an Edge Load Balancer (ELB) instance. |
| DescribeCloudDiskTypes | DescribeCloudDiskTypes | The specifications of available resources are queried when you create a disk. |
| DescribeCloudDiskAvailableResourceInfo | DescribeCloudDiskAvailableResourceInfo | Queries the available 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 | DescribeMeasurementData | Queries the metering data of the user. |
| 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 | BatchEventRebootInstance | Reboots a batch of specified resources for associated events, either immediately or at a scheduled time. |
| EventRebootInstance | EventRebootInstance | Reboots an Instance affected by an Operational Event. |
| EventMigrateInstance | EventMigrateInstance | Migrates an instance across physical nodes in response to an O&M event. |
| BatchEventMigrateInstance | BatchEventMigrateInstance | Migrates multiple instances affected by specified events, either immediately or at a scheduled time. |
| EventRedeployInstance | EventRedeployInstance | Redeploys a specified instance either immediately or at a scheduled time. |
| BatchEventRedeployInstance | Batch Deploy Instances | An event to batch redeploy specified resources immediately or on a schedule. |
Others
|
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 | CreateEnsService | Creates an edge service. |
| DescribeNASAvailableResourceInfo | DescribeNASAvailableResourceInfo | Query the resources that you can purchase when creating a NAS file system. |
| CreateEpnInstance | CreateEpnInstance | Creates an edge private network (EPN) instance. |
| DeleteEpnInstance | DeleteEpnInstance | Deletes an edge private network (EPN) instance. |
| DescribeEnsNetDistrict | Query regions where edge service resources can be created | Invoke DescribeEnsNetDistrict to query the regions where edge service resources can be created. |
| DescribeEpnBandWidthData | DescribeEpnBandWidthData | Queries the EPN bandwidth usage. |
| 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 | JoinVSwitchesToEpnInstance | Performs networking. |
| ModifyEpnInstance | ModifyEpnInstance | Modifies an Edge Private Network (EPN) instance. |
| RemovePublicIpsFromEpnInstance | RemovePublicIpsFromEpnInstance | Removes IP addresses from an edge private network (EPN) instance. |
| RemoveVSwitchesFromEpnInstance | RemoveVSwitchesFromEpnInstance | Deletes the networking information. This operation is applicable only for instances that reside in the internal network. |
| StartEpnInstance | StartEpnInstance | Starts an edge network instance. |
| StopEpnInstance | StopEpnInstance | Stops an EPN instance. |
| DescribeEnsResourceUsage | DescribeEnsResourceUsage | Queries the usage summary of ENS virtual machines (VMs), disks, and networks. |
| DescribeInstanceBandwidthDetail | DescribeInstanceBandwidthDetail | Queries the bandwidth details for instances at a 5 minute granularity. |
| ModifyInstanceBootConfiguration | ModifyInstanceBootConfiguration | Modifies the boot configuration of a heterogeneous PC Farm bare metal instance. |
| DescribeEnsRouteTables | DescribeEnsRouteTables | Queries 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 the Configuration of a VSwitch | Call the DescribeVSwitchAttributes operation to query the configuration of a specified vSwitch. |
| ModifyEnsRouteEntry | ModifyEnsRouteEntry | Modifies the name and description of a custom route. |
| ListProductAbilities | ListProductAbilities | Lists all service capabilities. |
| DescribeInstanceBootConfiguration | DescribeInstanceBootConfiguration | Queries the boot configuration of a heterogeneous PC Farm bare metal instance. |
| DescribeForwardEntryAttribute | DescribeForwardEntryAttribute | Queries a DNAT rule. |
| ModifyInstanceNetworkAttribute | ModifyInstanceNetworkAttribute | Modifies the private IP address or vSwitch of a VPC-type ECS instance. |
| CreateSecurityGroupPermissions | CreateSecurityGroupPermissions | Creates an Edge Node Service (ENS) security group rule. |
| DeleteSecurityGroupPermissions | DeleteSecurityGroupPermissions | Deletes an ENS security group rule. |
| ManageAICLogin | ManageAICLogin | Log on to the AIC instance. You can associate or disassociate an AIC instance based on the uploaded AIC public key. |
| ListAICPublicKeys | ListAICPublicKeys | Query the list of AIC public keys that meet the conditions. Paged query is supported. |
| DeleteAICPublicKey | DeleteAICPublicKey | Deletes a specified AIC Public Key. You can only delete a key that is not associated with any resource. |
| ListAICPublicKeyDeliveries | ListAICPublicKeyDeliveries | Queries the related information of AIC public keys. Paged query is supported. |
| ShareAICImage | ShareAICImage | Share the specified AIC image to other users. |
| UploadAICPublicKey | UploadAICPublicKey | Upload a new AIC public key. |
| DescribeSDGSharedDisks | DescribeSDGSharedDisks | Queries details for shared disks in a specified SDG. |
| DescribeClusterKubeConfig | DescribeClusterKubeConfig | Queries the certificate of a Container Service for Kubernetes (ACK) edge cluster. |
| DescribeCluster | DescribeCluster | Queries Container Service for Kubernetes (ACK) edge clusters. |
| DeleteNetworkPeerConnection | DeleteNetworkPeerConnection | Deletes a network peer connection. |
| DescribeNetworkPeerConnections | DescribeNetworkPeerConnections | Call `DescribeNetworkPeerConnections` to query network peer connections. |
| AttachKeyPair | AttachKeyPair | Attaches an SSH key pair to up to 30 instances 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 | DeleteSnatEntry | Deletes a source network address translation (SNAT) entry from a specified SNAT table. |
| DescribeForwardTableEntries | DescribeForwardTableEntries | Queries Destination Network Address Translation (DNAT) entries that you created. |
| DescribeHistoryEvents | DescribeHistoryEvents | Retrieves a list of system events. |
| DescribeImages | DescribeImages | Queries available images. |
| DescribeKeyPairs | DescribeKeyPairs | Queries one or more key pairs. |
| DescribeNatGateways | Query NAT Gateway properties | Invoke DescribeNatGateways to query created NAT Gateways. |
| DescribeNetworks | Query network list | Call DescribeNetworks to retrieve a list of networks. |
| DescribePrice | DescribePrice | Queries the most recent price of an Edge Node Service (ENS) instance. |
| 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 | Call the DescribeVSwitches operation to retrieve information about VSwitches. You use VSwitches to configure private networks. |
| 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 | ImportKeyPair | Imports the public key of a Rivest–Shamir–Adleman (RSA)-encrypted key pair that is generated by a third-party tool. |
| ListTagResources | ListTagResources | Queries tags that are added to Edge Node Service (ENS) instances. |
| 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 | RenewInstance | Renews a subscription instance. |
| TagResources | TagResources | Creates and adds tags to specific Edge Node Service (ENS) resources. |
| UntagResources | UntagResources | Removes user tags from a resource. |
| AddBackendServers | Add backend servers | Adds backend servers. |
| CreateApplication | CreateApplication | Creates an edge application that allows you to manage Edge Node Service (ENS) nodes in containers, bare metal instances, and virtual machines. |
| CreateLoadBalancer | Create a load balancing instance | Creates a load balancing instance by calling the CreateLoadBalancer operation. |
| 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 specified load balancing instance information | Queries the details of a specified load balancing instance. |
| DescribeLoadBalancerHTTPListenerAttribute | DescribeLoadBalancerHTTPListenerAttribute | Queries the configuration of an HTTP listener. |
| DescribeLoadBalancerHTTPSListenerAttribute | DescribeLoadBalancerHTTPSListenerAttribute | Queries the configurations of an HTTPS listener. |
| DescribeLoadBalancerListeners | DescribeLoadBalancerListeners | Queries listeners of Edge Load Balancer (ELB) instances. |
| DescribeLoadBalancerTCPListenerAttribute | DescribeLoadBalancerTCPListenerAttribute | Call the `DescribeLoadBalancerTCPListenerAttribute` operation to query the configuration of a TCP listener. |
| DescribeLoadBalancerUDPListenerAttribute | DescribeLoadBalancerUDPListenerAttribute | Call `DescribeLoadBalancerUDPListenerAttribute` to get a UDP listener's configuration. |
| DescribeLoadBalancers | Query created load balancing instances | Queries 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 | GetBucketLifecycle | Call GetBucketLifecycle to retrieve 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 | PutBucketLifecycle | You can call the PutBucketLifecycle operation to set lifecycle rules for a bucket. |
| RemoveBackendServers | Remove backend servers | Removes backend servers from a Server Load Balancer (SLB) instance. |
| 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 | SetLoadBalancerHTTPSListenerAttribute | Modifies an HTTPS listener. |
| SetLoadBalancerStatus | SetLoadBalancerStatus | Modifies the status of an Edge Load Balancer (ELB) instance. |
| SetLoadBalancerTCPListenerAttribute | Modify TCP listener attributes | Modifies the configuration of a TCP listener. |
| SetLoadBalancerUDPListenerAttribute | SetLoadBalancerUDPListenerAttribute | Call `SetLoadBalancerUDPListenerAttribute` to modify a UDP listener. |
| StartLoadBalancerListener | StartLoadBalancerListener | Enables a listener. |
| StopLoadBalancerListener | StopLoadBalancerListener | Disables a listener. |