All Products
Search

This Product

    Server Load Balancer:UpdateLoadBalancerAddressTypeConfig

    Document Center

    Server Load Balancer:UpdateLoadBalancerAddressTypeConfig

    Last Updated:Mar 01, 2024

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

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    alb:UpdateLoadBalancerAddressTypeConfigWrite
    • LoadBalancer
      acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
    • alb:AddressType
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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****
    DryRunstringNo

    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
    LoadBalancerIdstringYes

    The ALB instance ID.

    		lb-bp1o94dp5i6ea****
    AddressTypestringYes

    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
    ZoneMappingsobject []No

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

    VSwitchIdstringNo

    The ID of the vSwitch in the zone. You can specify only one vSwitch (subnet) in each zone of an ALB instance. You can specify up to 10 vSwitch IDs.

    		vsw-bp10ttov87felojcn****
    ZoneIdstringNo

    The ID of the zone where the ALB instance is deployed. You can specify up to 10 zone IDs.

    You can call the DescribeZones operation to query the most recent zone list.

    		cn-hangzhou-a
    AllocationIdstringNo

    The ID of an EIP instance. You can specify up to 10 zone IDs.

    Note This parameter is required if you want to change the network type from internal-facing to Internet-facing.
    		eip-bp1aedxso6u80u0qf****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The data struct returned.

    RequestIdstring

    The request ID.

    		593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
    JobIdstring

    The ID of the asynchronous job.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400OperationDenied.OnlyPostPaidEipSupportedThe operation is not allowed because of OnlyPostPaidEipSupported.-
    400Mismatch.ZoneIdAndVSwitchIdThe ZoneId and VSwitchId are mismatched.-
    400IncorrectStatus.CommonBandwidthPackageThe status of CommonBandwidthPackage [%s] is incorrect.-
    400IncorrectBusinessStatus.CommonBandwidthPackageThe business status of CommonBandwidthPackage [%s] is incorrect.-
    400IncorrectBusinessStatus.EipThe business status of %s [%s]  is incorrect.The business status of %s [%s]  is incorrect.
    400ResourceNotFound.EipThe specified resource ResourceNotFound.Eip is not found.-
    400ResourceNotFound.CommonBandwidthPackageThe specified resource CommonBandwidthPackage is not found.-
    400OperationDenied. AddressTypeNotChangedThe address type of the specified loadbalancer has not been changed-

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

    Change history

    Change timeSummary of changesOperation
    2024-01-29The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2024-01-29The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Added Error Codes: 404
    2021-10-27Add Operationsee changesets