Help Center/ Elastic Load Balance/ API Reference/ APIs (V3)/ Load Balancer/ Deleting a Load Balancer and Its Associated Resources (Including EIPs)
Updated on 2025-02-25 GMT+08:00

Deleting a Load Balancer and Its Associated Resources (Including EIPs)

Function

This API is used to delete a load balancer and its associated resources, including the listeners, backend server groups, backend servers, and EIPs.

Note: Backend server groups are either disassociated from the load balancer if they are associated with other load balancers or deleted if they are not associated with other load balancers.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/delete-cascade

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

loadbalancer

Yes

DeleteLoadBalancerCascadeOption object

Specifies the load balancer.

Table 4 DeleteLoadBalancerCascadeOption

Parameter

Mandatory

Type

Description

unbounded_pool

No

Boolean

Specifies whether to delete the backend server group after it is disassociated from the load balancer.

Value options:

  • true: Delete the backend server group.

  • false: Disassociate the backend server group from the load balancer.

    Default value: true

Note:

  • For shared load balancers, the parameter can only be set to true.

  • If this backend server group is associated with other load balancers, the backend server group will not be deleted even if this parameter is set to true.

public_ip

No

Boolean

Specifies whether to release EIPs after the load balancer is deleted.

Value options:

  • true: Release EIPs.

  • false: Unbind the EIPs from the load balancer.

Response Parameters

None

Example Requests

Deleting a load balancer and its associated resources (including EIPs)

POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/32c1057f-74a1-42d6-9b20-d55b80ab89c4/cascade-delete

{
  "loadbalancer" : {
    "unbounded_pool" : true,
    "public_ip" : true
  }
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Deleting a load balancer and its associated resources (including EIPs)

 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
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.*;


public class DeleteLoadBalancerCascadeSolution {

    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();
        DeleteLoadBalancerCascadeRequest request = new DeleteLoadBalancerCascadeRequest();
        request.withLoadbalancerId("{loadbalancer_id}");
        DeleteLoadBalancerCascadeRequestBody body = new DeleteLoadBalancerCascadeRequestBody();
        DeleteLoadBalancerCascadeOption loadbalancerbody = new DeleteLoadBalancerCascadeOption();
        loadbalancerbody.withUnboundedPool(true)
            .withPublicIp(true);
        body.withLoadbalancer(loadbalancerbody);
        request.withBody(body);
        try {
            DeleteLoadBalancerCascadeResponse response = client.deleteLoadBalancerCascade(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());
        }
    }
}

Deleting a load balancer and its associated resources (including EIPs)

 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
# 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 = DeleteLoadBalancerCascadeRequest()
        request.loadbalancer_id = "{loadbalancer_id}"
        loadbalancerbody = DeleteLoadBalancerCascadeOption(
            unbounded_pool=True,
            public_ip=True
        )
        request.body = DeleteLoadBalancerCascadeRequestBody(
            loadbalancer=loadbalancerbody
        )
        response = client.delete_load_balancer_cascade(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Deleting a load balancer and its associated resources (including EIPs)

 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
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.DeleteLoadBalancerCascadeRequest{}
	request.LoadbalancerId = "{loadbalancer_id}"
	unboundedPoolLoadbalancer:= true
	publicIpLoadbalancer:= true
	loadbalancerbody := &model.DeleteLoadBalancerCascadeOption{
		UnboundedPool: &unboundedPoolLoadbalancer,
		PublicIp: &publicIpLoadbalancer,
	}
	request.Body = &model.DeleteLoadBalancerCascadeRequestBody{
		Loadbalancer: loadbalancerbody,
	}
	response, err := client.DeleteLoadBalancerCascade(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

204

Normal response to DELETE operations.

Error Codes

See Error Codes.