# 获取东西向防火墙信息 - ListEastWestFirewall #### 功能介绍 获取东西向防火墙信息 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cfw/cfw_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cfw/cfw_02_0018.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/firewall/east-west 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，可以通过调用API获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html)获取 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 是 | Integer | **参数解释**： 每页显示个数 **约束限制**： 不涉及 **取值范围**： 1-1024 **默认取值**： 不涉及 | | offset | 是 | Integer | **参数解释**： 偏移量：指定返回记录的开始位置 **约束限制**： 必须为数字 **取值范围**： 大于或等于0 **默认取值**： 默认0 | | enterprise_project_id | 否 | String | **参数解释**： 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过[如何获取企业项目ID](https://support.huaweicloud.com/api-cfw/cfw_02_0027.html)获取 **约束限制**： 用户未开启企业项目时为0 **取值范围**： 不涉及 **默认取值**： 不涉及 | | fw_instance_id | 是 | String | **参数解释**： 防火墙ID，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。可通过[如何获取用户Token](https://support.huaweicloud.com/api-cfw/cfw_02_0008.html)获取 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | Content-Type | 是 | String | **参数解释**： 响应的内容类型 **约束限制**： 不涉及 **取值范围**： application/json **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [GetEastWestFirewallResponseBody] object | **参数解释**： 获取东西向防火墙列表返回data | 表5GetEastWestFirewallResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | object_id | String | **参数解释**： 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用[查询防火墙实例接口](https://support.huaweicloud.com/api-cfw/ListFirewallDetail.html)获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得。type为0时，object_id为互联网边界防护对象ID，type为1时，object_id为VPC边界防护对象ID。此处仅取type为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 **取值范围**： 不涉及 | | project_id | String | **参数解释**： 项目ID，可以通过调用API获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **取值范围**： 不涉及 | | 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 | | limit | Integer | **参数解释**： 每页显示个数 **取值范围**： 1-1024 | | mode | String | **参数解释**： 防护模式，值为er **取值范围**： 不涉及 | 表6SubnetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | availability_zone | String | **参数解释**： 子网所在的可用区标识，从终端节点获取，参考[终端节点](https://support.huaweicloud.com/api-cfw/cfw_02_0000.html) **取值范围**： 不涉及 | | cidr | String | **参数解释**： 虚拟私有云下可用子网的范围 **取值范围**： 10.0.0.0/8\~24 172.16.0.0/12\~24 192.168.0.0/16\~24 | | name | String | **参数解释**： 子网名称 **取值范围**： 不涉及 | | id | String | **参数解释**： 子网id **取值范围**： 不涉及 | | gateway_ip | String | **参数解释**： 子网的网关 **取值范围**： 子网网段cidr中的IP地址 | | vpc_id | String | **参数解释**： 创建VPC产生的uuid **取值范围**： 不涉及 | | ipv6_enable | Boolean | **参数解释**： 是否支持ipv6 **取值范围**： - true：是 - false：否 | 表7ErInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： ER ID，创建ER时产生的ID **取值范围**： 不涉及 | | name | String | **参数解释**： ER名称 **取值范围**： 不涉及 | | project_id | String | **参数解释**： 项目ID，可以通过调用API获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **取值范围**： 不涉及 | | attachment_id | String | **参数解释**： 企业路由器连接id，该连接用于连接防火墙和企业路由器，此字段可在通过id在ER界面查询指定er后在管理连接界面查询连接了解连接具体情况。 **取值范围**： 不涉及 | 表8VpcDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表9EwProtectResourceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** OK ``` { "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, "firewall_associated_subnets" : [ { "availability_zone" : "cn-north-7a", "cidr" : "10.0.0.0/24", "name" : "subnet-test", "id" : "0d7c9595-d39c-4935-ba4b-67a6e9c5e0f1" } ] } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.ListEastWestFirewallRequest{} response, err := client.ListEastWestFirewall(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CFW/sdk?api=ListEastWestFirewall)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request，错误的请求 | | 401 | Unauthorized，错误的请求 | | 403 | Forbidden，禁止访问 | | 404 | Not Found，网页未找到 | | 500 | Internal Server Error，内部服务错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。