Help Center/ Cloud Firewall/ API Reference (Ankara Region)/ API/ Address Set Management/ Batch Delete Address Items
Updated on 2024-12-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Batch Delete Address Items

Function

Batch Delete Address Items

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/address-items

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

No

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

set_id

Yes

String

set id

address_item_ids

Yes

Array of strings

address item ids

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

Array of strings

batch delete address item response

Example Requests

Delete address set member whose ID is d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address set e4884376-7efb-40e7-b98b-13668d6f8b85 for project 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default

{
  "set_id" : "e4884376-7efb-40e7-b98b-13668d6f8b85",
  "address_item_ids" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
}

Example Responses

Status code: 200

Batch delete address items response

{
  "data" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
}

Status Codes

Status Code

Description

200

Batch delete address items response

Error Codes

See Error Codes.

Parent topic: Address Set Management