CFW

更新时间：2026-03-23

创建CFW策略

函数声明

                Java
                
                public CreateCfwResponse createCfw(CreateCfwRequest body) {
    ......
}

参数含义

参数名	类型	说明
name	String	CFW名称，长度不超过65个字符，可由数字、字符、下划线组成
description	String	CFW描述，不超过200字符
cfwRules	List	CFW规则列表

CreateRule参数说明：

参数名	类型	说明
ipVersion	Integer	IP版本
priority	Integer	优先级
protocol	String	协议类型
direction	String	方向（入站/出站）
sourceAddress	String	源地址
destAddress	String	目的地址
sourcePort	String	源端口
destPort	String	目的端口
action	String	动作（允许/拒绝）
description	String	规则描述

返回值

操作成功

Plain Text

1{
2    "metadata":具体信息参考附录metadata部分,
3    "cfwId":"cfw-xxxxxxxx"
4}

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.CreateCfwRequest;
import com.baidubce.services.cfw.model.CreateCfwResponse;
import java.util.ArrayList;
import java.util.List;

public class CreateCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        CreateCfwRequest request = new CreateCfwRequest();
        request.setName("my-cfw-policy");
        request.setDescription("测试CFW策略");
        
        // 创建规则
        List<CreateCfwRequest.CreateRule> rules = new ArrayList<>();
        CreateCfwRequest.CreateRule rule = new CreateCfwRequest.CreateRule();
        rule.setIpVersion(4);
        rule.setPriority(100);
        rule.setProtocol("TCP");
        rule.setDirection("ingress");
        rule.setSourceAddress("0.0.0.0/0");
        rule.setDestAddress("10.0.0.0/8");
        rule.setSourcePort("1-65535");
        rule.setDestPort("80");
        rule.setAction("allow");
        rule.setDescription("允许HTTP访问");
        rules.add(rule);
        
        request.setCfwRules(rules);
        
        CreateCfwResponse response = client.createCfw(request);
        System.out.println("创建的CFW ID: " + response.getCfwId());
    }
}
            

查询CFW策略详情

函数声明

                Java
                
                public GetCfwResponse getCfw(String cfwId) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID

返回值

操作成功

Plain Text

1{
2    "metadata":具体信息参考附录metadata部分,
3    "cfwId":"cfw-xxxxxxxx",
4    "name":"my-cfw-policy",
5    "description":"测试CFW策略",
6    "createdTime":"2024-01-01T00:00:00Z",
7    "bindInstanceNum":5,
8    "cfwRules": [
9        {
10            "cfwRuleId":"rule-xxxxxxxx",
11            "ipVersion":4,
12            "priority":100,
13            "protocol":"TCP",
14            "direction":"ingress",
15            "sourceAddress":"0.0.0.0/0",
16            "destAddress":"10.0.0.0/8",
17            "sourcePort":"1-65535",
18            "destPort":"80",
19            "action":"allow",
20            "description":"允许HTTP访问"
21        }
22    ]
23}

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.GetCfwResponse;

public class GetCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        GetCfwResponse response = client.getCfw(cfwId);
        
        System.out.println("CFW名称: " + response.getName());
        System.out.println("CFW描述: " + response.getDescription());
        System.out.println("创建时间: " + response.getCreatedTime());
        System.out.println("绑定实例数量: " + response.getBindInstanceNum());
    }
}
            

查询CFW策略列表

函数声明

                Java
                
                public ListCfwResponse listCfw(ListCfwRequest request) {
    ......
}

参数含义

参数名	类型	说明
marker	String	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	Integer	每页包含的最大数量，最大数量通常不超过1000。缺省值为1000

返回值

操作成功

Plain Text

1{
2    "metadata":具体信息参考附录metadata部分,
3    "marker":"",
4    "isTruncated":false,
5    "nextMarker":"",
6    "maxKeys":1000,
7    "cfws": [
8        {
9            "cfwId":"cfw-xxxxxxxx",
10            "name":"my-cfw-policy",
11            "description":"测试CFW策略",
12            "createdTime":"2024-01-01T00:00:00Z",
13            "bindInstanceNum":5,
14            "cfwRules":[...]
15        }
16    ]
17}

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.ListCfwRequest;
import com.baidubce.services.cfw.model.ListCfwResponse;

