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

参数解释:

功能介绍

参数解释:

根据Id查询Web防护规则

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/waf/web-protection-rules/{rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

用户项目Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

rule_id

String

参数解释:

防护规则ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

X-Language

String

参数解释:

语言

约束限制:

不涉及

取值范围:

不涉及

默认取值:

zh-cn

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释:

规则id,唯一标识一条Web防护规则

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cve_number

String

参数解释:

关联的CVE编号,对应规则防护的漏洞的CVE标准编号(如CVE-2021-41773)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

risk_level

Integer

参数解释:

危险等级

  • 1:高危

  • 2:中危

  • 3:低危

取值范围:

  • 1

  • 2

  • 3

application_type

String

参数解释:

应用类型,指定规则适用的应用场景(如Web应用、API接口)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

protection_type

String

参数解释:

防护类型,区分规则的防护类别(如SQL注入防护、XSS防护、命令注入防护)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

描述,对Web防护规则的功能、适用场景等补充说明

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

create_time

Long

参数解释:

规则上线时间,Web防护规则正式启用的时间(时间戳格式)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表5 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表7 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表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

下游服务报错信息

请求示例

响应示例

状态码

状态码

描述

200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档