文档首页/ Web应用防火墙 WAF/ API参考/ API/ 防护策略管理/ 更新防护策略

更新时间：2024-11-08 GMT+08:00

在线调试

CLI示例

查看PDF

更新防护策略

功能介绍

更新防护策略，请求体可只传需要更新的部分

调用方法

请参见如何调用API。

URI

PATCH /v1/{project_id}/waf/policy/{policy_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，对应控制台用户名->我的凭证->项目列表->项目ID
policy_id	是	String	防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略id

表2 Query参数
参数	是否必选	参数类型	描述
enterprise_project_id	否	String	您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
Content-Type	是	String	内容类型

表4 请求Body参数
参数	是否必选	参数类型	描述
name	否	String	防护策略名
level	否	Integer	Web基础防护等级 1 : 宽松，防护粒度较粗，只拦截攻击特征比较明显的请求。当误报情况较多的场景下，建议选择“宽松”模式。 2：中等，默认为“中等”防护模式，满足大多数场景下的Web防护需求。 3：严格，防护粒度最精细，可以拦截具有复杂的绕过特征的攻击请求，例如jolokia网络攻击、探测CGI漏洞、探测 Druid SQL注入攻击
full_detection	否	Boolean	精准防护中的检测模式。 false：短路检测，当用户的请求符合精准防护中的拦截条件时，便立刻终止检测，进行拦截 true ：全检测，请求符合精准防护中的拦截条件时，全检测不会立即拦截，会继续执行其他防护的检测，最后进行拦截。
robot_action	否	Action object	用于存放网站反爬虫中特征反爬虫动作信息
action	否	PolicyAction object	防护动作信息
options	否	PolicyOption object	该参数存放防护策略里防护项的开关信息
modulex_options	否	Map<String,Object>	智能访问控制防护项相关配置信息，目前该特性还处于公测阶段，只有部分局点支持该特性
hosts	否	Array of strings	与防护策略绑定的防护的域名id数组（该参数不支持修改，仅作为预留参数，用于后续功能扩展，可忽略）。
bind_host	否	Array of BindHost objects	与防护策略绑定的防护的域名信息数组，相对于hosts字段，包含更详细的域名信息（该参数不支持修改，仅作为预留参数，用于后续功能扩展，可忽略）。
extend	否	Map<String,String>	扩展字段，用于存放Web基础防护中一些开关配置等信息,详情请参考示例使用。 deep_decode：深度检测 check_all_headers ：header全检测 shiro_rememberMe_enable：Shiro解密检测

表5 Action
参数	是否必选	参数类型	描述
category	否	String	特征反爬虫中防护动作信息 log：仅记录 block：拦截

表6 PolicyAction
参数	是否必选	参数类型	描述
category	否	String	web基础防护动作（log为仅记录、block为拦截）
followed_action_id	否	String	攻击惩罚规则ID

表7 PolicyOption
参数	是否必选	参数类型	描述
webattack	否	Boolean	基础防护是否开启
common	否	Boolean	常规检测是否开启
crawler	否	Boolean	预留参数，该参数值一直为true，用户可忽略该参数值
crawler_engine	否	Boolean	搜索engine是否开启
crawler_scanner	否	Boolean	反爬虫检测是否开启
crawler_script	否	Boolean	脚本反爬虫是否开启
crawler_other	否	Boolean	其他爬虫是否开启
webshell	否	Boolean	Webshell检测是否开启
cc	否	Boolean	cc规则是否开启
custom	否	Boolean	精准防护是否开启
whiteblackip	否	Boolean	黑白名单防护是否开启
geoip	否	Boolean	地理位置访问控制规则是否开启
ignore	否	Boolean	误报屏蔽是否开启
privacy	否	Boolean	隐私屏蔽是否开启
antitamper	否	Boolean	网页防篡改规则是否开启
antileakage	否	Boolean	防敏感信息泄露规则是否开启
bot_enable	否	Boolean	网站反爬虫总开关是否开启
modulex_enabled	否	Boolean	modulex智能cc防护是否开启，该特性是公测特性，在公测期间，只支持仅记录模式。

表8 BindHost
参数	是否必选	参数类型	描述
id	否	String	域名ID
hostname	否	String	域名
waf_type	否	String	域名对应模式：cloud（云模式）/premium（独享模式）
mode	否	String	仅独享模式涉及特殊域名模式

响应参数

状态码： 200

表9 响应Body参数
参数	参数类型	描述
id	String	防护策略id
name	String	防护策略名
level	Integer	Web基础防护等级 1 : 宽松，防护粒度较粗，只拦截攻击特征比较明显的请求。当误报情况较多的场景下，建议选择“宽松”模式。 2：中等，默认为“中等”防护模式，满足大多数场景下的Web防护需求。 3：严格，防护粒度最精细，可以拦截具有复杂的绕过特征的攻击请求，例如jolokia网络攻击、探测CGI漏洞、探测 Druid SQL注入攻击
full_detection	Boolean	精准防护中的检测模式。 false：短路检测，当用户的请求符合精准防护中的拦截条件时，便立刻终止检测，进行拦截 true ：全检测，请求符合精准防护中的拦截条件时，全检测不会立即拦截，会继续执行其他防护的检测，最后进行拦截。
robot_action	Action object	用于存放网站反爬虫中特征反爬虫动作信息
action	PolicyAction object	防护动作信息
options	PolicyOption object	该参数存放防护策略里防护项的开关信息
modulex_options	Map<String,Object>	智能访问控制防护项相关配置信息，目前该特性还处于公测阶段，只有部分局点支持该特性
hosts	Array of strings	与防护策略绑定的防护的域名id数组
bind_host	Array of BindHost objects	与防护策略绑定的防护的域名信息数组，相对于hosts字段，包含更详细的域名信息
extend	Map<String,String>	扩展字段，用于存放Web基础防护中一些开关配置等信息
timestamp	Long	创建防护策略的时间

**表10** Action
参数	参数类型	描述
category	String	特征反爬虫中防护动作信息 log：仅记录 block：拦截

**表11** PolicyAction
参数	参数类型	描述
category	String	web基础防护动作（log为仅记录、block为拦截）
followed_action_id	String	攻击惩罚规则ID

**表12** PolicyOption
参数	参数类型	描述
webattack	Boolean	基础防护是否开启
common	Boolean	常规检测是否开启
crawler	Boolean	预留参数，该参数值一直为true，用户可忽略该参数值
crawler_engine	Boolean	搜索engine是否开启
crawler_scanner	Boolean	反爬虫检测是否开启
crawler_script	Boolean	脚本反爬虫是否开启
crawler_other	Boolean	其他爬虫是否开启
webshell	Boolean	Webshell检测是否开启
cc	Boolean	cc规则是否开启
custom	Boolean	精准防护是否开启
whiteblackip	Boolean	黑白名单防护是否开启
geoip	Boolean	地理位置访问控制规则是否开启
ignore	Boolean	误报屏蔽是否开启
privacy	Boolean	隐私屏蔽是否开启
antitamper	Boolean	网页防篡改规则是否开启
antileakage	Boolean	防敏感信息泄露规则是否开启
bot_enable	Boolean	网站反爬虫总开关是否开启
modulex_enabled	Boolean	modulex智能cc防护是否开启，该特性是公测特性，在公测期间，只支持仅记录模式。

**表13** BindHost
参数	参数类型	描述
id	String	域名ID
hostname	String	域名
waf_type	String	域名对应模式：cloud（云模式）/premium（独享模式）
mode	String	仅独享模式涉及特殊域名模式

状态码： 400

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表15** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

状态码： 401

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表17** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

状态码： 500

**表18** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表19** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

请求示例

修改项目id为project_id和防护策略id为policy_id的防护策略中的基础防护开关配置等信息，打开深度检测、header全检测、Shiro解密检测的防护开关。

PATCH https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}?enterprise_project_id=0

