【产品技术】网页防篡改规则的查询、创建、删除和刷新
查询
URI格式
GET /v1/{project_id}/waf/policy/{policy_id}/antitamper?offset={offset}&&limit={limit}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
offset |
否 |
Long |
指定返回的页数，取值范围为：[0, 65535]，默认值为0。 |
limit |
否 |
Long |
指定查询返回每页记录的最大条数，取值范围为：(0, 50]，默认值为10。 |
请求消息
请求参数
无
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
total |
Integer |
该策略下防篡改规则的总条数。 |
items |
表3 |
网页防篡改对象列表。 |
items |
||
名称 |
参数类型 |
说明 |
id |
String |
网页防篡改规则ID。 |
policy_id |
String |
网页防篡改规则的策略ID。 |
hostname |
String |
防护域名。 |
path |
String |
防篡改的URL链接，不包含域名。 |
timestamp |
Long |
缓存的更新时间。 |
举栗
以查询网页防篡改规则列表，返回记录条数为“2”为例。
响应样例
{
"total": 2,
"items": [{
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"hostname": "www.aaa.com",
"path": "/a",
"timestamp": 1499817600
}, {
"id": "44d887434169475794b2717438f7fa78",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"hostname": "www.bbb.com",
"path": "/b"，
"timestamp": 1499817600
}
]
}
API返回的正常状态码：
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
异常状态码，请参见状态码。
创建
URI格式
POST /v1/{project_id}/waf/policy/{policy_id}/antitamper
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
防护策略ID。 |
请求消息
请求参数
请求参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
hostname |
是 |
String |
防护域名。 |
path |
是 |
String |
防篡改的URL，不包含域名。 |
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
网页防篡改规则ID。 |
policy_id |
String |
防护策略ID。 |
hostname |
String |
防护域名。 |
path |
String |
防篡改的URL链接，不包含域名。 |
timestamp |
Long |
缓存的更新时间。 |
举栗
域名“www.abc.com”创建网页防篡改规则：
请求样例
{
"hostname": "www.abc.com",
"path": "/a"
}
响应样例
{
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"hostname": "www.abc.com",
"path": "/a",
"timestamp": 1499817600
}
API返回的正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
异常状态码，请参见状态码。
删除
URI格式
DELETE /v1/{project_id}/waf/policy/{policy_id}/antitamper/{antitamper_rule_id}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
防护策略ID。 |
antitamper_rule_id |
是 |
String |
网页防篡改规则的ID。 |
请求消息
请求参数
无
响应消息
响应参数
无
状态码
API返回的正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
204 |
No Content |
服务器成功处理了请求，没有返回任何内容。 |
查询
URI格式
GET /v1/{project_id}/waf/policy/{policy_id}/antitamper/{antitamper_rule_id}
参数说明
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
antitamper_rule_id |
是 |
String |
网页防篡改规则的ID。 |
请求消息
请求参数
无
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
网页防篡改规则ID。 |
policy_id |
String |
策略ID。 |
hostname |
String |
防护域名。 |
path |
String |
防篡改的URL链接，不包含域名。 |
timestamp |
Long |
缓存的更新时间。 |
1举栗子
查询id“3a9b5c0f96784ec8abd8ba61a98064ef”的网页防篡改规则。
响应样例
{
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"hostname": "www.aaa.com",
"path": "/a",
"timestamp": 1499817600
}
状态码
API返回的正常状态码。
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
异常状态码，请参见状态码。
刷新
若防篡改的网页内容有修改，需要WAF重新缓存网页内容，可刷新某个网页防篡改规则中的缓存
URI格式 POST /v1/{project_id}/waf/policy/{policy_id}/antitamper/{antitamper_rule_id}/cache
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
antitamper_rule_id |
是 |
String |
网页防篡改规则的ID。 |
请求消息
请求参数
无
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
网页防篡改规则ID。 |
policy_id |
String |
策略ID。 |
hostname |
String |
防护域名。 |
path |
String |
防篡改的URL链接，不包含域名。 |
timestamp |
Long |
缓存的更新时间。 |
举栗子
如下以刷新缓存为例。
响应样例
{
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"hostname": "www.aaa.com",
"path": "/a",
"timestamp": 1499817600
}
状态码
API返回的正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
- 点赞
- 收藏
- 关注作者
评论（0）