Upgrading a Load Balancer
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
loadbalancer_id |
Yes |
String |
Definition: Specifies the ID of the load balancer to be upgraded. Constraints: N/A Range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
Yes |
String |
Definition: Specifies the action of an upgrade. Constraints: N/A Range:
Default value: N/A |
l4_flavor_id |
No |
String |
Definition: Specifies the ID of a flavor at Layer 4. This parameter is valid only when action is start. Constraints:
Range: N/A Default value: N/A |
l7_flavor_id |
No |
String |
Definition: Specifies the ID of a flavor at Layer 7. This parameter is valid only when action is start. Constraints:
Range: N/A Default value: N/A |
availability_zone_list |
No |
Array of strings |
Definition: Specifies the list of AZs where the load balancers can be created. 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. Constraints: N/A Range: N/A Default value: N/A |
ipv6_vip_virsubnet_id |
No |
String |
Definition: Specifies the ID of the IPv6 subnet where the load balancer works. You can query parameter id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets). Constraints:
Range: N/A Default value: N/A |
ipv6_vip_address |
No |
String |
Definition: Specifies the private IPv6 address of the load balancer. Constraints:
Range: N/A Default value: N/A |
elb_virsubnet_ids |
No |
Array of strings |
Definition: Specifies the network IDs of subnets on the downstream plane. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets). Constraints:
Range: N/A Default value: N/A |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
job_id |
String |
Definition: Specifies the upgrade task ID. Range: N/A |
Example Requests
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
Successful request.
{ "request_id" : "841e0da7-5835-4130-9a47-01688f34a154", "job_id" : "062804a2-9e39-4dde-bd9b-271859ee312b" }
SDK Sample Code
The SDK sample code is as follows.
Upgrading a shared load balancer with action set to start
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
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()); } } } |
Upgrading a shared load balancer with action set to start
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# 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) |
Upgrading a shared load balancer with action set to start
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
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 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot