更新时间:2024-07-25 GMT+08:00

创建隐私屏蔽规则

功能介绍

创建隐私屏蔽规则

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户操作的项目id

policy_id

String

防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

auth token

Content-Type

String

内容类型

缺省值:application/json;charset=utf8

表3 请求Body参数

参数

是否必选

参数类型

描述

url

String

隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/,以""号结尾代表路径前缀

category

String

屏蔽字段

枚举值:

  • params

  • cookie

  • header

  • form

index

String

屏蔽字段名

description

String

规则描述

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

规则id

policyid

String

策略id

url

String

隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/,以""号结尾代表路径前缀

category

String

屏蔽字段

枚举值:

  • params

  • cookie

  • header

  • form

index

String

屏蔽字段名

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

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

{
  "url" : "/login",
  "category" : "params",
  "index" : "password",
  "description" : ""
}

响应示例

状态码: 200

OK

{
  "category" : "params",
  "description" : "",
  "id" : "41a5674e03a1470a90ac4761ec4657b4",
  "index" : "password",
  "policyid" : "1f016cde588646aca3fb19f277c44d03",
  "status" : 1,
  "timestamp" : 1656504425319,
  "url" : "/login"
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码