文档首页/ Web应用防火墙 WAF/ API参考/ API/ 策略规则管理/ 选中多个策略批量添加防敏感信息泄漏规则 - BatchCreateAntileakageRule
更新时间:2025-11-21 GMT+08:00
分享

选中多个策略批量添加防敏感信息泄漏规则 - BatchCreateAntileakageRule

功能介绍

选中多个策略为这些策略批量添加防敏感信息泄漏规则

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/waf/rule/antileakage

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

policyids

String

参数解释:

域名id。

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及

enterprise_project_id

String

参数解释:

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。

约束限制:

不涉及

取值范围:

  • 0:代表default企业项目

  • all_granted_eps:代表所有企业项目

  • 其它企业项目ID:长度为36个字符

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

表4 请求Body参数

参数

是否必选

参数类型

描述

url

String

规则应用的url

category

String

类别(响应码:code,敏感信息:sensitive)

contents

Array of strings

规则内容(http状态码:400 、401、402 、 403 、404 、 405 、500 、501 、502 、503、 504 、507;手机:phone、身份证号:id_card、邮箱:email)

action

action object

规则命中后操作对象

description

String

规则描述

policy_ids

Array of strings

添加规则的策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取,多个策略之间用“,”隔开

表5 action

参数

是否必选

参数类型

描述

category

String

操作类型。

  • “block”:过滤。

  • “log”:仅记录

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

id

String

规则id

policyid

String

策略id

url

String

规则应用的url

category

String

类别(响应码:code,敏感信息:sensitive)

contents

Array of strings

内容

timestamp

Long

创建规则时间戳

description

String

描述

status

Integer

规则状态,0:关闭,1:开启

action

action object

规则命中后操作对象

表7 action

参数

参数类型

描述

category

String

操作类型。

  • “block”:过滤。

  • “log”:仅记录

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表9 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表13 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

选中多个策略为这些策略批量添加防敏感信息泄漏规则

POST https://{endpoint}/v1/{project_id}/waf/rule/antileakage?enterprise_project_id=0

{
  "url" : "/ddd",
  "category" : "sensitive",
  "contents" : [ "id_card" ],
  "description" : "dddd",
  "action" : {
    "category" : "block"
  },
  "policy_ids" : [ "1f973acecb6c4be9af36e18716cb0e41" ]
}

响应示例

状态码:200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

{
  "policyid" : "1f973acecb6c4be9af36e18716cb0e41",
  "timestamp" : 1761120154201,
  "description" : "dddd",
  "status" : 1,
  "url" : "/ddd",
  "category" : "sensitive",
  "contents" : [ "id_card" ],
  "action" : {
    "category" : "block"
  }
}

状态码

状态码

描述

200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档