Help Center/ Global Accelerator/ API Reference/ API/ IP Address Group/ Removing CIDR Blocks from an IP Address Group
Updated on 2023-12-06 GMT+08:00
Online Debugging
CLI Examples
View PDF

Removing CIDR Blocks from an IP Address Group

Function

This API is used to remove CIDR blocks from an IP address group. This is an asynchronous API. The removal is not complete even after a response is returned. You can call the API for querying the IP address group details to check whether the removal is complete. If the IP address group status is ACTIVE, the CIDR blocks are removed.

Calling Method

For details, see Calling APIs.

URI

POST /v1/ip-groups/{ip_group_id}/remove-ips

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

ip_group_id

Yes

String

Specifies the ID of the IP address group.

Minimum: 1

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ip_list

Yes

Array of strings

Specifies the CIDR blocks in the IP address group. A maximum of 20 CIDR blocks can be deleted at a time.

Minimum: 1

Maximum: 50

Array Length: 1 - 20

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Example Requests

Removing CIDR blocks from an IP address group

POST https://{ga_endpoint}/v1/ip-groups/e8996cd6-28cf-4ff2-951e-fa8ac895a6cd/remove-ips

{
  "ip_list" : [ "127.0.0.0/24" ]
}

Example Responses

Status code: 200

Operation successful.

{
  "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8"
}

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent Topic: IP Address Group