# 批量更新隐私屏蔽规则 - BatchUpdatePrivacyRules #### 功能介绍 批量更新隐私屏蔽规则 #### 调用方法 请参见[如何调用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/batch-update 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，对应控制台用户名-\>我的凭证-\>项目列表-\>项目ID。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Content-Type | 是 | String | **参数解释：** 内容类型 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json;charset=utf8 | 表3请求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_rule_ids | 是 | Array of [policy_rule_ids] objects | **参数解释：** 策略和规则id数组，关联防护策略与对应的规则集合 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表4policy_rule_ids | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policy_id | 是 | String | **参数解释：** 策略id，唯一标识一条防护策略.策略id从"查询防护策略列表"(ListPolicy)接口获取 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | rule_ids | 是 | Array of strings | **参数解释：** 规则id数组，包含当前防护策略下的单个隐私屏蔽规则id，您可以通过调用查询隐私屏蔽规则列表（ListPrivacyRule）获取规则id **约束限制：** 单条规则ID **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy_rule_ids | Array of [policy_rule_ids] objects | **参数解释：** 策略和规则id数组，返回防护策略与对应规则的ID关联关系 **取值范围：** 不涉及 | 表6policy_rule_ids | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy_id | String | **参数解释：** 策略id，唯一标识一条防护策略 **取值范围：** 不涉及 | | rule_ids | Array of strings | **参数解释：** 规则id数组，返回当前防护策略下的多条规则ID **取值范围：** 不涉及 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表8IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表10IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表12IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | #### 请求示例 批量更新隐私屏蔽 ``` POST https://{endpoint}/v1/{project_id}/waf/rule/privacy/batch-update?enterprise_project_id=0 { "url" : "/admin", "category" : "params", "index" : "test", "description" : "string", "policy_rule_ids" : [ { "policy_id" : "4a34899ab17a4811a6da57742f69135a", "rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ] } ] } ``` #### 响应示例 **状态码：200** ``` { "policy_rule_ids" : [ { "rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ], "policy_id" : "4a34899ab17a4811a6da57742f69135a" } ] } ``` #### 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 BatchUpdatePrivacyRulesSolution { 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(); BatchUpdatePrivacyRulesRequest request = new BatchUpdatePrivacyRulesRequest(); BatchUpdatePrivacyRuleRequestBody body = new BatchUpdatePrivacyRuleRequestBody(); List listPolicyRuleIdsRuleIds = new ArrayList<>(); listPolicyRuleIdsRuleIds.add("ed37d85a925d469bb01986d06291d15f"); List listbodyPolicyRuleIds = new ArrayList<>(); listbodyPolicyRuleIds.add( new BatchUpdatePrivacyRuleRequestBodyPolicyRuleIds() .withPolicyId("4a34899ab17a4811a6da57742f69135a") .withRuleIds(listPolicyRuleIdsRuleIds) ); body.withPolicyRuleIds(listbodyPolicyRuleIds); body.withDescription("string"); body.withIndex("test"); body.withCategory(BatchUpdatePrivacyRuleRequestBody.BatchUpdatePrivacyRuleRequestBody.fromValue("params")); body.withUrl("/admin"); request.withBody(body); try { BatchUpdatePrivacyRulesResponse response = client.batchUpdatePrivacyRules(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 = BatchUpdatePrivacyRulesRequest() listRuleIdsPolicyRuleIds = [ "ed37d85a925d469bb01986d06291d15f" ] listPolicyRuleIdsbody = [ BatchUpdatePrivacyRuleRequestBodyPolicyRuleIds( policy_id="4a34899ab17a4811a6da57742f69135a", rule_ids=listRuleIdsPolicyRuleIds ) ] request.body = BatchUpdatePrivacyRuleRequestBody( policy_rule_ids=listPolicyRuleIdsbody, description="string", index="test", category="params", url="/admin" ) response = client.batch_update_privacy_rules(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.BatchUpdatePrivacyRulesRequest{} var listRuleIdsPolicyRuleIds = []string{ "ed37d85a925d469bb01986d06291d15f", } var listPolicyRuleIdsbody = []model.BatchUpdatePrivacyRuleRequestBodyPolicyRuleIds{ { PolicyId: "4a34899ab17a4811a6da57742f69135a", RuleIds: listRuleIdsPolicyRuleIds, }, } descriptionBatchUpdatePrivacyRuleRequestBody:= "string" request.Body = &model.BatchUpdatePrivacyRuleRequestBody{ PolicyRuleIds: listPolicyRuleIdsbody, Description: &descriptionBatchUpdatePrivacyRuleRequestBody, Index: "test", Category: model.GetBatchUpdatePrivacyRuleRequestBodyCategoryEnum().PARAMS, Url: "/admin", } response, err := client.BatchUpdatePrivacyRules(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=BatchUpdatePrivacyRules)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | **参数解释：** OK **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 400 | **参数解释：** 请求失败 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 401 | **参数解释：** token权限不足 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 500 | **参数解释：** 服务器内部错误 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。