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
id	String	Specifies the ID of the IP address group.
name	String	Specifies the IP address group name.
description	String	Specifies the time when the IP address group was updated.
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.
project_id	String	Specifies the project ID of the IP address group.
enterprise_project_id	String	Specifies the enterprise project ID of the IP address group.
created_at	String	Specifies the time when the IP address group was created.
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"
  }
}