Help Center/ Cloud Firewall/ API Reference/ API/ Firewall Management/ Creating an East-West Firewall
Updated on 2024-10-31 GMT+08:00

Creating an East-West Firewall

Function

This API is used to create an east-west firewall.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

Yes

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain the token by referring to Obtaining a User Token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

er_id

Yes

String

ID of the associated enterprise router in the outbound direction, which can be obtained by calling the API for querying the enterprise router list of the Enterprise Router service. Find the enterprise router ID in instances.id (The period [.] is used to separate different levels of objects).

inspection_cidr

Yes

String

CIDR block used for creating a traffic diversion VPC.

mode

Yes

String

East-west firewall mode. Enter er.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

CreateEWFirewallResp object

Return value for creating an east-west firewall.

Table 6 CreateEWFirewallResp

Parameter

Type

Description

id

String

East-west protection ID, corresponding to the object_id field.

er

ER object

Enterprise router information.

inspertion_vpc

CreateEWFirewallInspectVpcResp object

Information about the traffic diversion VPC.

Table 7 ER

Parameter

Type

Description

er_id

String

Enterprise router ID, which is referenced when east-west protection is created.

er_attach_id

String

Connection ID of an enterprise router. This connection is used to connect the firewall and the enterprise router. This field can be used to obtain the connection details on the connection management page after querying a specified enterprise router by its ID on the Enterprise Router page.

Table 8 CreateEWFirewallInspectVpcResp

Parameter

Type

Description

vpc_id

String

ID of a traffic diversion VPC.

subnet_ids

Array of strings

Subnet ID list of the created traffic diversion VPC.

Example Requests

In project 09bb24e6f280d23d0f9fc0104b901480, create a firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in Enterprise Router mode. Set inspection_cidr to 10.1.0.0/24 and er_id to e0b22a23-02cf-4092-ace9-34b39e10dc77.

https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?fw_instance_id=55b26ab5-e4b0-40e8-941c-a1778fe2a500&enterprise_project_id=default

{
  "inspection_cidr" : "10.1.0.0/24",
  "mode" : "er",
  "er_id" : "e0b22a23-02cf-4092-ace9-34b39e10dc77"
}

Example Responses

Status code: 200

Return value for creating an east-west firewall.

{
  "data" : {
    "id" : "acc86ca7-818b-4c3d-8a9a-3915a2b21651",
    "er" : {
      "er_id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43",
      "er_attach_id" : "bd62ddd3-5e20-482b-aefa-9e2940e2b1a9"
    },
    "inspertion_vpc" : {
      "vpc_id" : "00672633-0466-4c35-99ef-5e3f5c813a4b",
      "subnet_ids" : [ "294682a0-1e85-45f5-92c8-e52bee09c204", "a86277bb-35d5-4442-bc0b-2e9d4e6a9080", "95829240-14e0-47e6-b9e7-2ac228e7b00f" ]
    }
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

In project 09bb24e6f280d23d0f9fc0104b901480, create a firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in Enterprise Router mode. Set inspection_cidr to 10.1.0.0/24 and er_id to e0b22a23-02cf-4092-ace9-34b39e10dc77.

 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
48
49
50
51
52
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 CreateEastWestFirewallSolution {

    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();
        CreateEastWestFirewallRequest request = new CreateEastWestFirewallRequest();
        CreateEastWestFirewallRequestBody body = new CreateEastWestFirewallRequestBody();
        body.withMode("er");
        body.withInspectionCidr("10.1.0.0/24");
        body.withErId("e0b22a23-02cf-4092-ace9-34b39e10dc77");
        request.withBody(body);
        try {
            CreateEastWestFirewallResponse response = client.createEastWestFirewall(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

In project 09bb24e6f280d23d0f9fc0104b901480, create a firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in Enterprise Router mode. Set inspection_cidr to 10.1.0.0/24 and er_id to e0b22a23-02cf-4092-ace9-34b39e10dc77.

 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
# 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 = CreateEastWestFirewallRequest()
        request.body = CreateEastWestFirewallRequestBody(
            mode="er",
            inspection_cidr="10.1.0.0/24",
            er_id="e0b22a23-02cf-4092-ace9-34b39e10dc77"
        )
        response = client.create_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

In project 09bb24e6f280d23d0f9fc0104b901480, create a firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in Enterprise Router mode. Set inspection_cidr to 10.1.0.0/24 and er_id to e0b22a23-02cf-4092-ace9-34b39e10dc77.

 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
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.CreateEastWestFirewallRequest{}
	erIdCreateEastWestFirewallRequestBody:= "e0b22a23-02cf-4092-ace9-34b39e10dc77"
	request.Body = &model.CreateEastWestFirewallRequestBody{
		Mode: "er",
		InspectionCidr: "10.1.0.0/24",
		ErId: &erIdCreateEastWestFirewallRequestBody,
	}
	response, err := client.CreateEastWestFirewall(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Return value for creating an east-west firewall.

Error Codes

See Error Codes.