{
  "extend" : {
    "extend" : "{\"deep_decode\":true,\"check_all_headers\":true,\"shiro_rememberMe_enable\":true}"
  }
}

关闭项目id为project_id和防护策略id为policy_id的黑白名单防护

PATCH https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}?enterprise_project_id=0

{
  "options" : {
    "whiteblackip" : false
  }
}

响应示例

状态码： 200

{
  "id" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "level" : 2,
  "action" : {
    "category" : "log"
  },
  "options" : {
    "webattack" : true,
    "common" : true,
    "crawler" : true,
    "crawler_engine" : false,
    "crawler_scanner" : true,
    "crawler_script" : false,
    "crawler_other" : false,
    "webshell" : false,
    "cc" : true,
    "custom" : true,
    "whiteblackip" : false,
    "geoip" : true,
    "ignore" : true,
    "privacy" : true,
    "antitamper" : true,
    "antileakage" : false,
    "bot_enable" : true
  },
  "hosts" : [ "c0268b883a854adc8a2cd352193b0e13" ],
  "timestamp" : 1650529538732,
  "full_detection" : false,
  "bind_host" : [ {
    "id" : "c0268b883a854adc8a2cd352193b0e13",
    "hostname" : "www.demo.com",
    "waf_type" : "cloud"
  } ]
}

