文档首页/ Web应用防火墙 WAF/ API参考/ API/ 策略规则管理/ 批量更新防敏感信息泄露规则 - BatchUpdateAntileakageRule
更新时间:2026-08-13 GMT+08:00
分享

批量更新防敏感信息泄露规则 - BatchUpdateAntileakageRule

功能介绍

批量更新防敏感信息泄露规则

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/waf/rule/antileakage/batch-update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

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_rule_ids

Array of policy_rule_ids objects

参数解释:

策略和规则id数组,关联防护策略与对应的规则集合

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 action

参数

是否必选

参数类型

描述

category

String

操作类型。

  • block:过滤。

  • log:仅记录

表6 policy_rule_ids

参数

是否必选

参数类型

描述

policy_id

String

参数解释:

策略id,唯一标识一条防护策略.策略id从"查询防护策略列表"(ListPolicy)接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

rule_ids

Array of strings

参数解释:

规则id数组,包含当前防护策略下的单个规则ID,通过ListAntileakageRules接口查询防泄漏规则ID

约束限制:

单条规则ID

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

policy_rule_ids

Array of policy_rule_ids objects

参数解释:

策略和规则id数组,返回防护策略与对应规则的ID关联关系

取值范围:

不涉及

表8 policy_rule_ids

参数

参数类型

描述

policy_id

String

参数解释:

策略id,唯一标识一条防护策略

取值范围:

不涉及

rule_ids

Array of strings

参数解释:

规则id数组,返回当前防护策略下的多条规则ID

取值范围:

不涉及

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表14 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

批量更新防敏感信息泄露规则

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

{
  "url" : "/attack",
  "category" : "sensitive",
  "contents" : [ "id_card" ],
  "policy_rule_ids" : [ {
    "rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
    "policy_id" : "4a34899ab17a4811a6da57742f69135a"
  } ]
}

响应示例

状态码:200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

{
  "policy_rule_ids" : [ {
    "rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
    "policy_id" : "4a34899ab17a4811a6da57742f69135a"
  } ]
}

状态码

状态码

描述

200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档