Querying Firewall Details

Function

This API is used to query firewall instance details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/firewall/exist

Request Parameters

Response Parameters

Status code: 200

Example Requests

Query the firewall list of project 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/firewall/exist?service_type=0&offset=0&limit=10

Example Responses

Status code: 200

Response to the request for obtaining an existing firewall instance.

{
    "data": {
        "limit": 10,
        "offset": 0,
        "records": [
            {
                "charge_mode": 0,
                "engine_type": 1,
                "enterprise_project_id": "default",
                "feature_toggle": {
                    "is_support_anti_virus": true,
                    "is_support_application": true,
                    "is_support_tcp_proxy": false,
                    "is_support_url_profile": true,
                    "is_support_threat_tags": true,
                    "is_support_flow_associated_host": false,
                    "is_support_predefined": true,
                    "isSupportSession": false,
                    "is_support_acl_region_config": true,
                    "is_support_ips": true,
                    "is_support_ew_create_er_tenant_inspection_mode": false,
                    "ips_rule_list": true,
                    "long_connect": true,
                    "is_support_ew_create_vpc_peering_inspection_mode": true,
                    "alarm_config": true,
                    "is_not_support_resource_reduction": false,
                    "acl_multi_object": true,
                    "is_support_advanced_ips_rule": true,
                    "is_support_multi_account": false,
                    "is_support_capture": true,
                    "is_support_ew_create_er_bearer_inspection_mode": true
                },
                "flavor": {
                    "bandwidth": 60,
                    "eip_count": 51,
                    "log_storage": 0,
                    "version": 1,
                    "vpc_count": 8,
                    "default_eip_count": 20,
                    "default_vpc_count": 0,
                    "default_bandwidth": 10,
                    "default_log_storage": 0
                },
                "tags": "{\"key1234\":\"1234\",\"key122\":\"2222\"}",
                "fw_instance_id": "546af3f8-88e9-47f2-a205-2346d7090925",
                "fw_instance_name": "test",
                "ha_type": 1,
                "is_available_obs": false,
                "is_old_firewall_instance": false,
                "is_support_threat_tags": false,
                "name": "1680054140516",
                "protect_objects": [
                    {
                        "object_id": "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
                        "object_name": "1680054141674",
                        "type": 0
                    },
                    {
                        "object_id": "be83d202-df0b-498d-a96e-41589dc85c86",
                        "object_name": "ew-1680070626042",
                        "type": 1
                    }
                ],
                "resource_id": "546af3f8-88e9-47f2-a205-2346d7090925",
                "resources": [
                    {
                        "cloud_service_type": "hws.service.type.cfw",
                        "resource_id": "546af3f8-88e9-47f2-a205-2346d7090925",
                        "resource_spec_code": "cfw.professional",
                        "resource_type": "hws.resource.type.cfw"
                    },
                    {
                        "cloud_service_type": "hws.service.type.cfw",
                        "resource_id": "0acdd5c7-1178-4bea-b5b6-bd55dc5e2669",
                        "resource_size": 5,
                        "resource_size_measure_id": 14,
                        "resource_spec_code": "cfw.expack.vpc.professional",
                        "resource_type": "hws.resource.type.cfw.exp.vpc"
                    },
                    {
                        "cloud_service_type": "hws.service.type.cfw",
                        "resource_id": "4002620c-916a-49c7-8042-cbe02fc17e61",
                        "resource_size": 5,
                        "resource_size_measure_id": 36,
                        "resource_spec_code": "cfw.expack.bandwidth.professional",
                        "resource_type": "hws.resource.type.cfw.exp.bandwidth"
                    },
                    {
                        "cloud_service_type": "hws.service.type.cfw",
                        "resource_id": "0235c7db-0baa-4c82-8db2-7b8d5108bd86",
                        "resource_size": 2,
                        "resource_size_measure_id": 14,
                        "resource_spec_code": "cfw.expack.eip.professional",
                        "resource_type": "hws.resource.type.cfw.exp.eip"
                    },
                    {
                        "cloud_service_type": "hws.service.type.cfw",
                        "resource_id": "079ade46-18cd-4917-b7bb-00d402931097",
                        "resource_size": 6,
                        "resource_size_measure_id": 14,
                        "resource_spec_code": "cfw.expack.vpc.professional",
                        "resource_type": "hws.resource.type.cfw.exp.vpc"
                    },
                    {
                        "cloud_service_type": "hws.service.type.cfw",
                        "resource_id": "dd078faa-abfd-4e63-b681-1a93489955b9",
                        "resource_size": 1,
                        "resource_size_measure_id": 14,
                        "resource_spec_code": "cfw.expack.eip.professional",
                        "resource_type": "hws.resource.type.cfw.exp.eip"
                    },
                    {
                        "cloud_service_type": "hws.service.type.cfw",
                        "resource_id": "4d78d523-745d-4d54-a9ca-e6d25e555bde",
                        "resource_size": 10,
                        "resource_size_measure_id": 36,
                        "resource_spec_code": "cfw.expack.bandwidth.professional",
                        "resource_type": "hws.resource.type.cfw.exp.bandwidth"
                    }
                ],
                "service_type": 0,
                "status": 2,
                "support_ipv6": true,
                "support_url_filtering": true
            }
        ],
        "total": 1
    }
}

SDK Sample Code

The SDK sample code is as follows.

Java

 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

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.*;


public class ListFirewallDetailSolution {

    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();
        ListFirewallDetailRequest request = new ListFirewallDetailRequest();
        try {
            ListFirewallDetailResponse response = client.listFirewallDetail(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

 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

# 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 = ListFirewallDetailRequest()
        response = client.list_firewall_detail(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

 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

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.ListFirewallDetailRequest{}
	response, err := client.ListFirewallDetail(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

Error Codes

See Error Codes.