UpdateLoadBalancerAddressTypeConfig-阿里云帮助中心

Changing the network type of an application load balancer instance.

Operation description

Prerequisites

You have created an Application Load Balancer (ALB) instance. For more information, see CreateLoadBalancer.
To change the network type of an ALB instance from Intranet to Internet, you must create an elastic IP address. For more information, see AllocateEipAddress.

Usage notes

The UpdateLoadBalancerAddressTypeConfig operation is an asynchronous task. After you send a request, the system returns a request ID and runs the task in the background. The network type of the ALB instance is not immediately modified. You can call the GetLoadBalancerAttribute operation to query the status of the ALB instance:

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

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 generate a value from your client to make sure that the value 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 RequestId of the request as the ClientToken. The RequestId of each request is unique.	123e4567-e89b-12d3-a456-42665544****
DryRun	string	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, 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): sends the request. If the request passes the check, the system returns a 2xx HTTP status code and performs the operation.	false
LoadBalancerId	string	Yes	The ID of the Application Load Balancer (ALB) instance.	alb-bp1o94dp5i6ea****
AddressType	string	Yes	The target network type. Valid values: Internet: The load balancer is assigned a public IP address and can be accessed over the Internet. Its DNS domain name is resolved to the public IP address. Intranet: The load balancer is assigned a private IP address and can be accessed only from the VPC where it is deployed. Its DNS domain name is resolved to the private IP address.	Internet
ZoneMappings	array<object>	No	The mappings between availability zones and vSwitches. You can specify up to 10 mappings. If the region supports two or more availability zones, you must specify mappings for at least two.
	object	No	The mappings between availability zones and vSwitches.
VSwitchId	string	No	The ID of the vSwitch in the specified availability zone. You can specify only one vSwitch for each availability zone.	vsw-bp10ttov87felojcn****
ZoneId	string	No	The ID of the availability zone of the ALB instance. You can call the DescribeZones operation to query information about availability zones.	cn-hangzhou-a
AllocationId	string	No	The ID of the elastic IP address (EIP). Note This parameter is required when you change the network type from Intranet to Internet.	eip-bp1aedxso6u80u0qf****
EipType	string	No	The type of the EIP. Valid values: Common (default): a regular EIP. Anycast: Anycast EIP. Note For the regions where Application Load Balancer (ALB) supports binding Anycast Elastic IP addresses (EIPs), see Usage limits.	Common

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
JobId	string	The ID of the asynchronous task.	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.