On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
SDK Sample Code
Status Codes
Error Codes

Show all

Help Center/ Elastic Load Balance/ API Reference/ APIs (V3)/ Load Balancer/ Upgrading a Load Balancer

Upgrading a Load Balancer

Updated on 2025-02-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to upgrade a shared load balancer to a dedicated load balancer. Shared load balancers can be upgraded to dedicated load balancers, but dedicated load balancers cannot be downgraded to shared load balancers.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/upgrade

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the ID of the project where the load balancer is used.
loadbalancer_id	Yes	String	Specifies the load balancer ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the token used for IAM authentication.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Specifies the action of an upgrade. start: starts the upgrade. This action is supported only when provisioning_status of the load balancer is ACTIVE. complete: confirms the upgrade. This action is supported only when provision_status of the load balancer is UPGRADED. After the confirmation, the operation cannot be rolled back. rollback: rollbacks the upgrade. This action is supported only when provision_status of the load balancer is UPGRADED, UPGRADE_FAILED, or ROLLBACK_FAILED.
l4_flavor_id	No	String	Specifies the Layer 4 specification ID. This parameter is valid only when action is start. This parameter is mandatory when the load balancer has a Layer 4 listener. l4_flavor_id and l7_flavor_id cannot be left blank at the same time.
l7_flavor_id	No	String	Specifies the Layer 7 specification ID. This parameter is valid only when action is start. This parameter is mandatory when the load balancer has a Layer 7 listener. l4_flavor_id and l7_flavor_id cannot be left blank at the same time.
availability_zone_list	No	Array of strings	Specifies AZs. This parameter is valid and required when action is start. You can query the AZs by calling the API (GET https://{ELB_Endpoint}/v3/{project_id}/elb/availability-zones) Select one or more AZs in the same set.
ipv6_vip_virsubnet_id	No	String	Specifies the ID of the IPv6 subnet where the load balancer works. If you want to use the load balancer to distribute IPv6 requests, this parameter is required. You can query parameter id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets) Note: The subnet defined by ipv6_vip_virsubnet_id must in the VPC to which the original shared load balancer works. IPv6 must be enabled for the subnet defined by ipv6_vip_virsubnet_id.
ipv6_vip_address	No	String	Specifies the virtual IPv6 address bound to the load balancer. The IP address must be from the IPv6 subnet where the load balancer resides and should not be used by other services. Note: ipv6_vip_virsubnet_id is also required if ipv6_vip_address is specified. If only ipv6_vip_virsubnet_id is specified, the system will automatically assign a private IPv6 address to the load balancer. If neither ipv6_vip_address nor ipv6_vip_virsubnet_id is specified, no private IPv6 address will be assigned, and the value of ipv6_vip_address will be null.
elb_virsubnet_ids	No	Array of strings	Specifies the IDs of subnets on the downstream plane. This parameter is valid only when action is start. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets). If this parameter is not specified, the subnet IDs specified in vip_subnet_cidr_id will be used. The subnets must be in the VPC where the load balancer works.
prepaid_options	No	UpgradePrepaidOption object	Shows the yearly/monthly billing information. If this parameter is passed, a yearly/monthly load balancer will be created. This parameter is unsupported. Please do not use it.

**Table 4** UpgradePrepaidOption
Parameter	Mandatory	Type	Description
period_type	Yes	String	Specifies the subscription period type. Value options: month: monthly subscription year: yearly subscription
period_num	No	Integer	Specifies the number of subscription periods. Value options: The value ranges from 1 to 9, if period_type is set to month. The value ranges from 1 to 3, if period_type is set to year.
resource_package_type	Yes	Array of strings	Specifies the dedicated package.
auto_pay	No	Boolean	Specifies whether an order is automatically paid using your account balance without manual operations. Constraints: If you use automatic payment, only your account balance can be used. If you want to use a voucher, disable automatic payment and select the voucher for the payment in the Billing Center. Value options: true: Enable automatic payment. false: Disable automatic payment.

