更新时间:2025-09-19 GMT+08:00
分享

参数解释:

功能介绍

参数解释:

批量更新BotM规则防护动作

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/waf/policy/{policy_id}/bot-manager/rule/batch-update-action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

projectId

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

policy_id

String

参数解释:

policyId

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

rule_ids

Array of strings

参数解释:

批量更新的规则ID,包含需要修改防护动作的多条BotM规则ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

defense_action

Integer

参数解释:

批量更新的防护动作对应的数字,101-拦截、102-放行、103-观察、104-验证码、201-重定向、202-返回自定义页面、301-拉黑IP

约束限制:

不涉及

取值范围:

  • 101:拦截

  • 102:放行

  • 103:观察

  • 104:验证码

  • 201:重定向

  • 202:返回自定义页面

  • 301:拉黑IP

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

Boolean

参数解释:

结果

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表6 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表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

下游服务报错信息

请求示例

{
  "rule_ids" : [ 0 ],
  "defense_action" : 101
}

响应示例

状态码:200

参数解释:

请求成功

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

{
  "result" : true
}

状态码

状态码

描述

200

参数解释:

请求成功

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档