public class ListCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        ListCfwRequest request = new ListCfwRequest();
        request.setMaxKeys(100);
        
        ListCfwResponse response = client.listCfw(request);
        
        System.out.println("CFW策略总数: " + response.getCfws().size());
        for (ListCfwResponse.Cfw cfw : response.getCfws()) {
            System.out.println("CFW ID: " + cfw.getCfwId() + ", 名称: " + cfw.getName());
        }
    }
}
            

更新CFW策略

函数声明

                Java
                
                public void updateCfw(String cfwId, UpdateCfwRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
name	String	CFW名称，长度不超过65个字符，可由数字、字符、下划线组成
description	String	CFW描述，不超过200字符

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.UpdateCfwRequest;

public class UpdateCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        UpdateCfwRequest request = new UpdateCfwRequest();
        request.setName("updated-cfw-policy");
        request.setDescription("更新后的CFW策略描述");
        
        client.updateCfw(cfwId, request);
        System.out.println("CFW策略更新成功");
    }
}
            

删除CFW策略

函数声明

                Java
                
                public void deleteCfw(String cfwId) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID

注意：CFW存在绑定关系时不允许删除

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;

public class DeleteCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        client.deleteCfw(cfwId);
        System.out.println("CFW策略删除成功");
    }
}
            

批量创建CFW规则

函数声明

                Java
                
                public void createCfwRule(String cfwId, CreateCfwRuleRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
cfwRules	List	CFW规则列表

CreateRule参数说明：

参数名	类型	说明
ipVersion	Integer	IP版本
priority	Integer	优先级
protocol	String	协议类型
direction	String	方向（ingress/egress）
sourceAddress	String	源地址
destAddress	String	目的地址
sourcePort	String	源端口
destPort	String	目的端口
action	String	动作（allow/deny）
description	String	规则描述

注意：

五元组(protocol/sourceAddress/destAddress/sourcePort/destPort) + 方向(direction)不能全部相同

一次最多创建100条规则

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.CreateCfwRuleRequest;
import java.util.ArrayList;
import java.util.List;

public class CreateCfwRuleExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        CreateCfwRuleRequest request = new CreateCfwRuleRequest();
        
        List<CreateCfwRuleRequest.CreateRule> rules = new ArrayList<>();
        
        // 创建第一条规则
        CreateCfwRuleRequest.CreateRule rule1 = new CreateCfwRuleRequest.CreateRule();
        rule1.setIpVersion(4);
        rule1.setPriority(100);
        rule1.setProtocol("TCP");
        rule1.setDirection("ingress");
        rule1.setSourceAddress("0.0.0.0/0");
        rule1.setDestAddress("10.0.0.0/8");
        rule1.setSourcePort("1-65535");
        rule1.setDestPort("80");
        rule1.setAction("allow");
        rule1.setDescription("允许HTTP访问");
        rules.add(rule1);
        
        // 创建第二条规则
        CreateCfwRuleRequest.CreateRule rule2 = new CreateCfwRuleRequest.CreateRule();
        rule2.setIpVersion(4);
        rule2.setPriority(101);
        rule2.setProtocol("TCP");
        rule2.setDirection("ingress");
        rule2.setSourceAddress("0.0.0.0/0");
        rule2.setDestAddress("10.0.0.0/8");
        rule2.setSourcePort("1-65535");
        rule2.setDestPort("443");
        rule2.setAction("allow");
        rule2.setDescription("允许HTTPS访问");
        rules.add(rule2);
        
        request.setCfwRules(rules);
        
        client.createCfwRule(cfwId, request);
        System.out.println("CFW规则创建成功");
    }
}
            

修改CFW规则

函数声明

                Java
                
                public void updateCfwRule(String cfwId, String cfwRuleId, UpdateCfwRuleRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
cfwRuleId	String	CFW规则的ID
ipVersion	Integer	IP版本
priority	Integer	优先级
protocol	String	协议类型
direction	String	方向（ingress/egress）
sourceAddress	String	源地址
destAddress	String	目的地址
sourcePort	String	源端口
destPort	String	目的端口
action	String	动作（allow/deny）
description	String	规则描述

注意：五元组(protocol/sourceAddress/destAddress/sourcePort/destPort) + 方向(direction)不能全部相同

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.UpdateCfwRuleRequest;

public class UpdateCfwRuleExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        String cfwRuleId = "rule-xxxxxxxx";
        
        UpdateCfwRuleRequest request = new UpdateCfwRuleRequest();
        request.setPriority(200);
        request.setDescription("更新后的规则描述");
        
        client.updateCfwRule(cfwId, cfwRuleId, request);
        System.out.println("CFW规则更新成功");
    }
}
            

