# 选中多个策略批量添加隐私屏蔽防护防护规则 - BatchCreatePrivacyRule #### 功能介绍 选中多个策略为这些策略批量添加隐私屏蔽防护规则 #### 调用方法 请参见[如何调用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/privacy 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，对应控制台用户名-\>我的凭证-\>项目列表-\>项目ID。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policyids | 否 | String | **参数解释：** 策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取，多个策略之间用","隔开 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | enterprise_project_id | 否 | String | **参数解释：** 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。 **约束限制：** 不涉及 **取值范围：** - 0：代表default企业项目 - all_granted_eps：代表所有企业项目 - 其它企业项目ID：长度为36个字符 **默认取值：** 0 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Content-Type | 是 | String | **参数解释：** 内容类型 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json;charset=utf8 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | url | 是 | String | **参数解释：** 隐私屏蔽规则防护的url，需要填写标准的url格式，例如/admin/xxx或者/admin/\*，以"\*"结尾的路径前缀表示一个通配符，用于匹配该路径前缀下的所有子路径。例如，如果你有一个路径前缀/admin/，那么它将匹配所有以/admin/开头的URL路径。将url的参数设置为/admin/\*，所有以/admin/开头的URL路径都会被该规则所覆盖 **约束限制：** 标准URL字符串或者URL前缀匹配字符串 **取值范围：** 不涉及 **默认取值：** 不涉及 | | category | 是 | String | **参数解释：** 屏蔽字段 **约束限制：** 不涉及 **取值范围：** - params: 请求参数 - cookie: 根据Cookie区分的Web访问者 - header: 自定义HTTP首部 - form: 表单参数 **默认取值：** 不涉及 | | index | 是 | String | **参数解释：** 屏蔽字段名，被屏蔽的字段将不会出现在日志中 **约束限制：** 长度不能超过2048字节 **取值范围：** 不涉及 **默认取值：** 不涉及 | | description | 否 | String | 规则描述，可选参数，设置该规则的备注信息。 | | policy_ids | 是 | Array of strings | **参数解释：** 添加规则的策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取，多个策略之间用","隔开 **约束限制：** 不能为空 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 规则id | | policyid | String | 策略id | | timestamp | Long | 创建规则的时间，格式为13位毫秒时间戳 | | status | Integer | **参数解释：** 规则状态标识，用于指定规则的启用或关闭状态 **取值范围：** - 0：关闭 - 1：开启 | | url | String | 隐私屏蔽规则防护的url，需要填写标准的url格式，例如/admin/xxx或者/admin/\*,以"\*"号结尾代表路径前缀 | | category | String | **参数解释：** 屏蔽字段 **取值范围：** - params: 请求参数 - cookie: 根据Cookie区分的Web访问者 - header: 自定义HTTP首部 - form: 表单参数 | | index | String | 屏蔽字段名，根据"屏蔽字段"设置字段名，被屏蔽的字段将不会出现在日志中。 | | description | String | 规则描述，可选参数，设置该规则的备注信息。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表7IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表9IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：500** 表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 | 下游服务报错信息 | #### 请求示例 选中多个策略为这些策略批量添加隐私屏蔽防护规则 ``` POST https://{endpoint}/v1/{project_id}/waf/rule/privacy?enterprise_project_id=0 { "url" : "/dddd", "category" : "params", "index" : "dd", "description" : "", "policy_ids" : [ "policyid1", "policyId2" ] } ``` #### 响应示例 **状态码：200** ``` { "id" : "id", "policyid" : "policyid1", "timestamp" : 1761124539995, "description" : "", "status" : 1, "url" : "/dddd", "category" : "params", "index" : "dd" } ``` #### 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 BatchCreatePrivacyRuleSolution { 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(); BatchCreatePrivacyRuleRequest request = new BatchCreatePrivacyRuleRequest(); BatchCreatePrivacyRuleRequestBody body = new BatchCreatePrivacyRuleRequestBody(); List listbodyPolicyIds = new ArrayList<>(); listbodyPolicyIds.add("policyid1"); listbodyPolicyIds.add("policyId2"); body.withPolicyIds(listbodyPolicyIds); body.withDescription(""); body.withIndex("dd"); body.withCategory(BatchCreatePrivacyRuleRequestBody.BatchCreatePrivacyRuleRequestBody.fromValue("params")); body.withUrl("/dddd"); request.withBody(body); try { BatchCreatePrivacyRuleResponse response = client.batchCreatePrivacyRule(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 = BatchCreatePrivacyRuleRequest() listPolicyIdsbody = [ "policyid1", "policyId2" ] request.body = BatchCreatePrivacyRuleRequestBody( policy_ids=listPolicyIdsbody, description="", index="dd", category="params", url="/dddd" ) response = client.batch_create_privacy_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.BatchCreatePrivacyRuleRequest{} var listPolicyIdsbody = []string{ "policyid1", "policyId2", } descriptionBatchCreatePrivacyRuleRequestBody:= "" request.Body = &model.BatchCreatePrivacyRuleRequestBody{ PolicyIds: listPolicyIdsbody, Description: &descriptionBatchCreatePrivacyRuleRequestBody, Index: "dd", Category: model.GetBatchCreatePrivacyRuleRequestBodyCategoryEnum().PARAMS, Url: "/dddd", } response, err := client.BatchCreatePrivacyRule(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=BatchCreatePrivacyRule)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | **参数解释：** OK **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 400 | **参数解释：** 请求失败 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 401 | **参数解释：** token权限不足 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 500 | **参数解释：** 服务器内部错误 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。