API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Nlb/2022-04-30) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Network Load Balancer instances
|
API |
Title |
Description |
| CreateLoadBalancer | CreateLoadBalancer | Creates a Network Load Balancer (NLB) instance in a specified region. |
| UpdateLoadBalancerAddressTypeConfig | UpdateLoadBalancerAddressTypeConfig | Changes the network type of the IPv4 address for a Network Load Balancer (NLB) instance. |
Listeners
|
API |
Title |
Description |
| CreateListener | CreateListener | Creates a TCP, UDP, or TCP/SSL listener for a Network Load Balancer (NLB) instance. |
| UpdateListenerAttribute | UpdateListenerAttribute | Updates the attributes of a listener, such as the name and the idle connection timeout period. |
Server groups
|
API |
Title |
Description |
| CreateServerGroup | CreateServerGroup | Creates a server group in a specified region. |
| UpdateServerGroupAttribute | UpdateServerGroupAttribute | Updates the configuration of a Network Load Balancer (NLB) server group. |
Security policy management
|
API |
Title |
Description |
| CreateSecurityPolicy | CreateSecurityPolicy | Creates a custom security policy for a TCP/SSL listener. |
| UpdateSecurityPolicyAttribute | UpdateSecurityPolicyAttribute | Modifies the configurations of a security policy for a Network Load Balancer (NLB) instance. |
| ListSecurityPolicy | ListSecurityPolicy | Queries the TLS security policies set for a Network Load Balancer (NLB) instance. |
Asynchronous tasks
|
API |
Title |
Description |
| ListAsynJobs | ListAsynJobs | Queries the results of multiple asynchronous operations performed on a Network Load Balancer (NLB) instance. |
Others
|
API |
Title |
Description |
| AddServersToServerGroup | AddServersToServerGroup | Adds backend servers to a specified server group. |
| AssociateAdditionalCertificatesWithListener | AssociateAdditionalCertificatesWithListener | Associates additional certificates with a listener that uses SSL over TCP. |
| AttachCommonBandwidthPackageToLoadBalancer | AttachCommonBandwidthPackageToLoadBalancer | Associates an Internet Shared Bandwidth instance with a Network Load Balancer (NLB) instance. |
| CancelShiftLoadBalancerZones | CancelShiftLoadBalancerZones | Adds the elastic IP address (EIP) and virtual IP address (VIP) of a zone to the DNS record. |
| DeleteListener | DeleteListener | Deletes a Network Load Balancer (NLB) listener. |
| DeleteLoadBalancer | DeleteLoadBalancer | Deletes a Network Load Balancer (NLB) instance. |
| DeleteSecurityPolicy | DeleteSecurityPolicy | Deletes a custom TLS security policy from a Network Load Balancer (NLB) instance. |
| DeleteServerGroup | DeleteServerGroup | Deletes a Network Load Balancer (NLB) server group. |
| DescribeHdMonitorRegionConfig | DescribeHdMonitorRegionConfig | Queries the storage configurations of fine-grained monitoring. |
| DescribeRegions | DescribeRegions | Queries regions that support Network Load Balancer (NLB) instances. |
| DescribeZones | DescribeZones | Queries the zones of a region in which a Network Load Balancer (NLB) instance is deployed. |
| DetachCommonBandwidthPackageFromLoadBalancer | DetachCommonBandwidthPackageFromLoadBalancer | Disassociates a Network Load Balancer (NLB) instance from an Internet Shared Bandwidth instance. |
| DisableLoadBalancerIpv6Internet | DisableLoadBalancerIpv6Internet | Changes the public IPv6 address of a dual-stack Network Load Balancer (NLB) instance to a private IPv6 address. |
| DisassociateAdditionalCertificatesWithListener | DisassociateAdditionalCertificatesWithListener | Disassociates additional certificates from a listener that uses SSL over TCP. |
| EnableLoadBalancerIpv6Internet | EnableLoadBalancerIpv6Internet | Changes the network type of the IPv6 address of a dual-stack Network Load Balancer (NLB) instance from internal-facing to Internet-facing. |
| GetJobStatus | GetJobStatus | Queries the result of an asynchronous operation performed on a Network Load Balancer (NLB) instance. |
| GetListenerAttribute | GetListenerAttribute | Queries the details of a Network Load Balancer (NLB) listener. |
| GetListenerHealthStatus | GetListenerHealthStatus | Queries the health check status of a Network Load Balancer (NLB) listener. |
| GetLoadBalancerAttribute | GetLoadBalancerAttribute | Queries the details about a Network Load Balancer (NLB) instance. |
| ListListenerCertificates | ListListenerCertificates | Queries the server certificate of a TCP/SSL listener. |
| ListListeners | ListListeners | Queries listeners added to a Network Load Balancer (NLB) instance. |
| ListLoadBalancers | ListLoadBalancers | Queries the basic information about Network Load Balancer (NLB) instances. |
| ListServerGroupServers | ListServerGroupServers | Queries servers in a server group of a Network Load Balancer (NLB) instance. |
| ListServerGroups | ListServerGroups | Queries the server groups of a Network Load Balancer (NLB) instance. |
| ListSystemSecurityPolicy | ListSystemSecurityPolicy | Queries the default TLS policy. |
| ListTagResources | ListTagResources | Queries the tags of a resource. |
| LoadBalancerJoinSecurityGroup | LoadBalancerJoinSecurityGroup | Associates a security group with a Network Load Balancer (NLB) instance. |
| LoadBalancerLeaveSecurityGroup | LoadBalancerLeaveSecurityGroup | Disassociates a Network Load Balancer (NLB) instance from a security group. |
| MoveResourceGroup | MoveResourceGroup | Modify the group of resource. |
| RemoveServersFromServerGroup | RemoveServersFromServerGroup | Deletes server groups from a Network Load Balancer (NLB) instance. |
| SetHdMonitorRegionConfig | SetHdMonitorRegionConfig | Configures storage for fine-grained monitoring. |
| StartListener | StartListener | Enables a Network Load Balancer (NLB) listener. |
| StartShiftLoadBalancerZones | StartShiftLoadBalancerZones | Removes the elastic IP address (EIP) or virtual IP address (VIP) used in a zone from the DNS record. |
| StopListener | StopListener | Stops a listener of a Network Load Balancer (NLB) instance. |
| TagResources | TagResources | Adds tags to specified resources. |
| UntagResources | UntagResources | Removes tags from resources. |
| UpdateLoadBalancerAttribute | UpdateLoadBalancerAttribute | Updates the attributes, including the name, of a Network Load Balancer (NLB) instance. |
| UpdateLoadBalancerProtection | UpdateLoadBalancerProtection | Enables or disables the deletion protection feature. |
| UpdateLoadBalancerZones | UpdateLoadBalancerZones | Modifies the zones and zone attributes of a Network Load Balancer (NLB) instance. |
| UpdateServerGroupServersAttribute | UpdateServerGroupServersAttribute | Modifies the weights and descriptions of backend servers in a server group of a Network Load Balancer (NLB) instance. |