Obtaining East-West Firewall Information

Function

This API is used to obtain east-west firewall information.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	Yes	Integer	Number of records displayed on each page, in the range 1-1024
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.
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
fw_instance_id	No	String	Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	GetEastWestFirewallResponseBody object	Get east west firewall data response

**Table 5** GetEastWestFirewallResponseBody
Parameter	Type	Description
object_id	String	Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.
project_id	String	Project ID
status	Integer	Protection status. The value can be 0 (protection enabled) or 1 (protection disabled).
er_associated_subnet	SubnetInfo object	Information about the subnet associated with ER
firewall_associated_subnets	Array of SubnetInfo objects	Subnet associated with CFW
er	ErInstance object	Information about the associated outbound enterprise router
inspection_vpc	VpcDetail object	Monitoring VPC information
protect_infos	Array of EwProtectResourceInfo objects	East-west protection resource information
total	Integer	Total number of protected VPCs
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.
limit	Integer	Number of records displayed on each page, in the range 1-1024
mode	String	mode
ew_vpc_route_limit	Integer	east west vpc route limit

**Table 6** SubnetInfo
Parameter	Type	Description
availability_zone	String	Subnet ID
cidr	String	vpc cidr
name	String	Subnet name
id	String	Subnet ID
gateway_ip	String	Subnet gateway IP address
vpc_id	String	vpc id
status	String	Subnet status
ipv6_enable	Boolean	Whether IPv6 is supported. The value true indicates yes and the value false indicates no.

**Table 7** ErInstance
Parameter	Type	Description
id	String	ER instance ID
name	String	ER name
state	String	ER status
enterprise_project_id	String	Enterprise user ID
project_id	String	User ID
enable_ipv6	String	Whether to enable IPv6
attachment_id	String	ER attachment id

**Table 8** VpcDetail
Parameter	Type	Description
id	String	id
name	String	Name
cidr	String	vpc cidr
status	String	Status

**Table 9** EwProtectResourceInfo
Parameter	Type	Description
protected_resource_type	Integer	Protection resource type. The value can be 0 (VPC) or 1 (VGW).
protected_resource_name	String	Protected resource name
protected_resource_id	String	Protected resource ID
protected_resource_nat_name	String	Name of the NAT gateway of the protected resource
protected_resource_nat_id	String	ID of the NAT gateway of the protected resource
protected_resource_project_id	String	Tenant ID of the protected resource
protected_resource_mode	String	protected resource mode
status	Integer	The protection status of the protected VPC, 0 indicates that it is associated, and 1 indicates that it is not associated.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 8 Maximum: 36
error_msg	String	Description Minimum: 2 Maximum: 512

Example Requests

Get EastWest Firewall Response

https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0

Example Responses

Status code: 200

Get EastWest Firewall Response

{
  "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,
    "special_vpc" : [ ]
  }
}