更新全局白名单(原误报屏蔽)防护规则
功能介绍
更新全局白名单(原误报屏蔽)防护规则
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
policy_id |
是 |
String |
防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id |
rule_id |
是 |
String |
误报屏蔽规则id,您可以通过查询误报屏蔽规则列表(ListIgnoreRule)接口的响应体中的id字段获取误报屏蔽规则id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain |
是 |
Array of strings |
防护域名或防护网站,数组长度为0时,代表规则对全部域名或防护网站生效 |
conditions |
是 |
Array of CreateCondition objects |
条件列表 |
mode |
是 |
Integer |
固定值为1,代表v2版本误报屏蔽规则,v1版本仅用于兼容旧版本,不支持创建 |
rule |
是 |
String |
需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔
|
advanced |
否 |
IgnoreAdvanced object |
高级配置项 |
description |
否 |
String |
屏蔽规则描述 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
是 |
String |
字段类型,可选值有ip、url、params、cookie、header |
contents |
是 |
Array of strings |
内容,数组长度限制为1,内容格式根据字段类型变化,例如,字段类型为ip时,contents内容格式需为ip地址或ip地址段;字段类型为url时,contents内容格式需为标准url格式;字段类型为params,cookie,header时,内容的格式不做限制 |
logic_operation |
是 |
String |
匹配逻辑,匹配逻辑根据字段类型变化,字段类型为ip时,匹配逻辑支持(equal:等于,not_equal:不等于),字段类型为url、header、params、cookie时,匹配逻辑支持(equal:等于,not_equal:不等于,contain:包含,not_contain:不包含,prefix:前缀为,not_prefix:前缀不为,suffix:后缀为,not_suffix:后缀不为) |
check_all_indexes_logic |
否 |
Integer |
该参数为预留参数,可忽略。 |
index |
否 |
String |
字段类型为ip且子字段为客户端ip时,不需要传index参数;子字段类型为X-Forwarded-For时,值为x-forwarded-for;字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
规则id |
policyid |
String |
策略id |
timestamp |
Long |
创建规则的时间戳 |
description |
String |
规则描述 |
status |
Integer |
规则状态,0:关闭,1:开启 |
url |
String |
误报规则屏蔽路径,仅在mode为0的状态下有该字段 |
rule |
String |
需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔
|
mode |
Integer |
版本号,0代表v1旧版本,1代表v2新版本;mode为0时,不存在conditions字段,存在url和url_logic字段;mode为1时,不存在url和url_logic字段,存在conditions字段 |
url_logic |
String |
url匹配逻辑 |
conditions |
Array of Condition objects |
条件 |
advanced |
IgnoreAdvanced object |
高级配置项 |
domain |
Array of strings |
防护域名或防护网站 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
字段类型,可选值有ip、url、params、cookie、header |
contents |
Array of strings |
内容,数组长度限制为1,内容格式根据字段类型变化,例如,字段类型为ip时,contents内容格式需为ip地址或ip地址段;字段类型为url时,contents内容格式需为标准url格式;字段类型为params、cookie、header时,内容的格式不做限制 |
logic_operation |
String |
匹配逻辑,匹配逻辑根据字段类型变化,字段类型为ip时,匹配逻辑支持(equal:等于,not_equal:不等于),字段类型为url、header、params、cookie时,匹配逻辑支持(equal:等于,not_equal:不等于,contain:包含,not_contain:不包含,prefix:前缀为,not_prefix:前缀不为,suffix:后缀为,not_suffix:后缀不为) |
check_all_indexes_logic |
Integer |
该参数为预留参数,可忽略。 |
index |
String |
字段类型为ip且子字段为客户端ip时,不存在index参数;子字段类型为X-Forwarded-For时,值为x-forwarded-for,字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段 |
参数 |
参数类型 |
描述 |
---|---|---|
index |
String |
字段类型,支持的字段类型有:params、cookie、header、body、multipart。
|
contents |
Array of strings |
指定字段类型的子字段,默认值为“全部” |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
更新项目id为project_id,防护策略id为policy_id,规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含”/test“,需要屏蔽的规则为网站木马和其他类型攻击,配置高级配置项为全部参数。
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id} { "domain" : [ ], "mode" : 1, "description" : "", "conditions" : [ { "category" : "url", "logic_operation" : "contain", "index" : null, "contents" : [ "/test" ] } ], "rule" : "webshell;vuln", "advanced" : { "index" : "params", "contents" : [ ] } }
响应示例
状态码: 200
请求成功
{ "id" : "16e81d9a9e0244359204d7f00326ee4f", "policyid" : "0681f69f94ac408e9688373e45a61fdb", "timestamp" : 1679106005786, "description" : "", "status" : 1, "rule" : "webshell;vuln", "mode" : 1, "conditions" : [ { "category" : "url", "contents" : [ "/test" ], "logic_operation" : "contain" } ], "domain" : [ ], "advanced" : { "index" : "params", "contents" : [ ] } }
SDK代码示例
SDK代码示例如下。
更新项目id为project_id,防护策略id为policy_id,规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含”/test“,需要屏蔽的规则为网站木马和其他类型攻击,配置高级配置项为全部参数。
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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
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.List; import java.util.ArrayList; public class UpdateIgnoreRuleSolution { 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(); UpdateIgnoreRuleRequest request = new UpdateIgnoreRuleRequest(); request.withPolicyId("{policy_id}"); request.withRuleId("{rule_id}"); UpdateIgnoreRuleRequestBody body = new UpdateIgnoreRuleRequestBody(); IgnoreAdvanced advancedbody = new IgnoreAdvanced(); advancedbody.withIndex("params"); List<String> listConditionsContents = new ArrayList<>(); listConditionsContents.add("/test"); List<CreateCondition> listbodyConditions = new ArrayList<>(); listbodyConditions.add( new CreateCondition() .withCategory("url") .withContents(listConditionsContents) .withLogicOperation("contain") ); body.withDescription(""); body.withAdvanced(advancedbody); body.withRule("webshell;vuln"); body.withMode(1); body.withConditions(listbodyConditions); request.withBody(body); try { UpdateIgnoreRuleResponse response = client.updateIgnoreRule(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,规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含”/test“,需要屏蔽的规则为网站木马和其他类型攻击,配置高级配置项为全部参数。
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 53 |
# 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 = UpdateIgnoreRuleRequest() request.policy_id = "{policy_id}" request.rule_id = "{rule_id}" advancedbody = IgnoreAdvanced( index="params" ) listContentsConditions = [ "/test" ] listConditionsbody = [ CreateCondition( category="url", contents=listContentsConditions, logic_operation="contain" ) ] request.body = UpdateIgnoreRuleRequestBody( description="", advanced=advancedbody, rule="webshell;vuln", mode=1, conditions=listConditionsbody ) response = client.update_ignore_rule(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,规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含”/test“,需要屏蔽的规则为网站木马和其他类型攻击,配置高级配置项为全部参数。
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 53 54 55 56 57 58 59 60 61 |
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.UpdateIgnoreRuleRequest{} request.PolicyId = "{policy_id}" request.RuleId = "{rule_id}" indexAdvanced:= "params" advancedbody := &model.IgnoreAdvanced{ Index: &indexAdvanced, } var listContentsConditions = []string{ "/test", } var listConditionsbody = []model.CreateCondition{ { Category: "url", Contents: listContentsConditions, LogicOperation: "contain", }, } descriptionUpdateIgnoreRuleRequestBody:= "" request.Body = &model.UpdateIgnoreRuleRequestBody{ Description: &descriptionUpdateIgnoreRuleRequestBody, Advanced: advancedbody, Rule: "webshell;vuln", Mode: int32(1), Conditions: listConditionsbody, } response, err := client.UpdateIgnoreRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。