文档首页/ 云防火墙 CFW/ API参考（安卡拉区域）/ API/ 防火墙管理/ 获取东西向防火墙信息
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取东西向防火墙信息

功能介绍

获取东西向防火墙信息

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目id
表2 Query参数

参数

是否必选

参数类型

描述

limit

是

Integer

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

offset

是

Integer

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

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

是

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

GetEastWestFirewallResponseBody object

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

参数

参数类型

描述

object_id

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。

project_id

String

租户project_id

status

Integer

防护状态：0 已开启防护， 1 未开启防护

er_associated_subnet

SubnetInfo object

ER关联子网信息

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

防护模式

ew_vpc_route_limit

Integer

东西向路由限制
表6 SubnetInfo

参数

参数类型

描述

availability_zone

String

子网id

cidr

String

vpc cidr

name

String

子网名称

id

String

子网id

gateway_ip

String

子网网关ip

vpc_id

String

vpc id

status

String

子网的状态

ipv6_enable

Boolean

是否支持ipv6，boolean值为true表示是，false表示否
表7 ErInstance

参数

参数类型

描述

id

String

ER实例id

name

String

ER名称

state

String

ER状态

enterprise_project_id

String

企业租户id

project_id

String

租户id

enable_ipv6

String

是否开启ipv6

attachment_id

String

连接id
表8 VpcDetail

参数

参数类型

描述

id

String

id

name

String

名称

cidr

String

vpc cidr

status

String

状态
表9 EwProtectResourceInfo

参数

参数类型

描述

protected_resource_type

Integer

防护资源类型：0 VPC，1 VGW

protected_resource_name

String

防护资源名称

protected_resource_id

String

防护资源id

protected_resource_nat_name

String

防护资源nat网关名称

protected_resource_nat_id

String

防护资源nat网关id

protected_resource_project_id

String

防护资源租户id

protected_resource_mode

String

防护资源模式

status

Integer

防护VPC的防护状态，0表示已关联，1表示未关联。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

data

data object

响应体

trace_id

String

trace id
表11 data

参数

参数类型

描述

id

String

标识ID

请求示例

获取东西向防火墙信息

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

状态码

状态码

描述

200

东西向防火墙信息响应

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 防火墙管理