Help Center/ Elastic Load Balance/ API Reference/ APIs (V3)/ Backend Server/ Batch Deleting Backend Servers
Updated on 2024-07-27 GMT+08:00
Online Debugging
CLI Examples
View PDF

Batch Deleting Backend Servers

Function

This API is used to delete backend servers from the specified backend server group in batches. You can remove up to 200 backend servers at a time from a backend server group.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/pools/{pool_id}/members/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

pool_id

Yes

String

Specifies the ID of the backend server group.

project_id

Yes

String

Specifies the project 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

members

Yes

Array of BatchDeleteMembersOption objects

Specifies the request body for deleting backend servers in batches.
Table 4 BatchDeleteMembersOption

Parameter

Mandatory

Type

Description

id

No

String

Specifies the ID of the backend server to be deleted.

Note: If id is passed, other parameters cannot be specified. Otherwise, an error will be reported.

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

address

No

String

Specifies the IP address bound to the backend server.

Note:

  • address and protocol_port must be passed at the same time.

  • id cannot be passed together withaddress and protocol_port.

protocol_port

No

Integer

Specifies the port used by the backend server to receive requests.

Note:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

  • address and protocol_port must be passed at the same time.

  • id cannot be passed together withaddress and protocol_port.

  • This parameter can be set to 0, which is used to remove a backend server from its backend server group whose Forward to Same Port is enabled.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the backend servers.

members

Array of BatchDeleteMembersState objects

Specifies the backend servers.
Table 6 BatchDeleteMembersState

Parameter

Type

Description

id

String

Specifies the backend server ID. Note: The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

ret_status

String

Specifies the status of deleting the backend server. Values:

  • successful: The backend server is deleted.

  • not found: The backend server does not exist.

Example Requests

  • Deleting backend servers in batches by IDs

    POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-delete

{
  "members" : [ {
    "id" : "141a8dea-b3f9-4fed-a1e2-30678f53de0b"
  }, {
    "id" : "14d0a82b-fcc2-4ce8-aac8-96d86a7973e4"
  } ]
}

  • Deleting backend servers in batches by IP addresses and ports

    POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-delete

{
  "members" : [ {
    "address" : "192.168.0.48",
    "protocol_port" : 8080
  }, {
    "address" : "192.168.0.49",
    "protocol_port" : 8080
  } ]
}

Example Responses

Status code: 200

Normal response to POST requests.

{
  "request_id" : "db97a1d3c5ee386729dc00e4df1d5708",
  "members" : [ {
    "id" : "141a8dea-b3f9-4fed-a1e2-30678f53de0b",
    "ret_status" : "not found"
  }, {
    "id" : "14d0a82b-fcc2-4ce8-aac8-96d86a7973e4",
    "ret_status" : "successful"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

  • Deleting backend servers in batches by IDs

     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
    		 
    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 BatchDeleteMembersSolution {

    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");

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

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchDeleteMembersRequest request = new BatchDeleteMembersRequest();
        BatchDeleteMembersRequestBody body = new BatchDeleteMembersRequestBody();
        List<BatchDeleteMembersOption> listbodyMembers = new ArrayList<>();
        listbodyMembers.add(
            new BatchDeleteMembersOption()
                .withId("141a8dea-b3f9-4fed-a1e2-30678f53de0b")
        );
        listbodyMembers.add(
            new BatchDeleteMembersOption()
                .withId("14d0a82b-fcc2-4ce8-aac8-96d86a7973e4")
        );
        body.withMembers(listbodyMembers);
        request.withBody(body);
        try {
            BatchDeleteMembersResponse response = client.batchDeleteMembers(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 backend servers in batches by IP addresses and ports

     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 BatchDeleteMembersSolution {

    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");

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

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchDeleteMembersRequest request = new BatchDeleteMembersRequest();
        BatchDeleteMembersRequestBody body = new BatchDeleteMembersRequestBody();
        List<BatchDeleteMembersOption> listbodyMembers = new ArrayList<>();
        listbodyMembers.add(
            new BatchDeleteMembersOption()
                .withAddress("192.168.0.48")
                .withProtocolPort(8080)
        );
        listbodyMembers.add(
            new BatchDeleteMembersOption()
                .withAddress("192.168.0.49")
                .withProtocolPort(8080)
        );
        body.withMembers(listbodyMembers);
        request.withBody(body);
        try {
            BatchDeleteMembersResponse response = client.batchDeleteMembers(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 backend servers in batches by IDs

     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
    		 
    # 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = BatchDeleteMembersRequest()
        listMembersbody = [
            BatchDeleteMembersOption(
                id="141a8dea-b3f9-4fed-a1e2-30678f53de0b"
            ),
            BatchDeleteMembersOption(
                id="14d0a82b-fcc2-4ce8-aac8-96d86a7973e4"
            )
        ]
        request.body = BatchDeleteMembersRequestBody(
            members=listMembersbody
        )
        response = client.batch_delete_members(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 backend servers in batches by IP addresses and ports

     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
    		 
    # 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = BatchDeleteMembersRequest()
        listMembersbody = [
            BatchDeleteMembersOption(
                address="192.168.0.48",
                protocol_port=8080
            ),
            BatchDeleteMembersOption(
                address="192.168.0.49",
                protocol_port=8080
            )
        ]
        request.body = BatchDeleteMembersRequestBody(
            members=listMembersbody
        )
        response = client.batch_delete_members(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 backend servers in batches by IDs

     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
    		 
    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")

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

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

    request := &model.BatchDeleteMembersRequest{}
	idMembers:= "141a8dea-b3f9-4fed-a1e2-30678f53de0b"
	idMembers1:= "14d0a82b-fcc2-4ce8-aac8-96d86a7973e4"
	var listMembersbody = []model.BatchDeleteMembersOption{
        {
            Id: &idMembers,
        },
        {
            Id: &idMembers1,
        },
    }
	request.Body = &model.BatchDeleteMembersRequestBody{
		Members: listMembersbody,
	}
	response, err := client.BatchDeleteMembers(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • Deleting backend servers in batches by IP addresses and ports

     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
    		 
    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")

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

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

    request := &model.BatchDeleteMembersRequest{}
	addressMembers:= "192.168.0.48"
	protocolPortMembers:= int32(8080)
	addressMembers1:= "192.168.0.49"
	protocolPortMembers1:= int32(8080)
	var listMembersbody = []model.BatchDeleteMembersOption{
        {
            Address: &addressMembers,
            ProtocolPort: &protocolPortMembers,
        },
        {
            Address: &addressMembers1,
            ProtocolPort: &protocolPortMembers1,
        },
    }
	request.Body = &model.BatchDeleteMembersRequestBody{
		Members: listMembersbody,
	}
	response, err := client.BatchDeleteMembers(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

200

Normal response to POST requests.

Error Codes

See Error Codes.

Parent Topic: Backend Server