创建精准防护规则
功能介绍
创建精准防护规则
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/policy/{policy_id}/custom
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
policy_id |
是 |
String |
防护策略id,通过指定防护策略id来指明查询该防护策略下的防护规则,您可以通过调用查询防护策略列表(ListPolicy)获取策略id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
time |
是 |
Boolean |
精准防护规则生效时间:
|
start |
否 |
Long |
精准防护规则生效的起始时间戳(秒)。当time=true,才需要填写该参数。 |
terminal |
否 |
Long |
精准防护规则生效的终止时间戳(秒)。当time=true,才需要填写该参数。 |
description |
否 |
String |
规则描述 |
conditions |
是 |
Array of CustomConditions objects |
匹配条件列表 |
action |
是 |
CustomAction object |
精准防护规则命中后操作对象 |
priority |
是 |
Integer |
执行该规则的优先级,值越小,优先级越高,值相同时,规则创建时间早,优先级越高。取值范围:0到1000。 |
name |
是 |
String |
规则名称 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
否 |
String |
字段类型。可选值为:url、user-agent、ip、params、cookie、referer、header、request_line、method、request |
index |
否 |
String |
子字段:
|
logic_operation |
否 |
String |
条件列表匹配逻辑。
|
contents |
否 |
Array of strings |
条件列表逻辑匹配内容。当logic_operation参数不以any或者all结尾时,需要传该参数。 |
value_list_id |
否 |
String |
引用表id。当logic_operation参数以any或者all结尾时,需要传该参数。此外,引用表类型要与category类型保持一致。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
规则id |
name |
String |
规则名称 |
policyid |
String |
策略id |
description |
String |
规则描述 |
status |
Integer |
规则状态,0:关闭,1:开启 |
conditions |
Array of conditions objects |
匹配条件列表,匹配条件必须同时满足。 |
action |
CustomAction object |
精准防护规则命中后操作对象 |
action_mode |
Boolean |
预留参数,可忽略。 |
priority |
Integer |
执行该规则的优先级,值越小,优先级越高,值相同时,规则创建时间早,优先级越高。取值范围:0到1000。 |
timestamp |
Long |
创建精准防护规则的 |
time |
Boolean |
精准防护规则生效时间:
|
start |
Long |
精准防护规则生效的起始时间戳(秒)。当time=true,才会返回该参数。 |
terminal |
Long |
精准防护规则生效的终止时间戳(秒)。当time=true,才会返回该参数。 |
producer |
Integer |
规则创建对象,该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
字段类型。可选值为:url、user-agent、ip、params、cookie、referer、header、request_line、method、reqeust |
index |
String |
子字段:
|
logic_operation |
String |
条件匹配逻辑。 |
contents |
Array of strings |
条件匹配的内容 |
value_list_id |
String |
引用表id。 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
操作类型。
|
followed_action_id |
String |
攻击惩罚规则id,只有当category参数值为block时才可配置该参数 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
在项目id为project_id和防护策略id为policy_id的防护策略下创建精准防护规则。规则的名称test55,精准防护规则命中后防护动作为拦截,执行该规则的优先级为50,匹配条件为header中发现demo字段包含“demo“,精准防护规则生效时间为立即生效。
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/custom?enterprise_project_id=0 { "name" : "test55", "description" : "", "action" : { "category" : "block" }, "priority" : 50, "conditions" : [ { "category" : "header", "logic_operation" : "contain", "index" : "demo", "contents" : [ "demo" ] } ], "time" : false }
响应示例
状态码: 200
ok
{ "action" : { "category" : "block" }, "action_mode" : false, "conditions" : [ { "category" : "header", "index" : "demo", "logic_operation" : "contain", "contents" : [ "demo" ] } ], "description" : "", "name" : "test55", "id" : "2a3caa2bc9814c09ad73d02e3485b4a4", "policyid" : "1f016cde588646aca3fb19f277c44d03", "priority" : 50, "status" : 1, "time" : false, "timestamp" : 1656495488880 }
SDK代码示例
SDK代码示例如下。
在项目id为project_id和防护策略id为policy_id的防护策略下创建精准防护规则。规则的名称test55,精准防护规则命中后防护动作为拦截,执行该规则的优先级为50,匹配条件为header中发现demo字段包含“demo“,精准防护规则生效时间为立即生效。
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 70 |
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 CreateCustomRuleSolution { 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(); CreateCustomRuleRequest request = new CreateCustomRuleRequest(); request.withPolicyId("{policy_id}"); CreateCustomRuleRequestBody body = new CreateCustomRuleRequestBody(); CustomAction actionbody = new CustomAction(); actionbody.withCategory(CustomAction.CategoryEnum.fromValue("block")); List<String> listConditionsContents = new ArrayList<>(); listConditionsContents.add("demo"); List<CustomConditions> listbodyConditions = new ArrayList<>(); listbodyConditions.add( new CustomConditions() .withCategory(CustomConditions.CategoryEnum.fromValue("header")) .withIndex("demo") .withLogicOperation("contain") .withContents(listConditionsContents) ); body.withName("test55"); body.withPriority(50); body.withAction(actionbody); body.withConditions(listbodyConditions); body.withDescription(""); body.withTime(false); request.withBody(body); try { CreateCustomRuleResponse response = client.createCustomRule(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的防护策略下创建精准防护规则。规则的名称test55,精准防护规则命中后防护动作为拦截,执行该规则的优先级为50,匹配条件为header中发现demo字段包含“demo“,精准防护规则生效时间为立即生效。
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 |
# 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 = CreateCustomRuleRequest() request.policy_id = "{policy_id}" actionbody = CustomAction( category="block" ) listContentsConditions = [ "demo" ] listConditionsbody = [ CustomConditions( category="header", index="demo", logic_operation="contain", contents=listContentsConditions ) ] request.body = CreateCustomRuleRequestBody( name="test55", priority=50, action=actionbody, conditions=listConditionsbody, description="", time=False ) response = client.create_custom_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的防护策略下创建精准防护规则。规则的名称test55,精准防护规则命中后防护动作为拦截,执行该规则的优先级为50,匹配条件为header中发现demo字段包含“demo“,精准防护规则生效时间为立即生效。
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 |
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.CreateCustomRuleRequest{} request.PolicyId = "{policy_id}" actionbody := &model.CustomAction{ Category: model.GetCustomActionCategoryEnum().BLOCK, } var listContentsConditions = []string{ "demo", } categoryConditions:= model.GetCustomConditionsCategoryEnum().HEADER indexConditions:= "demo" logicOperationConditions:= "contain" var listConditionsbody = []model.CustomConditions{ { Category: &categoryConditions, Index: &indexConditions, LogicOperation: &logicOperationConditions, Contents: &listContentsConditions, }, } descriptionCreateCustomRuleRequestBody:= "" request.Body = &model.CreateCustomRuleRequestBody{ Name: "test55", Priority: int32(50), Action: actionbody, Conditions: listConditionsbody, Description: &descriptionCreateCustomRuleRequestBody, Time: false, } response, err := client.CreateCustomRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
ok |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。