Use UpdateLoadBalancerAddressTypeConfig to change the IPv4 network type of a Network Load Balancer - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Changes the network type of the IPv4 address for a Network Load Balancer (NLB) instance.

Operation description

Make sure that an NLB instance is created. For more information, see CreateLoadBalancer.
You can call the GetLoadBalancerAttribute operation to query the AddressType value of an NLB instance after you change the network type.
UpdateLoadBalancerAddressTypeConfig is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetJobStatus operation to query the task status:
- If the task is in the Succeeded state, the network type of the IPv4 address of the NLB instance is changed.
- If the task is in the Processing state, the network type of the IPv4 address of the NLB instance is being changed. In this case, you can perform only query operations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nlb:UpdateLoadBalancerAddressTypeConfig

update

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

nlb:AddressType

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the NLB instance.	nlb-83ckzc8d4xlp8o****
AddressType	string	Yes	The new network type. Valid values: Internet: The nodes of an Internet-facing NLB instance have public IP addresses. The DNS name of an Internet-facing NLB instance is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing NLB instances can route requests from clients over the Internet. Intranet: The nodes of an internal-facing NLB instance have only private IP addresses. The DNS name of an internal-facing NLB instance is publicly resolvable to the private IP addresses of the nodes. Therefore, internal-facing NLB instances can route requests only from clients with access to the virtual private cloud (VPC) for the NLB instance.	Internet
ZoneMappings	array<object>	No	The mappings between zones and vSwitches. You can specify up to 10 zones.
	object	No	The mapping between the zone and a vSwitch in the zone.
VSwitchId	string	No	The ID of the vSwitch in the zone. You can specify only one vSwitch (subnet) in each zone of an NLB instance.	vsw-bp10ttov87felojcn****
ZoneId	string	No	The zone ID of the NLB instance. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-a
AllocationId	string	No	The ID of the elastic IP address (EIP).	eip-bp1aedxso6u80u0qf****
EipType	string	No	The type of the EIP. Valid values: Common: an EIP Anycast: an Anycast EIP Note This parameter is required only if AddressType is set to Internet.	Common
DryRun	boolean	No	Perform a dry run without actually making the request. Valid values are: true: Perform only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the check, an error message specifying the issue is returned. If the request passes, the `DryRunOperation` error code is returned. false (default): Check the request and perform the operation. If the request passes the check, a 2xx HTTP status code is returned, and the operation is performed.	false
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate this value. Ensure that the value is unique among all requests. Only ASCII characters are allowed. Note If you do not specify this parameter, the value of RequestId is used.** RequestId** of each request is different.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The region ID of the NLB instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Changes the network type of the IPv4 address of an NLB instance.
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DuplicatedParam.AllocationId	The param of AllocationId is duplicated.
400	ResourceInConfiguring.loadbalancer	The specified resource of loadbalancer is being configured, please try again later.	The specified resource of loadbalancer is being configured, please try again later.
400	OperationDenied.EipAlreadyInBandwidthPackage	The operation is not allowed because of EipAlreadyInBandwidthPackage.
400	ResourceInConfiguring.%s	The specified resource of %s is being configured, please try again later.
400	OperationDenied.AddressTypeNotChanged	The operation is not allowed because of AddressTypeNotChanged.
400	Mismatch.ZoneIdAndVswitchId	The ZoneIdAndVswitchId is mismatched for %s and %s.
400	TagInvokeError	listTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	IllegalParam	The param of %s is illegal.
400	Throttling.User	Request was denied due to api flow control.	Request was denied due to api flow control.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	The specified load balancer resource was not found. Please check the input parameters.
404	ResourceNotFound.AnycastInstance	The specified resource of AnycastInstance is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.