SDK代码示例

SDK代码示例如下。

修改项目id为project_id和防护策略id为policy_id的防护策略中的基础防护开关配置等信息，打开深度检测、header全检测、Shiro解密检测的防护开关。

        
         
           
           
             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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;

import java.util.Map;
import java.util.HashMap;

public class UpdatePolicySolution {

    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);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdatePolicyRequest request = new UpdatePolicyRequest();
        request.withPolicyId("{policy_id}");
        UpdatePolicyRequestBody body = new UpdatePolicyRequestBody();
        Map<String, String> listbodyExtend = new HashMap<>();
        listbodyExtend.put("extend", "{"deep_decode":true,"check_all_headers":true,"shiro_rememberMe_enable":true}");
        body.withExtend(listbodyExtend);
        request.withBody(body);
        try {
            UpdatePolicyResponse response = client.updatePolicy(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());
        }
    }
}

            

          

        
       

关闭项目id为project_id和防护策略id为policy_id的黑白名单防护

        
         
           
           
             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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class UpdatePolicySolution {

    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);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdatePolicyRequest request = new UpdatePolicyRequest();
        request.withPolicyId("{policy_id}");
        UpdatePolicyRequestBody body = new UpdatePolicyRequestBody();
        PolicyOption optionsbody = new PolicyOption();
        optionsbody.withWhiteblackip(false);
        body.withOptions(optionsbody);
        request.withBody(body);
        try {
            UpdatePolicyResponse response = client.updatePolicy(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());
        }
    }
}

            

          

        
       

修改项目id为project_id和防护策略id为policy_id的防护策略中的基础防护开关配置等信息，打开深度检测、header全检测、Shiro解密检测的防护开关。

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdatePolicyRequest()
        request.policy_id = "{policy_id}"
        listExtendbody = {
            "extend": "{"deep_decode":true,"check_all_headers":true,"shiro_rememberMe_enable":true}"
        }
        request.body = UpdatePolicyRequestBody(
            extend=listExtendbody
        )
        response = client.update_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

关闭项目id为project_id和防护策略id为policy_id的黑白名单防护

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdatePolicyRequest()
        request.policy_id = "{policy_id}"
        optionsbody = PolicyOption(
            whiteblackip=False
        )
        request.body = UpdatePolicyRequestBody(
            options=optionsbody
        )
        response = client.update_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

修改项目id为project_id和防护策略id为policy_id的防护策略中的基础防护开关配置等信息，打开深度检测、header全检测、Shiro解密检测的防护开关。

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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 := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdatePolicyRequest{}
	request.PolicyId = "{policy_id}"
	var listExtendbody = map[string]string{
        "extend": "{"deep_decode":true,"check_all_headers":true,"shiro_rememberMe_enable":true}",
    }
	request.Body = &model.UpdatePolicyRequestBody{
		Extend: listExtendbody,
	}
	response, err := client.UpdatePolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

关闭项目id为project_id和防护策略id为policy_id的黑白名单防护

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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 := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdatePolicyRequest{}
	request.PolicyId = "{policy_id}"
	whiteblackipOptions:= false
	optionsbody := &model.PolicyOption{
		Whiteblackip: &whiteblackipOptions,
	}
	request.Body = &model.UpdatePolicyRequestBody{
		Options: optionsbody,
	}
	response, err := client.UpdatePolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	OK
400	请求失败
401	token权限不足
500	服务器内部错误

错误码

请参见错误码。

父主题：防护策略管理

上一篇：根据Id查询防护策略

下一篇：删除防护策略

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

更新防护策略

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线