Updated on 2024-07-01 GMT+08:00

List Firewall Detail

Function

This API is used to query a firewall instance.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/firewall/exist

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

Yes

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

limit

Yes

Integer

Number of records displayed on each page, in the range 1-1024

service_type

Yes

Integer

Service type 0. North-south firewall

  1. East-west firewall

Minimum: 0

Maximum: 1

Enumeration values:

  • 0

  • 1

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.

name

No

String

firewall instance name

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

GetFirewallInstanceData object

get firewall instance response data

Table 5 GetFirewallInstanceData

Parameter

Type

Description

limit

Integer

Number of records displayed on each page, in the range 1-1024

offset

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

total

Integer

total

records

Array of GetFirewallInstanceResponseRecord objects

Get firewall instance records

Table 6 GetFirewallInstanceResponseRecord

Parameter

Type

Description

fw_instance_id

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.

name

String

Firewall name

ha_type

Integer

Cluster type

charge_mode

Integer

Billing mode. The value can be 0 (yearly/monthly) or 1 (pay-per-use).

service_type

Integer

Service type

engine_type

Integer

Engine type

flavor

Flavor object

Firewall specifications

protect_objects

Array of ProtectObjectVO objects

Project list

status

Integer

Firewall status list. The options are as follows: -1: waiting for payment; 0: creating; 1: deleting; 2: running; 3: upgrading; 4: deletion completed; 5: freezing; 6: creation failed; 7: deletion failed; 8: freezing failed; 9: storage in progress; 10: storage failed; 11: upgrade failed

Enumeration values:

  • -1

  • 0

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

is_old_firewall_instance

Boolean

Whether the engine is an old engine. The options are true (yes) and false (no).

Enumeration values:

  • true

  • false

is_available_obs

Boolean

Whether obs is available

is_support_threat_tags

Boolean

Whether threat tags is supported

support_ipv6

Boolean

Whether IPv6 is supported. The options are true (yes) and false (no).

feature_toggle

Map<String,Boolean>

Whether to enable the feature. The options are true (yes) and false (no).

resources

Array of FirewallInstanceResource objects

Firewall instance resources

fw_instance_name

String

firewall name

enterprise_project_id

String

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

resource_id

String

resource id

support_url_filtering

Boolean

whether to enable url filtering. The options are true (yes) and false (no).

tags

String

tags

Table 7 Flavor

Parameter

Type

Description

version

Integer

Firewall version. The value can be 0 (standard edition), 1 (professional edition), 2 (platinum edition), or 3 (basic edition).

Enumeration values:

  • 0

  • 1

  • 2

  • 3

eip_count

Integer

Number of EIPs

Minimum: 1

vpc_count

Integer

Number of VPCs

Minimum: 1

bandwidth

Integer

Bandwidth

Minimum: 1

log_storage

Integer

Log storage

default_bandwidth

Integer

default bandwidth

default_eip_count

Integer

default eip count

default_log_storage

Integer

default log storage

default_vpc_count

Integer

default vpc count

Table 8 ProtectObjectVO

Parameter

Type

Description

object_id

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

object_name

String

Protected object name

type

Integer

Project type. The options are as follows: 0: north-south; 1: east-west.

Enumeration values:

  • 0

  • 1

Table 9 FirewallInstanceResource

Parameter

Type

Description

resource_id

String

Resource ID

cloud_service_type

String

Service type, which is used by CBC. The value is hws.service.type.cfw.

resource_type

String

Resource type. The options are as follows:1. CFW: hws.resource.type.cfw 2. EIP:hws.resource.type.cfw.exp.eip 3. Bandwidth: hws.resource.type.cfw.exp.bandwidth 4. VPC: hws.resource.type.cfw.exp.vpc 5. Log storage: hws.resource.type.cfw.exp.logaudit

resource_spec_code

String

Inventory unit code

resource_size

Integer

Resource quantity

resource_size_measure_id

Integer

Resource unit name

Example Requests

Query the firewall list of the project whose ID is 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 a 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,
        "session_concurrent" : 200,
        "session_create" : 200,
        "total_rule_count" : 200,
        "used_rule_count" : 2136,
        "version" : 1,
        "vpc_bandwith" : 1400,
        "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
48
49
50
51
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");

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

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        ListFirewallDetailRequest request = new ListFirewallDetailRequest();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withServiceType(ListFirewallDetailRequest.ServiceTypeEnum.NUMBER_<service_type>);
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withFwInstanceId("<fw_instance_id>");
        request.withName("<name>");
        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
32
33
34
35
36
# 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ListFirewallDetailRequest()
        request.offset = <offset>
        request.limit = <limit>
        request.service_type = <service_type>
        request.enterprise_project_id = "<enterprise_project_id>"
        request.fw_instance_id = "<fw_instance_id>"
        request.name = "<name>"
        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
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")

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

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

    request := &model.ListFirewallDetailRequest{}
	request.Offset = int32(<offset>)
	request.Limit = int32(<limit>)
	request.ServiceType = model.GetListFirewallDetailRequestServiceTypeEnum().<SERVICE_TYPE>
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	fwInstanceIdRequest:= "<fw_instance_id>"
	request.FwInstanceId = &fwInstanceIdRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	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

Status Code

Description

200

Response to the request for obtaining a firewall instance

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.