A comprehensive reference for all API operations - Network Load Balancer - Alibaba Cloud - Server Load Balancer

API standards and multilingual preset SDKs

The OpenAPI of this product (Nlb/2022-04-30) 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.

Monitoring

API	Title	Description
UpdateLoadBalancerAddressTypeConfig	UpdateLoadBalancerAddressTypeConfig	Changes the network type of the IPv4 address for a Network Load Balancer (NLB) instance.
UpdateLoadBalancerZones	UpdateLoadBalancerZones	Modifies the zones and zone attributes of a Network Load Balancer (NLB) instance.

Instances

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.
ListListeners	ListListeners	Queries listeners added to a Network Load Balancer (NLB) instance.
GetListenerAttribute	GetListenerAttribute	Queries the details of a Network Load Balancer (NLB) listener.

Listeners

API	Title	Description
CreateServerGroup	Create a server group	Creates a server group in a specified region.
UpdateServerGroupAttribute	Update server group configuration	Updates the configuration of a Network Load Balancer (NLB) server group.
ListServerGroups	Query server groups	Queries the server group list of a Network Load Balancer (NLB) load balancing instance.

Listener certificates

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.

Server groups

API	Title	Description
ListAsynJobs	ListAsynJobs	Queries the results of multiple asynchronous operations performed on a Network Load Balancer (NLB) instance.

Shared bandwidth packages

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.
CreateLoadBalancer	CreateLoadBalancer	Creates a Network Load Balancer (NLB) instance in a specified region.
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.
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.
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.
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.
UpdateServerGroupServersAttribute	UpdateServerGroupServersAttribute	Modifies the weights and descriptions of backend servers in a server group of a Network Load Balancer (NLB) instance.