# 选中多个策略批量添加精准防护规则 - BatchCreateCustomRule #### 功能介绍 选中多个策略为这些策略批量添加精准防护规则 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-waf/waf_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-waf/waf_02_0119.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v1/{project_id}/waf/rule/custom 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，对应控制台用户名-\>我的凭证-\>项目列表-\>项目ID。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释：** 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。 **约束限制：** 不涉及 **取值范围：** - 0：代表default企业项目 - all_granted_eps：代表所有企业项目 - 其它企业项目ID：长度为36个字符 **默认取值：** 0 | | policyids | 否 | Array of strings | **参数解释：** 策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取，多个策略之间用","隔开 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Content-Type | 是 | String | **参数解释：** 内容类型 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json;charset=utf8 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time | 是 | Boolean | 精准防护规则生效时间: - false：表示该规则立即生效 - true：表示自定义生效时间 | | start | 否 | Long | 精准防护规则生效的起始时间戳（秒）。当time=true，才需要填写该参数。 | | terminal | 否 | Long | 精准防护规则生效的终止时间戳（秒）。当time=true，才需要填写该参数。 | | description | 否 | String | 规则描述 | | conditions | 是 | Array of [CustomConditions] objects | 匹配条件列表 | | action | 是 | [CustomAction] object | 精准防护规则命中后操作对象 | | priority | 是 | Integer | 执行该规则的优先级，值越小，优先级越高，值相同时，规则创建时间早，优先级越高。取值范围：0到65535。 | | name | 是 | String | 规则名称 | | policy_ids | 是 | Array of strings | 添加规则的策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取，多个策略之间用","隔开 | 表5CustomConditions | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | category | 否 | String | 字段类型。可选值为：url、user-agent、ip、params、cookie、referer、header、request_line、method、request | | index | 否 | String | 子字段： - 字段类型为url、user-agent、ip、refer、request_line、method、request时，不需要传index参数 - 字段类型为params、header、cookie并且子字段为自定义时，index的值为自定义子字段 | | logic_operation | 否 | String | 条件列表匹配逻辑。 - 如果字段类型category是url、user-agent或者referer， 匹配逻辑可以为：contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 contain_any、 not_contain_all、 equal_any、 not_equal_all、 equal_any、 not_equal_all、 prefix_any、 not_prefix_all、 suffix_any、 not_suffix_all、 len_greater、 len_less、len_equal或者len_not_equal - 如果字段类型category是ip, 匹配逻辑可以为： equal、not_equal、equal_any或者not_equal_all - 如果字段类型category是method, 匹配逻辑可以为： equal或者not_equal n - 如果字段类型category是request_line或者request, 匹配逻辑可以为： len_greater、len_less、len_equal或者len_not_equal - 如果字段类型category是params、cookie或者header, 匹配逻辑可以为：contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 contain_any、 not_contain_all、 equal_any、 not_equal_all、 equal_any、 not_equal_all、 prefix_any、 not_prefix_all、 suffix_any、 not_suffix_all、 len_greater、 len_less、len_equal、len_not_equal、、num_greater、num_less、num_equal、num_not_equal、exist或者not_exist | | contents | 否 | Array of strings | 条件列表逻辑匹配内容。当logic_operation参数不以any或者all结尾时，需要传该参数。 | | value_list_id | 否 | String | 引用表id。当logic_operation参数以any或者all结尾时，需要传该参数。此外，引用表类型要与category类型保持一致。 | 表6CustomAction | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | category | 是 | String | 操作类型。 - block：拦截 - pass：放行 - log：仅记录 | | followed_action_id | 否 | String | 攻击惩罚规则id，只有当category参数值为block时才可配置该参数 | #### 响应参数 **状态码：200** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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到65535。 | | timestamp | Long | 创建精准防护规则的 | | time | Boolean | 精准防护规则生效时间: - false：表示该规则立即生效 - true：表示自定义生效时间 | | start | Long | 精准防护规则生效的起始时间戳（秒）。当time=true，才会返回该参数。 | | terminal | Long | 精准防护规则生效的终止时间戳（秒）。当time=true，才会返回该参数。 | | producer | Integer | 规则创建对象，该参数为预留参数，用于后续功能扩展，当前请用户忽略该参数 | 表8conditions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | 字段类型。可选值为：url、user-agent、ip、params、cookie、referer、header、request_line、method、reqeust | | index | String | 子字段： - 字段类型为url、user-agent、ip、refer、request_line、method、reqeust时，不需要传index参数 - 字段类型为params、header、cookie并且子字段为自定义时，index的值为自定义子字段 | | logic_operation | String | 条件匹配逻辑 | | contents | Array of strings | 条件匹配的内容 | | value_list_id | String | 引用表id。 | 表9CustomAction | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | 操作类型。 - block：拦截 - pass：放行 - log：仅记录 | | followed_action_id | String | 攻击惩罚规则id，只有当category参数值为block时才可配置该参数 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表11IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：401** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表13IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表15IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | #### 请求示例 选中多个策略为这些策略批量添加精准防护规则 ``` POST https://{endpoint}/v1/{project_id}/waf/rule/custom?enterprise_project_id=0 { "action" : { "category" : "block" }, "priority" : 50, "description" : "", "time" : false, "name" : "test2", "conditions" : [ { "category" : "header", "logic_operation" : "contain", "index" : "demo", "contents" : [ "demo" ] } ], "policy_ids" : [ "policy_id" ] } ``` #### 响应示例 **状态码：200** ``` { "id" : "2b5788b1859547d99b01628e1a51cd1e", "policyid" : "d9e266bd2d9a44f39194d8cc242b7846", "status" : 1, "timestamp" : 1782800309680, "action" : { "category" : "block" }, "priority" : 50, "description" : "", "time" : false, "name" : "test2", "conditions" : [ { "category" : "header", "logic_operation" : "contain", "index" : "demo", "contents" : [ "demo" ] } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 选中多个策略为这些策略批量添加精准防护规则 ``` 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 BatchCreateCustomRuleSolution { 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("")) .build(); BatchCreateCustomRuleRequest request = new BatchCreateCustomRuleRequest(); BatchCreateCustomRuleRequestBody body = new BatchCreateCustomRuleRequestBody(); List listbodyPolicyIds = new ArrayList<>(); listbodyPolicyIds.add("policy_id"); CustomAction actionbody = new CustomAction(); actionbody.withCategory(CustomAction.CategoryEnum.fromValue("block")); List listConditionsContents = new ArrayList<>(); listConditionsContents.add("demo"); List listbodyConditions = new ArrayList<>(); listbodyConditions.add( new CustomConditions() .withCategory(CustomConditions.CategoryEnum.fromValue("header")) .withIndex("demo") .withLogicOperation("contain") .withContents(listConditionsContents) ); body.withPolicyIds(listbodyPolicyIds); body.withName("test2"); body.withPriority(50); body.withAction(actionbody); body.withConditions(listbodyConditions); body.withDescription(""); body.withTime(false); request.withBody(body); try { BatchCreateCustomRuleResponse response = client.batchCreateCustomRule(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] 选中多个策略为这些策略批量添加精准防护规则 ``` # 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("")) \ .build() try: request = BatchCreateCustomRuleRequest() listPolicyIdsbody = [ "policy_id" ] actionbody = CustomAction( category="block" ) listContentsConditions = [ "demo" ] listConditionsbody = [ CustomConditions( category="header", index="demo", logic_operation="contain", contents=listContentsConditions ) ] request.body = BatchCreateCustomRuleRequestBody( policy_ids=listPolicyIdsbody, name="test2", priority=50, action=actionbody, conditions=listConditionsbody, description="", time=False ) response = client.batch_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) ``` - [Go] 选中多个策略为这些策略批量添加精准防护规则 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) request := &model.BatchCreateCustomRuleRequest{} var listPolicyIdsbody = []string{ "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, }, } descriptionBatchCreateCustomRuleRequestBody:= "" request.Body = &model.BatchCreateCustomRuleRequestBody{ PolicyIds: listPolicyIdsbody, Name: "test2", Priority: int32(50), Action: actionbody, Conditions: listConditionsbody, Description: &descriptionBatchCreateCustomRuleRequestBody, Time: false, } response, err := client.BatchCreateCustomRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WAF/sdk?api=BatchCreateCustomRule)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | **参数解释：** OK **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 400 | **参数解释：** 请求失败 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 401 | **参数解释：** token权限不足 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 500 | **参数解释：** 服务器内部错误 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。