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

Prerequisites

An Application Load Balancer (ALB) instance is created. For more information about how to create an ALB instance, see CreateLoadBalancer.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateLoadBalancerAddressTypeConfig

The operation that you want to perform. Set the value to UpdateLoadBalancerAddressTypeConfig.

ClientToken String No 123e4567-e89b-12d3-a456-42665544****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun String No true

Specifies whether to check the request without modifying the network type of the ALB instance. Valid values:

  • true: checks the request without modifying the network type of the ALB instance. The system checks the required parameters, request syntax, and limits. If the request fails the check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the API request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed.
LoadBalancerId String Yes lb-bp1o94dp5i6ea****

The ID of the ALB instance.

AddressType String Yes Internet

The new network type of the ALB instance.

ZoneMappings Array No

The zones and the vSwitches in the zones. You must specify at least two zones.

VSwitchId String No vsw-test12345

The ID of the vSwitch in the zone. Each zone can contain only one vSwitch and one subnet.

ZoneId String No cn-hangzhou-onebox-nebula-a

The name of the zone where the ALB instance resides.

AllocationId String No eip-bp1aedxso6u80u0qf****

The ID of the elastic IP address (EIP).

Response parameters

Parameter Type Example Description
RequestId String 593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3

The ID of the request.

JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

The ID of the asynchronous task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateLoadBalancerAddressTypeConfig
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&DryRun=true
&LoadBalancerId=lb-bp1o94dp5i6ea****
&AddressType=Internet
&ZoneMappings=[{"VSwitchId":"vsw-test12345","ZoneId":"cn-hangzhou-onebox-nebula-a","AllocationId":"eip-bp1aedxso6u80u0qf****"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateLoadBalancerAddressTypeConfigResponse>
    <RequestId>593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3</RequestId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</UpdateLoadBalancerAddressTypeConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 OperationDenied.OnlyPostPaidEipSupported The operation is not allowed because of OnlyPostPaidEipSupported. The error message returned because only pay-as-you-go EIPs are supported.
400 Mismatch.ZoneIdAndVSwitchId The ZoneId and VSwitchId are mismatched. The error message returned because the zone ID does not match the vSwitch ID.
400 IncorrectStatus.CommonBandwidthPackage The status of CommonBandwidthPackage [%s] is incorrect. The error message returned because the status of the EIP bandwidth plan [%s] is invalid.
400 IncorrectBusinessStatus.CommonBandwidthPackage The business status of CommonBandwidthPackage [%s] is incorrect. The error message returned because the service status of the EIP bandwidth plan [%s] is invalid.
400 IncorrectBusinessStatus.Eip The business status of %s [%s]  is incorrect. The error message returned because the service status of the specified resource %s [%s] is invalid.
400 ResourceNotFound.Eip The specified resource ResourceNotFound.Eip is not found. The error message returned because the specified EIP does not exist.
400 ResourceNotFound.CommonBandwidthPackage The specified resource CommonBandwidthPackage is not found. The error message returned because the specified EIP bandwidth plan does not exist.

For a list of error codes, visit the API Error Center.