批量删除CFW规则

函数声明

                Java
                
                public void deleteCfwRule(String cfwId, DeleteCfwRuleRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
cfwRuleIds	List	CFW规则ID列表

注意：CFW已绑定到实例时，至少保留一条规则

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.DeleteCfwRuleRequest;
import java.util.Arrays;

public class DeleteCfwRuleExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        
        DeleteCfwRuleRequest request = new DeleteCfwRuleRequest();
        request.setCfwRuleIds(Arrays.asList("rule-xxxxxxxx", "rule-yyyyyyyy"));
        
        client.deleteCfwRule(cfwId, request);
        System.out.println("CFW规则删除成功");
    }
}
            

批量绑定CFW策略到实例

函数声明

                Java
                
                public void bindCfw(String cfwId, BindCfwRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
instanceType	String	实例类型，取值：eip、nat、etGateway、peerconn、csn、ipv6Gateway
instances	List	绑定实例信息列表

CfwBind参数说明：

参数名	类型	说明
region	String	实例所在区域
instanceId	String	实例ID
role	String	角色（对于某些实例类型需要）
memberId	String	成员ID（对于某些实例类型需要）

注意：没有规则的CFW不能绑定到实例

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.BindCfwRequest;
import java.util.ArrayList;
import java.util.List;

public class BindCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        
        BindCfwRequest request = new BindCfwRequest();
        request.setInstanceType("eip");
        
        List<BindCfwRequest.CfwBind> instances = new ArrayList<>();
        
        BindCfwRequest.CfwBind instance1 = new BindCfwRequest.CfwBind();
        instance1.setRegion("bj");
        instance1.setInstanceId("eip-xxxxxxxx");
        instances.add(instance1);
        
        BindCfwRequest.CfwBind instance2 = new BindCfwRequest.CfwBind();
        instance2.setRegion("gz");
        instance2.setInstanceId("eip-yyyyyyyy");
        instances.add(instance2);
        
        request.setInstances(instances);
        
        client.bindCfw(cfwId, request);
        System.out.println("CFW策略绑定成功");
    }
}
            

批量解绑CFW策略

函数声明

                Java
                
                public void unbindCfw(String cfwId, UnbindCfwRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
instanceType	String	实例类型，取值：eip、nat、etGateway、peerconn、csn、ipv6Gateway
instances	List	解绑实例信息列表

CfwUnbind参数说明：

参数名	类型	说明
region	String	实例所在区域
instanceId	String	实例ID
role	String	角色（对于某些实例类型需要）
memberId	String	成员ID（对于某些实例类型需要）

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.UnbindCfwRequest;
import java.util.ArrayList;
import java.util.List;

public class UnbindCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        
        UnbindCfwRequest request = new UnbindCfwRequest();
        request.setInstanceType("eip");
        
        List<UnbindCfwRequest.CfwUnbind> instances = new ArrayList<>();
        
        UnbindCfwRequest.CfwUnbind instance1 = new UnbindCfwRequest.CfwUnbind();
        instance1.setRegion("bj");
        instance1.setInstanceId("eip-xxxxxxxx");
        instances.add(instance1);
        
        request.setInstances(instances);
        
        client.unbindCfw(cfwId, request);
        System.out.println("CFW策略解绑成功");
    }
}
            

临时关闭CFW防护

函数声明

                Java
                
                public void disableCfw(String cfwId, DisableCfwRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
instanceType	String	实例类型，取值：eip、nat、etGateway、peerconn、csn、ipv6Gateway
instances	List	需要关闭防护的实例信息列表

CfwDisable参数说明：

参数名	类型	说明
region	String	实例所在区域
instanceId	String	实例ID
role	String	角色（对于某些实例类型需要）
memberId	String	成员ID（对于某些实例类型需要）

说明：已绑定CFW的实例，使用该接口临时关闭CFW的防护功能

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.DisableCfwRequest;
import java.util.ArrayList;
import java.util.List;

public class DisableCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        
        DisableCfwRequest request = new DisableCfwRequest();
        request.setInstanceType("eip");
        
        List<DisableCfwRequest.CfwDisable> instances = new ArrayList<>();
        
        DisableCfwRequest.CfwDisable instance1 = new DisableCfwRequest.CfwDisable();
        instance1.setRegion("bj");
        instance1.setInstanceId("eip-xxxxxxxx");
        instances.add(instance1);
        
        request.setInstances(instances);
        
        client.disableCfw(cfwId, request);
        System.out.println("CFW防护已临时关闭");
    }
}
            

