Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

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

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

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. The value ranges from 1 to 1024.

service_type

Yes

Integer

Service type. Currently, only 0 (Internet protection) is supported.

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 instance ID, which is automatically generated by the system after a CFW is created. You can call the API for querying firewall instances. By default, if this parameter is left blank, information about the first firewall under the account is returned. If this parameter is specified, information about the corresponding firewall is returned.

name

No

String

Firewall name.

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

GetFirewallInstanceData object

Query firewall instance data.

Table 5 GetFirewallInstanceData

Parameter

Type

Description

limit

Integer

Number of records displayed on each page. The value ranges from 1 to 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 number of firewalls.

records

Array of GetFirewallInstanceResponseRecord objects

Query the firewall instance list.

Table 6 GetFirewallInstanceResponseRecord

Parameter

Type

Description

fw_instance_id

String

Firewall instance ID, which is automatically generated by the system after a CFW instance is created. You can call the API for querying firewall instances. By default, if fw_instance_Id is left blank, information about the first firewall under the account is returned. If fw_instance_Id is specified, the information about the firewall corresponding to fw_instance_Id is returned.

name

String

Firewall name.

ha_type

Integer

Cluster type: 0 (active/standby), 1 (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster.

charge_mode

Integer

Billing mode: 0 (yearly/monthly), 1 (pay-per-use).

service_type

Integer

Firewall protection type. Currently, its value can only be 0 (Internet protection).

engine_type

Integer

Engine type: 0 (self-developed engine), 1 (Hillstone engine), or 3 (TOPSEC engine).

flavor

Flavor object

Firewall specifications.

protect_objects

Array of ProtectObjectVO objects

Protected object list.

status

Integer

Firewall status: -1 (waiting for payment), 0 (creating), 1 (deleting), 2 (running), 3 (upgrading), 4 (deleted), 5 (frozen), 6 (creation failed), 7 (deletion failed), 8 (freezing failed), or 9 (being stored), 10 (storage failed), or 11 (upgrade failed).

is_old_firewall_instance

Boolean

Whether an engine old: true (yes), false (no).

is_available_obs

Boolean

Whether OBS is supported: true (yes), false (no).

is_support_threat_tags

Boolean

Whether threat intelligence tags are supported: true (yes), false (no).

support_ipv6

Boolean

Whether IPv6 is supported: true (yes), false (no).

feature_toggle

Map<String,Boolean>

Whether a feature is enabled: true (yes), false (no).

resources

Array of FirewallInstanceResource objects

Firewall resource list.

fw_instance_name

String

Firewall name.

enterprise_project_id

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.

resource_id

String

Firewall resource ID, which is the same as fw_instance_id.

support_url_filtering

Boolean

Whether website filtering is supported: true (yes), false (no).

tags

String

Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}".

Table 7 Flavor

Parameter

Type

Description

version

Integer

Firewall edition: 0 (standard), 1 (professional), or 3 (basic). If charge_mode is set to postPaid, only the professional edition is supported. If charge_mode is set to prePaid, the standard and professional editions are supported.

eip_count

Integer

Number of EIPs.

vpc_count

Integer

Number of VPCs.

bandwidth

Integer

Bandwidth, in Mbit/s.

log_storage

Integer

Log storage, in bytes.

default_bandwidth

Integer

Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition.

default_eip_count

Integer

Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition.

default_log_storage

Integer

Default log storage, in bytes. The default value is 0.

default_vpc_count

Integer

Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition.

Table 8 ProtectObjectVO

Parameter

Type

Description

object_id

String

Protected object ID. It is used to distinguish Internet border protection from VPC border protection after a CFW instance is created.

object_name

String

Protected object name.

type

Integer

Project type: 0 (north-south), 1 (east-west).

Table 9 FirewallInstanceResource

Parameter

Type

Description

resource_id

String

Resource ID. It can be the firewall ID, bandwidth ID, EIP ID, VPC ID, or the ID returned after CBC callback.

cloud_service_type

String

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

resource_type

String

Resource type.Enumeration values:- hws.resource.type.cfw (cloud firewall)- hws.resource.type.cfw.exp.eip (EIP)- hws.resource.type.cfw.exp.bandwidth (bandwidth)- hws.resource.type.cfw.exp (VPC)

resource_spec_code

String

Inventory unit code: cfw.standard (firewall standard edition), cfw.professional (firewall professional edition), cfw.expack.eip.standard (EIP standard edition), cfw.expack.eip.professional (EIP professional edition), cfw.expack.bandwidth.standard (bandwidth basic edition), cfw.expack.bandwidth.professional (bandwidth professional edition), or cfw.expack.vpc.professional (VPC professional edition).

resource_size

Integer

Resource quantity.

resource_size_measure_id

Integer

Resource unit.

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

Status Code

Description

200

Response to the request for obtaining an existing firewall instance.

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback