选中多个策略批量添加隐私屏蔽防护防护规则 - BatchCreatePrivacyRule
功能介绍
选中多个策略为这些策略批量添加隐私屏蔽防护规则
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/rule/privacy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制： 不涉及 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policyids |
否 |
String |
参数解释： 策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取，多个策略之间用“,”隔开 约束限制： 不涉及 取值范围： 策略id只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及 |
|
enterprise_project_id |
否 |
String |
参数解释： 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。 约束限制： 不涉及 取值范围：
默认取值： 0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
Content-Type |
是 |
String |
参数解释： 内容类型 约束限制： 不涉及 取值范围： 不涉及 默认取值： application/json;charset=utf8 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
url |
是 |
String |
隐私屏蔽规则防护的url，需要填写标准的url格式，例如/admin/xxx或者/admin/,以""（星号）结尾代表路径前缀 |
|
category |
是 |
String |
屏蔽字段
|
|
index |
是 |
String |
屏蔽字段名，根据“屏蔽字段”设置字段名，被屏蔽的字段将不会出现在日志中。屏蔽字段名的长度不能超过2048字节，且只能由数字、字母、下划线和中划线组成。 |
|
description |
否 |
String |
规则描述，可选参数，设置该规则的备注信息。 |
|
policy_ids |
是 |
Array of strings |
添加规则的策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取，多个策略之间用“,”隔开 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
规则id |
|
policyid |
String |
策略id |
|
timestamp |
Long |
创建规则的时间，格式为13位毫秒时间戳 |
|
status |
Integer |
规则状态，0：关闭，1：开启 |
|
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鉴权错误时才会返回此字段。 |
请求示例
选中多个策略为这些策略批量添加隐私屏蔽防护规则
POST https://{endpoint}/v1/{project_id}/waf/rule/privacy?enterprise_project_id=0
{
"url" : "/dddd",
"category" : "params",
"index" : "dd",
"description" : "",
"policy_ids" : [ "policyid" ]
}
响应示例
状态码：200
参数解释：
OK
约束限制：
不涉及
取值范围：
不涉及
默认取值：
不涉及
{
"id" : "id",
"policyid" : "policyid",
"timestamp" : 1761124539995,
"description" : "",
"status" : 1,
"url" : "/dddd",
"category" : "params",
"index" : "dd"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
参数解释： OK 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
400 |
参数解释： 请求失败 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
401 |
参数解释： token权限不足 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
500 |
参数解释： 服务器内部错误 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
错误码
请参见错误码。
