【产品技术】Web应用服务规则解析篇:误报屏蔽
查询
URI格式
GET /v1/{project_id}/waf/policy/{policy_id}/ignore?path={path}&offset={offset}&limit={limit}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
path |
否 |
String |
误报路径。 |
offset |
否 |
Long |
指定返回的页数,取值范围为:[0, 65535],默认值为0。 |
limit |
否 |
Long |
指定查询返回每页记录的最大条数,取值范围为:(0, 50],默认值为10。 |
请求消息
请求参数
无
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
total |
Integer |
Policy的总数量。 |
items |
表3 |
误报屏蔽规则对象列表。 |
items |
||
名称 |
参数类型 |
说明 |
id |
String |
误报屏蔽规则ID。 |
policy_id |
String |
策略ID。 |
path |
String |
误报路径,完整的URL链接,不包含域名。 |
event_id |
String |
防护事件的ID。 |
event_type |
String |
事件类型。 |
rule |
String |
屏蔽的规则ID,由6位数字组成,不能为空。 |
timestamp |
Long |
创建误报屏蔽规则的时间。 |
举栗
以查询误报屏蔽规则列表,返回记录条数为“2”为例。
响应样例
{
"total": 2,
"items": [{
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"event_id": "02d3ac3cd99f440daf8d38e03cf0e2a6",
"event_type": "xss",
"rule": "100001",
"timestamp": 1499817600,
"path": "/a"
}, {
"id": "44d887434169475794b2717438f7fa78",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"event_id": "f8c74b656a9d4d329dbcefe0969cc427",
"event_type": "sqli",
"rule": "100002",
"timestamp": 1499817600,
"path": "/a"
}
]
}
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
创建
URI格式
POST /v1/{project_id}/waf/policy/{policy_id}/ignore
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
请求消息
请求参数
请求参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
path |
是 |
String |
误报路径,完整的URL链接,不包含域名。 |
event_id |
是 |
String |
防护事件的ID。 “防护事件”列表中事件类型为非“自定义规则”的误报攻击事件所对应的事件ID。可单击该攻击事件所在行的“误报处理”获取事件ID。 |
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
误报屏蔽规则ID。 |
policy_id |
String |
策略ID。 |
path |
String |
误报路径,完整的URL链接,不包含域名。 |
event_id |
String |
防护事件的ID。 |
event_type |
String |
事件类型。 |
timestamp |
Long |
创建误报屏蔽规则的时间。 |
rule |
String |
屏蔽的规则ID,由6位数字组成,不能为空。 |
举栗
以创建一条误报屏蔽规则“100001”为例。
请求样例
{
"path": "/a",
"event_id": "3737fb122f2140f39292f597ad3b7e9a"
}
响应样例
{
"id": "6cdc116040d444f6b3e1bf1dd629f1d0",
"policy_id": "44d887434169475794b2717438f7fa78",
"path": "/a",
"event_id": "3737fb122f2140f39292f597ad3b7e9a",
"event_type": "xss",
"rule": "100001",
"timestamp": 1499817600
}
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
删除
URI格式
DELETE /v1/{project_id}/waf/policy/{policy_id}/ignore/{ignore_rule_id}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
ignore_rule_id |
是 |
String |
误报屏蔽规则的ID。 |
请求消息
请求参数
无
响应消息
响应参数
无
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
204 |
No Content |
服务器成功处理了请求,没有返回任何内容。 |
查询(详细信息)
URI格式
GET /v1/{project_id}/waf/policy/{policy_id}/ignore/{ignore_id}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
ignore_id |
是 |
String |
误报屏蔽规则的ID。 |
请求消息
请求参数
无
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
误报屏蔽规则ID。 |
policy_id |
String |
策略ID。 |
path |
String |
误报路径,完整的URL链接,不包含域名。 |
event_id |
String |
防护事件的ID。 |
event_type |
String |
事件类型。 |
timestamp |
Long |
创建误报屏蔽规则的时间。 |
rule |
String |
屏蔽的规则ID,由6位数字组成,不能为空。 |
举栗
响应样例
{
"id": "6cdc116040d444f6b3e1bf1dd629f1d0",
"policy_id": "44d887434169475794b2717438f7fa78",
"path": "/a",
"event_id": "3737fb122f2140f39292f597ad3b7e9a",
"event_type": "xss",
"rule": "100001",
"timestamp": 1499817600
}
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
更新
URI格式
PUT /v1/{project_id}/waf/policy/{policy_id}/ignore/{ignore_id}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
ignore_id |
是 |
String |
误报屏蔽规则的ID。 |
请求消息
请求参数
请求参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
path |
否 |
String |
误报路径,完整的URL链接,不包含域名。 |
event_id |
否 |
String |
防护事件的ID。 “防护事件”列表中事件类型为非“自定义规则”的误报攻击事件所对应的ID。可单击该攻击事件所在行的“误报处理”获取事件ID。 |
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
误报屏蔽规则ID。 |
policy_id |
String |
策略ID。 |
path |
String |
误报路径,完整的URL链接,不包含域名。 |
event_id |
String |
防护事件的ID。 |
event_type |
String |
事件类型。 |
timestamp |
Long |
创建误报屏蔽规则的时间。 |
rule |
String |
屏蔽的规则ID,由6位数字组成,不能为空。 |
举栗
请求样例
{
"path": "/a",
"event_id": "3737fb122f2140f39292f597ad3b7e9a"
}
响应样例
{
"id": "6cdc116040d444f6b3e1bf1dd629f1d0",
"policy_id": "44d887434169475794b2717438f7fa78",
"path": "/a",
"event_id": "3737fb122f2140f39292f597ad3b7e9a",
"event_type": "xss",
"rule": "100001",
"timestamp": 1499817600
}
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
- 点赞
- 收藏
- 关注作者
评论(0)