Help Center/ Cloud Firewall/ API Reference/ API/ Address Group Management/ Deleting Address Group Members in Batches
Updated on 2024-10-31 GMT+08:00

Deleting Address Group Members in Batches

Function

This API is used to delete address group members in batches.

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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

No

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain the token by referring to Obtaining a User Token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

set_id

Yes

String

Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

address_item_ids

Yes

Array of strings

List of address group member IDs. Address group member IDs can be obtained by calling the API for querying address group members. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

Array of strings

ID list of the address group members to be deleted in batches.

Example Requests

Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in 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

Return value for deleting address group members in batches.

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

SDK Sample Code

The SDK sample code is as follows.

Java

Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429.

 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
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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchDeleteAddressItemsSolution {

    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");
        String projectId = "{project_id}";

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

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchDeleteAddressItemsRequest request = new BatchDeleteAddressItemsRequest();
        DeleteAddressItemsInfoDto body = new DeleteAddressItemsInfoDto();
        List<String> listbodyAddressItemIds = new ArrayList<>();
        listbodyAddressItemIds.add("d072ad2e-033c-40a9-b0b5-751f9c2943a6");
        body.withAddressItemIds(listbodyAddressItemIds);
        body.withSetId("e4884376-7efb-40e7-b98b-13668d6f8b85");
        request.withBody(body);
        try {
            BatchDeleteAddressItemsResponse response = client.batchDeleteAddressItems(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());
        }
    }
}

Python

Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = BatchDeleteAddressItemsRequest()
        listAddressItemIdsbody = [
            "d072ad2e-033c-40a9-b0b5-751f9c2943a6"
        ]
        request.body = DeleteAddressItemsInfoDto(
            address_item_ids=listAddressItemIdsbody,
            set_id="e4884376-7efb-40e7-b98b-13668d6f8b85"
        )
        response = client.batch_delete_address_items(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/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")
    projectId := "{project_id}"

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

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchDeleteAddressItemsRequest{}
	var listAddressItemIdsbody = []string{
        "d072ad2e-033c-40a9-b0b5-751f9c2943a6",
    }
	request.Body = &model.DeleteAddressItemsInfoDto{
		AddressItemIds: listAddressItemIdsbody,
		SetId: "e4884376-7efb-40e7-b98b-13668d6f8b85",
	}
	response, err := client.BatchDeleteAddressItems(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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

Return value for deleting address group members in batches.

Error Codes

See Error Codes.