文档首页/ 云防火墙 CFW/ API参考/ API/ 防火墙管理/ 查询防火墙详细信息
更新时间:2024-10-31 GMT+08:00
分享

查询防火墙详细信息

功能介绍

查询防火墙实例

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/firewall/exist

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

limit

Integer

每页显示个数,范围为1-1024

service_type

Integer

服务类型,目前仅支持0互联网防护

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

fw_instance_id

String

防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。

name

String

防火墙名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

GetFirewallInstanceData object

查询防火墙实例数据

表5 GetFirewallInstanceData

参数

参数类型

描述

limit

Integer

每页显示个数,范围为1-1024

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

total

Integer

防火墙总数

records

Array of GetFirewallInstanceResponseRecord objects

查询防火墙实例信息列表

表6 GetFirewallInstanceResponseRecord

参数

参数类型

描述

fw_instance_id

String

防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id。,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。

name

String

防火墙名称

ha_type

Integer

集群类型,包含主备(0)和集群(1)两种方式,主备模式包含四个节点,2个主节点构成集群,剩余两个节点为主节点的备节点,集群模式仅拉起两个节点作为集群。

charge_mode

Integer

计费模式 0:包年/包月 1:按需

service_type

Integer

防火墙防护类型,目前仅支持0,互联网防护

engine_type

Integer

引擎类型,0:自研引擎 1:山石引擎 3:天融信引擎

flavor

Flavor object

防火墙规格信息

protect_objects

Array of ProtectObjectVO objects

防护对象列表

status

Integer

防火墙状态列表,包括-1:等待支付,0:创建中,1,删除中,2:运行中,3:升级中,4:删除完成:5:冻结中,6:创建失败,7:删除失败,8:冻结失败,9:存储中,10:存储失败,11:升级失败

is_old_firewall_instance

Boolean

是否为旧引擎,true表示是,false表示不是

is_available_obs

Boolean

是否支持obs,true表示是,false表示不是

is_support_threat_tags

Boolean

是否支持威胁情报标签,true表示是,false表示不是

support_ipv6

Boolean

是否支持ipv6,true表示是,false表示不是

feature_toggle

Map<String,Boolean>

特性开关,boolean值为true表示是,false表示否

resources

Array of FirewallInstanceResource objects

防火墙资源列表

fw_instance_name

String

防火墙名称

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

resource_id

String

防火墙资源id,同fw_instance_id

support_url_filtering

Boolean

是否支持url过滤,true表示是,false表示不是

tags

String

标签列表,标签键值map转化的json字符串,如"{"key":"value"}"

表7 Flavor

参数

参数类型

描述

version

Integer

防火墙版本,0:标准版,1:专业版,3:基础版,购买时,当防火墙“charge_mode”为“postPaid”时,仅支持专业版。“charge_mode”为“prePaid”时,支持标准版、专业版。

eip_count

Integer

eip数量

vpc_count

Integer

vpc数量

bandwidth

Integer

带宽,单位为mbps

log_storage

Integer

日志存储,单位为byte

default_bandwidth

Integer

默认防火墙带宽,单位为mbps,标准版为10,专业版为50,按需专业版为200

default_eip_count

Integer

默认eip数,标准版为20,专业版为50,按需专业版为1000

default_log_storage

Integer

默认日志存储,单位为byte,默认为0

default_vpc_count

Integer

默认vpc数,标准版为0,专业版为2,按需专业版为5

表8 ProtectObjectVO

参数

参数类型

描述

object_id

String

防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id。

object_name

String

防护对象名称

type

Integer

防护对象类型:0 南北向,1 东西向护对象类型

表9 FirewallInstanceResource

参数

参数类型

描述

resource_id

String

资源id,包括防火墙资源id,带宽资源id,eip资源id,vpc资源id,cbc回调后返回id。

cloud_service_type

String

服务类型,用于CBC使用,特指:hws.service.type.cfw

resource_type

String

资源类型包括: 1、云防火墙:hws.resource.type.cfw2、EIP:hws.resource.type.cfw.exp.eip3、带宽:hws.resource.type.cfw.exp.bandwidth4、VPC:hws.resource.type.cfw.exp

resource_spec_code

String

库存单位码,包括:1、防火墙标准版cfw.standard 2、防火墙专业版cfw.professional 3、eip标准版cfw.expack.eip.standard 4、eip专业版cfw.expack.eip.professional 5、带宽基础版cfw.expack.bandwidth.standard 6、带宽专业版cfw.expack.bandwidth.professional 7、vpc专业版cfw.expack.vpc.professional

resource_size

Integer

资源数量

resource_size_measure_id

Integer

资源单位

请求示例

查询项目id为9d80d070b6d44942af73c9c3d38e0429的项目存在的防火墙列表

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

响应示例

状态码: 200

获取存在防火墙实例响应

{
    "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代码示例

SDK代码示例如下。

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)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

获取存在防火墙实例响应

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档