Response Parameters

Status code: 202

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID. Note: The value is automatically generated.
job_id	String	Specifies the upgrade task ID.

Example Requests

Example: Upgrading a shared load balancer with action set to start

POST https://{ELB_Endpoint}/v3/060576798a80d5762fafc01a9b5eedc7/elb/loadbalancers/2c0b5b97-221b-4136-afc2-15d6570f31cb/upgrade

{
  "action" : "start",
  "availability_zone_list" : [ "AZ1" ],
  "elb_virsubnet_ids" : [ "5eddff5a-f45f-46d7-9f2b-70dc669feff9" ],
  "l4_flavor_id" : "f3c46bc2-1304-40b4-902b-cefae3858d17",
  "l7_flavor_id" : "1b333094-bd31-4cb8-97e2-ea762fde3576"
}

Example Responses

Status code: 202

The request has been received and is being processed.

{
  "request_id" : "841e0da7-5835-4130-9a47-01688f34a154",
  "job_id" : "062804a2-9e39-4dde-bd9b-271859ee312b"
}

SDK Sample Code

The SDK sample code is as follows.

Java
Python
Go
More

Example: Upgrading a shared load balancer with action set to start

      
       
         
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpgradeLoadbalancerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        UpgradeLoadbalancerRequest request = new UpgradeLoadbalancerRequest();
        request.withLoadbalancerId("{loadbalancer_id}");
        UpgradeV3RequestBody body = new UpgradeV3RequestBody();
        List<String> listbodyElbVirsubnetIds = new ArrayList<>();
        listbodyElbVirsubnetIds.add("5eddff5a-f45f-46d7-9f2b-70dc669feff9");
        List<String> listbodyAvailabilityZoneList = new ArrayList<>();
        listbodyAvailabilityZoneList.add("AZ1");
        body.withElbVirsubnetIds(listbodyElbVirsubnetIds);
        body.withAvailabilityZoneList(listbodyAvailabilityZoneList);
        body.withL7FlavorId("1b333094-bd31-4cb8-97e2-ea762fde3576");
        body.withL4FlavorId("f3c46bc2-1304-40b4-902b-cefae3858d17");
        body.withAction(UpgradeV3RequestBody.ActionEnum.fromValue("start"));
        request.withBody(body);
        try {
            UpgradeLoadbalancerResponse response = client.upgradeLoadbalancer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      
     

Example: Upgrading a shared load balancer with action set to start

      
       
         
         # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpgradeLoadbalancerRequest()
        request.loadbalancer_id = "{loadbalancer_id}"
        listElbVirsubnetIdsbody = [
            "5eddff5a-f45f-46d7-9f2b-70dc669feff9"
        ]
        listAvailabilityZoneListbody = [
            "AZ1"
        ]
        request.body = UpgradeV3RequestBody(
            elb_virsubnet_ids=listElbVirsubnetIdsbody,
            availability_zone_list=listAvailabilityZoneListbody,
            l7_flavor_id="1b333094-bd31-4cb8-97e2-ea762fde3576",
            l4_flavor_id="f3c46bc2-1304-40b4-902b-cefae3858d17",
            action="start"
        )
        response = client.upgrade_loadbalancer(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      
     

Example: Upgrading a shared load balancer with action set to start

      
       
         
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpgradeLoadbalancerRequest{}
	request.LoadbalancerId = "{loadbalancer_id}"
	var listElbVirsubnetIdsbody = []string{
        "5eddff5a-f45f-46d7-9f2b-70dc669feff9",
    }
	var listAvailabilityZoneListbody = []string{
        "AZ1",
    }
	l7FlavorIdUpgradeV3RequestBody:= "1b333094-bd31-4cb8-97e2-ea762fde3576"
	l4FlavorIdUpgradeV3RequestBody:= "f3c46bc2-1304-40b4-902b-cefae3858d17"
	request.Body = &model.UpgradeV3RequestBody{
		ElbVirsubnetIds: &listElbVirsubnetIdsbody,
		AvailabilityZoneList: &listAvailabilityZoneListbody,
		L7FlavorId: &l7FlavorIdUpgradeV3RequestBody,
		L4FlavorId: &l4FlavorIdUpgradeV3RequestBody,
		Action: model.GetUpgradeV3RequestBodyActionEnum().START,
	}
	response, err := client.UpgradeLoadbalancer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Example: Upgrading a shared load balancer with action set to start

      
       
         
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpgradeLoadbalancerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        UpgradeLoadbalancerRequest request = new UpgradeLoadbalancerRequest();
        request.withLoadbalancerId("{loadbalancer_id}");
        UpgradeV3RequestBody body = new UpgradeV3RequestBody();
        List<String> listbodyElbVirsubnetIds = new ArrayList<>();
        listbodyElbVirsubnetIds.add("5eddff5a-f45f-46d7-9f2b-70dc669feff9");
        List<String> listbodyAvailabilityZoneList = new ArrayList<>();
        listbodyAvailabilityZoneList.add("AZ1");
        body.withElbVirsubnetIds(listbodyElbVirsubnetIds);
        body.withAvailabilityZoneList(listbodyAvailabilityZoneList);
        body.withL7FlavorId("1b333094-bd31-4cb8-97e2-ea762fde3576");
        body.withL4FlavorId("f3c46bc2-1304-40b4-902b-cefae3858d17");
        body.withAction(UpgradeV3RequestBody.ActionEnum.fromValue("start"));
        request.withBody(body);
        try {
            UpgradeLoadbalancerResponse response = client.upgradeLoadbalancer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      
     

Example: Upgrading a shared load balancer with action set to start

      
       
         
         # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpgradeLoadbalancerRequest()
        request.loadbalancer_id = "{loadbalancer_id}"
        listElbVirsubnetIdsbody = [
            "5eddff5a-f45f-46d7-9f2b-70dc669feff9"
        ]
        listAvailabilityZoneListbody = [
            "AZ1"
        ]
        request.body = UpgradeV3RequestBody(
            elb_virsubnet_ids=listElbVirsubnetIdsbody,
            availability_zone_list=listAvailabilityZoneListbody,
            l7_flavor_id="1b333094-bd31-4cb8-97e2-ea762fde3576",
            l4_flavor_id="f3c46bc2-1304-40b4-902b-cefae3858d17",
            action="start"
        )
        response = client.upgrade_loadbalancer(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      
     

Example: Upgrading a shared load balancer with action set to start

      
       
         
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpgradeLoadbalancerRequest{}
	request.LoadbalancerId = "{loadbalancer_id}"
	var listElbVirsubnetIdsbody = []string{
        "5eddff5a-f45f-46d7-9f2b-70dc669feff9",
    }
	var listAvailabilityZoneListbody = []string{
        "AZ1",
    }
	l7FlavorIdUpgradeV3RequestBody:= "1b333094-bd31-4cb8-97e2-ea762fde3576"
	l4FlavorIdUpgradeV3RequestBody:= "f3c46bc2-1304-40b4-902b-cefae3858d17"
	request.Body = &model.UpgradeV3RequestBody{
		ElbVirsubnetIds: &listElbVirsubnetIdsbody,
		AvailabilityZoneList: &listAvailabilityZoneListbody,
		L7FlavorId: &l7FlavorIdUpgradeV3RequestBody,
		L4FlavorId: &l4FlavorIdUpgradeV3RequestBody,
		Action: model.GetUpgradeV3RequestBodyActionEnum().START,
	}
	response, err := client.UpgradeLoadbalancer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
202	The request has been received and is being processed.

Error Codes

See Error Codes.

Parent Topic: Load Balancer

Previous topic: Batch Creating Load Balancers

Next topic: Querying Load Balancers

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot