文档首页/ Web应用防火墙 WAF/ API参考（阿布扎比区域）/ API/ 策略规则管理/ 创建隐私屏蔽防护规则
更新时间：2023-01-16 GMT+08:00
查看PDF
分享

创建隐私屏蔽防护规则

功能介绍

创建隐私屏蔽防护规则

URI

POST /v1/{project_id}/waf/policy/{policy_id}/privacy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID

policy_id

是

String

防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

请求参数

表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/,以""（星号）结尾代表路径前缀

category

是

String

屏蔽字段

  • Params：请求参数

  • Cookie：根据Cookie区分的Web访问者

  • Header：自定义HTTP首部

  • Form：表单参数

枚举值：

  • params

  • cookie

  • header

  • form

index

是

String

屏蔽字段名，根据“屏蔽字段”设置字段名，被屏蔽的字段将不会出现在日志中。屏蔽字段名的长度不能超过2048字节，且只能由数字、字母、下划线和中划线组成。

description

否

String

规则描述，可选参数，设置该规则的备注信息。

响应参数

状态码： 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：表单参数

枚举值：

  • params

  • cookie

  • header

  • form

index

String

屏蔽字段名，根据“屏蔽字段”设置字段名，被屏蔽的字段将不会出现在日志中。

description

String

规则描述，可选参数，设置该规则的备注信息。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/privacy?enterprise_project_id=0

{
  "url" : "/demo",
  "category" : "cookie",
  "index" : "demo",
  "description" : "demo"
}

响应示例

状态码： 200

请求成功

{
  "id" : "97e4d35f375f4736a21cccfad77613eb",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "timestamp" : 1650533191385,
  "description" : "demo",
  "status" : 1,
  "url" : "/demo",
  "category" : "cookie",
  "index" : "demo"
}

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 策略规则管理