恢复CFW防护

函数声明

                Java
                
                public void enableCfw(String cfwId, EnableCfwRequest body) {
    ......
}

参数含义

参数名	类型	说明
cfwId	String	CFW策略的ID
instanceType	String	实例类型，取值：eip、nat、etGateway、peerconn、csn、ipv6Gateway
instances	List	需要恢复防护的实例信息列表

CfwEnable参数说明：

参数名	类型	说明
region	String	实例所在区域
instanceId	String	实例ID
role	String	角色（对于某些实例类型需要）
memberId	String	成员ID（对于某些实例类型需要）

说明：已绑定CFW并且临时关闭了防护功能的实例，使用该接口恢复CFW的防护功能

返回值

操作成功

无

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.EnableCfwRequest;
import java.util.ArrayList;
import java.util.List;

public class EnableCfwExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        String cfwId = "cfw-xxxxxxxx";
        
        EnableCfwRequest request = new EnableCfwRequest();
        request.setInstanceType("eip");
        
        List<EnableCfwRequest.CfwEnable> instances = new ArrayList<>();
        
        EnableCfwRequest.CfwEnable instance1 = new EnableCfwRequest.CfwEnable();
        instance1.setRegion("bj");
        instance1.setInstanceId("eip-xxxxxxxx");
        instances.add(instance1);
        
        request.setInstances(instances);
        
        client.enableCfw(cfwId, request);
        System.out.println("CFW防护已恢复");
    }
}
            

查询防护边界实例列表

函数声明

                Java
                
                public ListInstanceResponse listInstance(ListInstanceRequest request) {
    ......
}

参数含义

参数名	类型	说明
instanceType	String	实例类型，必填，取值：eip、nat、etGateway、peerconn、csn、ipv6Gateway
marker	String	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	Integer	每页包含的最大数量，最大数量通常不超过1000。缺省值为1000
status	String	实例状态（可选）
region	String	实例所在区域（可选）

返回值

操作成功

Plain Text

1{
2    "metadata":具体信息参考附录metadata部分,
3    "marker":"",
4    "isTruncated":false,
5    "nextMarker":"",
6    "maxKeys":1000,
7    "instances": [
8        {
9            "instanceId":"eip-xxxxxxxx",
10            "instanceName":"my-eip",
11            "status":"available",
12            "region":"bj",
13            "cfwId":"cfw-xxxxxxxx",
14            "cfwName":"my-cfw-policy",
15            "vpcId":"vpc-xxxxxxxx",
16            "vpcName":"my-vpc",
17            "publicIp":"1.2.3.4"
18        }
19    ]
20}

操作失败

操作失败返回异常，参考异常处理章节

代码示例

                Java
                
            

                import com.baidubce.services.cfw.CfwClient;
import com.baidubce.services.cfw.model.ListInstanceRequest;
import com.baidubce.services.cfw.model.ListInstanceResponse;

public class ListInstanceExample {
    public static void main(String[] args) {
        String ak = "your-access-key-id";
        String sk = "your-secret-access-key";
        
        CfwClient client = new CfwClient(ak, sk);
        
        ListInstanceRequest request = new ListInstanceRequest();
        request.setInstanceType("eip");
        request.setMaxKeys(100);
        request.setRegion("bj");
        
        ListInstanceResponse response = client.listInstance(request);
        
        System.out.println("实例总数: " + response.getInstances().size());
        for (ListInstanceResponse.Instance instance : response.getInstances()) {
            System.out.println("实例ID: " + instance.getInstanceId() 
                    + ", 名称: " + instance.getInstanceName()
                    + ", CFW策略: " + instance.getCfwName());
        }
    }
}
            

附录

公共返回信息metadata格式

Plain Text

1 {
2      "bceRequestId":"f5f0821d-45fe-439b-bbf4-fc48b639f84a",
3      "contentLength":28,
4      "contentType":"application/json;charset=UTF-8",
5      "date":1701917695000,
6      "server":"openresty/1.15.8.1"
7 }

评价此篇文章

有帮助没帮助

初始化

异常处理

百度智能云

云防火墙 CFW

云防火墙 CFW

CFW

创建CFW策略

查询CFW策略详情

查询CFW策略列表

更新CFW策略

删除CFW策略

批量创建CFW规则

修改CFW规则

批量删除CFW规则

批量绑定CFW策略到实例

批量解绑CFW策略

临时关闭CFW防护

恢复CFW防护

查询防护边界实例列表

附录