UpdateLoadBalancerAddressTypeConfig - 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nlb:UpdateLoadBalancerAddressTypeConfig	update	LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The NLB instance ID.	nlb-83ckzc8d4xlp8o****
AddressType	string	Yes	The new network type. Valid values: Internet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. Therefore, the NLB instance can be accessed over the Internet. Intranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. In this case, the NLB instance can be accessed over the virtual private cloud (VPC) where the NLB instance is deployed.	Internet
ZoneMappings	array<object>	No	The mappings between zones and vSwitches. You can specify at most 10 zones in each call.
ZoneMapping	object	No
VSwitchId	string	No	The ID of the vSwitch in the zone. Each zone can contain only one vSwitch and one subnet.	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 Anycast Note Anycast EIPs are supported only by NLB instances in the China (Hong Kong) region. This parameter is required when AddressType is set to Internet.	Common
DryRun	boolean	No	Specifies whether to perform a dry run, without performing the actual request. Valid values: true: performs 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 dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false(default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	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 parameters

Parameter	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

Sample success responses

JSONformat

{
  "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.	-
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.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-04	The Error code has changed	View Change Details
2024-01-22	The Error code has changed	View Change Details
2023-10-30	The Error code has changed	View Change Details
2023-09-12	The Error code has changed	View Change Details
2023-09-05	The Error code has changed	View Change Details
2023-08-22	The Error code has changed	View Change Details