UpdateLoadBalancerAddressTypeConfig - Server Load Balancer

Modifies the network type of an Application Load Balancer (ALB) instance.

Operation description

Prerequisites

An ALB instance is created. For more information about how to create an ALB instance, see CreateLoadBalancer.
If you want to change the network type from internal-facing to Internet-facing, you must first create an elastic IP address (EIP). For more information, see AllocateEipAddress.

Usage notes

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 GetLoadBalancerAttribute operation to query the status of the task.

If an ALB instance is in the Configuring state, the network type is being changed.
If an ALB instance is in the Active state, the network type has been changed.

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

alb:UpdateLoadBalancerAddressTypeConfig

update

*LoadBalancer

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

alb:AddressType

None

Request parameters

Parameter	Type	Required	Description	Example
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-42665544****
DryRun	string	No	Specifies whether to perform only 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 code 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
LoadBalancerId	string	Yes	The ALB instance ID.	alb-bp1o94dp5i6ea****
AddressType	string	Yes	The new network type. Valid values: Internet: The ALB instance uses a public IP address. The domain name of the ALB instance is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet. Intranet: The ALB instance uses a private IP address. The domain name of the ALB instance is resolved to the private IP address. In this case, the ALB instance can be accessed over the virtual private cloud (VPC) where the ALB instance is deployed.	Internet
ZoneMappings	array<object>	No	The zones and the vSwitches in the zones. You can specify a maximum of 10 zones. If the selected region supports two or more zones, select at least two zones to ensure the high availability of your service.
	object	No	The zones and the vSwitches in the zones.
VSwitchId	string	No	The vSwitch in the zone. You can specify only one vSwitch (subnet) in each zone of an ALB instance. You can specify a maximum of 10 zones. If the selected region supports two or more zones, select at least two zones to ensure the high availability of your service.	vsw-bp10ttov87felojcn****
ZoneId	string	No	The zone ID of the ALB instance. You can specify a maximum of 10 zones. If the selected region supports two or more zones, select at least two zones to ensure the high availability of your service. You can call the DescribeZones operation to query the information about the zone.	cn-hangzhou-a
AllocationId	string	No	The ID of the elastic IP address (EIP). You can specify a maximum of 10 zones. Note This parameter is required if you want to change the network type from internal-facing to Internet-facing.	eip-bp1aedxso6u80u0qf****
EipType	string	No	The type of the EIP. Valid values: Common (default): indicates an EIP Anycast: indicates an Anycast EIP Note For more information about the regions in which ALB supports Anycast EIPs, see Limits.	Common

Response elements

Element	Type	Description	Example
	object	The data struct returned.
RequestId	string	The request ID.	593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
JobId	string	The ID of the asynchronous job.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

{
  "RequestId": "593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.OnlyPostPaidEipSupported	The operation is not allowed because of OnlyPostPaidEipSupported.
400	Mismatch.ZoneIdAndVSwitchId	The ZoneId and VSwitchId are mismatched.
400	IncorrectBusinessStatus.Eip	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	ResourceNotFound.Eip	The specified resource ResourceNotFound.Eip is not found.
400	IncorrectStatus.CommonBandwidthPackage	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.CommonBandwidthPackage	The business status of %s [%s] is incorrect.
400	OperationDenied.AddressTypeNotChanged	The operation is not allowed because of AddressTypeNotChanged.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
404	ResourceNotFound.CommonBandwidthPackage	The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.