文档首页/ 云防火墙 CFW/ API参考/ API/ 防火墙管理/ 获取东西向防火墙信息
更新时间:2025-01-23 GMT+08:00
分享

获取东西向防火墙信息

功能介绍

获取东西向防火墙信息

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/firewall/east-west

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

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

offset

Integer

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

enterprise_project_id

String

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

fw_instance_id

String

防火墙id,可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

GetEastWestFirewallResponseBody object

获取东西向防火墙列表返回data

表5 GetEastWestFirewallResponseBody

参数

参数类型

描述

object_id

String

防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id,可通过data.records.protect_objects.type(.表示各对象之间层级的区分)获得。

project_id

String

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

status

Integer

防护状态:0 已开启防护, 1 未开启防护

firewall_associated_subnets

Array of SubnetInfo objects

云防火墙关联子网信息

er

ErInstance object

出方向关联企业路由器信息

inspection_vpc

VpcDetail object

引流vpc信息

protect_infos

Array of EwProtectResourceInfo objects

东西向防护资源信息

total

Integer

防护VPC总数

offset

Integer

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

limit

Integer

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

mode

String

防护模式,值为er

表6 SubnetInfo

参数

参数类型

描述

availability_zone

String

子网所在的可用区标识,从终端节点获取,参考终端节点

cidr

String

功能说明:虚拟私有云下可用子网的范围

取值范围:

10.0.0.0/8~24

172.16.0.0/12~24

192.168.0.0/16~24

不指定cidr时,默认值为空

约束:必须是cidr格式,例如:192.168.0.0/16

name

String

子网名称

id

String

子网id

gateway_ip

String

子网的网关,取值范围为子网网段cidr中的ip地址

vpc_id

String

创建vpc产生的uuid

ipv6_enable

Boolean

是否支持ipv6,boolean值为true表示是,false表示否

表7 ErInstance

参数

参数类型

描述

id

String

ER ID,创建ER时产生的ID

name

String

ER名称

project_id

String

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

attachment_id

String

企业路由器连接id,该连接用于连接防火墙和企业路由器,此字段可在通过id在ER界面查询指定er后在管理连接界面查询连接了解连接具体情况。

表8 VpcDetail

参数

参数类型

描述

id

String

创建引流VPC产生的随机UUID

name

String

引流VPC名称

cidr

String

功能说明:虚拟私有云下可用子网的范围 取值范围: 10.0.0.0/8~24 172.16.0.0/12~24 192.168.0.0/16~24 不指定cidr时,默认值为空 约束:必须是cidr格式,例如:192.168.0.0/16

表9 EwProtectResourceInfo

参数

参数类型

描述

protected_resource_type

Integer

防护资源类型:0 VPC,1 VGW,2 VPN,3 PEERING

protected_resource_name

String

防护资源名称

protected_resource_id

String

防护资源id

protected_resource_nat_name

String

防护资源nat网关名称,专业版防火墙支持NAT规则,此字段表示防护连接的NAT的名称。

protected_resource_nat_id

String

防护资源nat网关id,专业版防火墙支持NAT规则,此字段表示防护连接的NAT的id。

protected_resource_project_id

String

防火墙支持跨账户防护,此处为防护资源租户id

protected_resource_mode

String

防护资源模式,为er

status

Integer

防护资源的防护状态,0表示已关联,1表示未关联。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

获取项目id为09bb24e6f280d23d0f9fc0104b901480下的防火墙id为80e0f2df-24fd-49c2-8398-11f9a0299b3e的东西向防火墙信息。

https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0&fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e

响应示例

状态码:200

东西向防火墙信息响应

{
  "data" : {
    "er" : {
      "id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43",
      "name" : "er",
      "project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
      "attachment_id" : "e978c028-0ccf-4168-a015-0094ac631e88"
    },
    "inspection_vpc" : {
      "cidr" : "10.13.13.0/24",
      "id" : "3baa2248-03d4-47ac-aefa-ec6f9a30ed80",
      "name" : "inspection-vpc"
    },
    "limit" : 50,
    "mode" : "er",
    "object_id" : "6cc31075-0b03-461d-aa3a-73c4765bf9ac",
    "offset" : 0,
    "project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
    "protect_infos" : [ {
      "protected_resource_id" : "09b26b83-4b7c-499f-805b-50820900cd9f",
      "protected_resource_mode" : "er",
      "protected_resource_name" : "vpc-4",
      "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
      "protected_resource_type" : 0,
      "status" : 0
    }, {
      "protected_resource_id" : "2956f917-af18-44a2-a0f2-f592633d4431",
      "protected_resource_mode" : "er",
      "protected_resource_name" : "vpc-t3",
      "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
      "protected_resource_type" : 0,
      "status" : 0
    }, {
      "protected_resource_id" : "69d4c81f-80bd-4c28-9074-f26b400b3a34",
      "protected_resource_mode" : "er",
      "protected_resource_name" : "vpc-t2",
      "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
      "protected_resource_type" : 0,
      "status" : 0
    }, {
      "protected_resource_id" : "e1b18d3e-8f7d-4c4e-a326-37db7bd89a3a",
      "protected_resource_mode" : "er",
      "protected_resource_name" : "vpc-t1",
      "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
      "protected_resource_type" : 0,
      "status" : 0
    }, {
      "protected_resource_id" : "f91c1747-1325-4b39-9d58-7fac0bd2786f",
      "protected_resource_mode" : "er",
      "protected_resource_name" : "vpc-5",
      "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
      "protected_resource_type" : 0,
      "status" : 0
    }, {
      "protected_resource_id" : "bd556a7d-447e-49eb-be17-f93af09769f5",
      "protected_resource_mode" : "er",
      "protected_resource_name" : "inspct-a",
      "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76",
      "protected_resource_type" : 0,
      "status" : 1
    } ],
    "status" : 0,
    "total" : 6
  }
}

SDK代码示例

SDK代码示例如下。

 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 ListEastWestFirewallSolution {

    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();
        ListEastWestFirewallRequest request = new ListEastWestFirewallRequest();
        try {
            ListEastWestFirewallResponse response = client.listEastWestFirewall(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());
        }
    }
}
 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 = ListEastWestFirewallRequest()
        response = client.list_east_west_firewall(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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.ListEastWestFirewallRequest{}
	response, err := client.ListEastWestFirewall(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

东西向防火墙信息响应

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档