更新隐私屏蔽防护规则 - UpdatePrivacyRule
功能介绍
更新隐私屏蔽防护规则
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
waf:privacyRule:put
Write
policy *
g:EnterpriseProjectId
-
-
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/privacy/{rule_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
policy_id | 是 | String | 参数解释: 策略id,唯一标识一条防护策略,可从"查询防护策略列表"(ListPolicy)接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
rule_id | 是 | String | 参数解释: 隐私屏蔽规则id,您可以通过调用查询隐私屏蔽规则列表(ListPrivacyRule)获取规则id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
Content-Type | 是 | String | 参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
url | 是 | String | 参数解释: 隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/*,以"*"结尾的路径前缀表示一个通配符,用于匹配该路径前缀下的所有子路径。例如,如果你有一个路径前缀/admin/,那么它将匹配所有以/admin/开头的URL路径。将url的参数设置为/admin/*,所有以/admin/开头的URL路径都会被该规则所覆盖 约束限制: 标准URL字符串或者URL前缀匹配字符串 取值范围: 不涉及 默认取值: 不涉及 |
category | 是 | String | 参数解释: 屏蔽字段 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
index | 是 | String | 参数解释: 屏蔽字段名,被屏蔽的字段将不会出现在日志中 约束限制: 长度不能超过2048字节 取值范围: 不涉及 默认取值: 不涉及 |
description | 否 | String | 规则描述,可选参数,设置该规则的备注信息。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 规则id |
policyid | String | 策略id |
timestamp | Long | 创建规则的时间,格式为13位毫秒时间戳 |
status | Integer | 参数解释: 规则状态标识,用于指定规则的启用或关闭状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
url | String | 隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/*,以"*"号结尾代表路径前缀 |
category | String | 参数解释: 屏蔽字段 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
index | String | 屏蔽字段名,根据“屏蔽字段”设置字段名,被屏蔽的字段将不会出现在日志中。 |
description | String | 规则描述,可选参数,设置该规则的备注信息。 |
状态码: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,规则id为rule_id的防护策略下创建隐私屏蔽防护规则列表,隐私屏蔽规则防护的ur为“/demo”,屏蔽字段为Cookie,屏蔽字段名为“demo1",规则描述为”demo“
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/privacy/{rule_id}?enterprise_project_id=0
{
"url" : "/demo",
"category" : "cookie",
"index" : "demo1",
"description" : "demo"
} 响应示例
状态码:200
请求成功
{
"id" : "97e4d35f375f4736a21cccfad77613eb",
"policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
"description" : "demo",
"url" : "/demo",
"category" : "cookie",
"index" : "demo1"
} SDK代码示例
SDK代码示例如下。
更新项目id为project_id,防护策略id为policy_id,规则id为rule_id的防护策略下创建隐私屏蔽防护规则列表,隐私屏蔽规则防护的ur为“/demo”,屏蔽字段为Cookie,屏蔽字段名为“demo1",规则描述为”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 | 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.*; public class UpdatePrivacyRuleSolution { 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(); UpdatePrivacyRuleRequest request = new UpdatePrivacyRuleRequest(); request.withPolicyId("{policy_id}"); request.withRuleId("{rule_id}"); UpdatePrivacyRuleRequestBody body = new UpdatePrivacyRuleRequestBody(); body.withDescription("demo"); body.withIndex("demo1"); body.withCategory(UpdatePrivacyRuleRequestBody.CategoryEnum.fromValue("cookie")); body.withUrl("/demo"); request.withBody(body); try { UpdatePrivacyRuleResponse response = client.updatePrivacyRule(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的防护策略下创建隐私屏蔽防护规则列表,隐私屏蔽规则防护的ur为“/demo”,屏蔽字段为Cookie,屏蔽字段名为“demo1",规则描述为”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 | # 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 = UpdatePrivacyRuleRequest() request.policy_id = "{policy_id}" request.rule_id = "{rule_id}" request.body = UpdatePrivacyRuleRequestBody( description="demo", index="demo1", category="cookie", url="/demo" ) response = client.update_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) |
更新项目id为project_id,防护策略id为policy_id,规则id为rule_id的防护策略下创建隐私屏蔽防护规则列表,隐私屏蔽规则防护的ur为“/demo”,屏蔽字段为Cookie,屏蔽字段名为“demo1",规则描述为”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 | 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.UpdatePrivacyRuleRequest{} request.PolicyId = "{policy_id}" request.RuleId = "{rule_id}" descriptionUpdatePrivacyRuleRequestBody:= "demo" request.Body = &model.UpdatePrivacyRuleRequestBody{ Description: &descriptionUpdatePrivacyRuleRequestBody, Index: "demo1", Category: model.GetUpdatePrivacyRuleRequestBodyCategoryEnum().COOKIE, Url: "/demo", } response, err := client.UpdatePrivacyRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 | 描述 |
|---|---|
200 | 请求成功 |
400 | 请求失败 |
401 | token权限不足 |
500 | 服务器内部错误 |
错误码
请参见错误码。

