Updated on 2024-01-23 GMT+08:00

Deleting IP Addresses from an IP Address Group

Function

This API is used to delete IP addresses from an IP address group.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

ipgroup_id

Yes

String

Specifies the ID of the IP address group.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Specifies the token used for IAM authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ipgroup

No

BatchDeleteIpListOption object

Specifies IP addresses that will be deleted from an IP address group in batches.

Table 4 BatchDeleteIpListOption

Parameter

Mandatory

Type

Description

ip_list

No

Array of IpGroupIp objects

Specifies IP addresses.

Table 5 IpGroupIp

Parameter

Mandatory

Type

Description

ip

Yes

String

Specifies an IP address or IP address range.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

ipgroup

IpGroup object

Shows IP address information.

request_id

String

Specifies the request ID. The value is automatically generated.

Table 7 IpGroup

Parameter

Type

Description

created_at

String

Specifies the time when the IP address group was created.

description

String

Provides supplementary information about the IP address group.

id

String

Specifies the ID of the IP address group.

ip_list

Array of IpInfo objects

Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

Array Length: 0 - 300

listeners

Array of ListenerRef objects

Lists the IDs of listeners with which the IP address group is associated.

name

String

Specifies the IP address group name.

project_id

String

Specifies the project ID of the IP address group.

updated_at

String

Specifies the time when the IP address group was updated.

Table 8 IpInfo

Parameter

Type

Description

ip

String

Specifies the IP addresses in the IP address group.

description

String

Provides remarks about the IP address group.

Minimum: 0

Maximum: 255

Table 9 ListenerRef

Parameter

Type

Description

id

String

Specifies the listener ID.

Example Requests

Deleting IP addresses from an IP address group

PUT https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups/8722e0e0-9cc9-4490-9660-8c9a5732fbb0/iplist/batch-delete

{
  "ipgroup" : {
    "ip_list" : [ {
      "ip" : "192.168.1.123"
    }, {
      "ip" : "192.168.3.0/24"
    } ]
  }
}

Example Responses

Status code: 200

Successful request.

{
  "ipgroup" : {
    "description" : "",
    "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
    "name" : "test_ipg",
    "project_id" : "45977fa2dbd7482098dd68d0d8970117",
    "ip_list" : [ {
      "ip" : "192.168.1.122",
      "description" : ""
    } ],
    "listeners" : [ {
      "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd"
    }, {
      "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c"
    } ],
    "created_at" : "2018-01-16T03:19:16",
    "updated_at" : "2018-01-16T03:19:16"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Deleting IP addresses from an IP address group

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

    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();
        BatchDeleteIpListRequest request = new BatchDeleteIpListRequest();
        BatchDeleteIpListRequestBody body = new BatchDeleteIpListRequestBody();
        List<IpGroupIp> listIpgroupIpList = new ArrayList<>();
        listIpgroupIpList.add(
            new IpGroupIp()
                .withIp("192.168.1.123")
        );
        listIpgroupIpList.add(
            new IpGroupIp()
                .withIp("192.168.3.0/24")
        );
        BatchDeleteIpListOption ipgroupbody = new BatchDeleteIpListOption();
        ipgroupbody.withIpList(listIpgroupIpList);
        body.withIpgroup(ipgroupbody);
        request.withBody(body);
        try {
            BatchDeleteIpListResponse response = client.batchDeleteIpList(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 IP addresses from an IP address group

 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

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = BatchDeleteIpListRequest()
        listIpListIpgroup = [
            IpGroupIp(
                ip="192.168.1.123"
            ),
            IpGroupIp(
                ip="192.168.3.0/24"
            )
        ]
        ipgroupbody = BatchDeleteIpListOption(
            ip_list=listIpListIpgroup
        )
        request.body = BatchDeleteIpListRequestBody(
            ipgroup=ipgroupbody
        )
        response = client.batch_delete_ip_list(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 IP addresses from an IP address group

 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
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.BatchDeleteIpListRequest{}
	var listIpListIpgroup = []model.IpGroupIp{
        {
            Ip: "192.168.1.123",
        },
        {
            Ip: "192.168.3.0/24",
        },
    }
	ipgroupbody := &model.BatchDeleteIpListOption{
		IpList: &listIpListIpgroup,
	}
	request.Body = &model.BatchDeleteIpListRequestBody{
		Ipgroup: ipgroupbody,
	}
	response, err := client.BatchDeleteIpList(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

Successful request.

Error Codes

See Error Codes.