【产品技术】Web应用服务规则解析篇:隐私屏蔽
查询
URI格式
GET /v1/{project_id}/waf/policy/{policy_id}/privacy?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。 |
path |
String |
隐私屏蔽规则应用的URL(默认完全匹配)。 |
category |
String |
屏蔽字段,取值范围是:params,header。 |
index |
String |
屏蔽字段名。 |
timestamp |
Long |
创建隐私屏蔽规则的时间。 |
举栗
以查询隐私屏蔽规则列表,返回记录条数为“2”为例。
响应样例
{
"total": 2,
"items": [{
"id": "e1c0e55865544d1f8c95cf71df108c6b",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"path": "/login",
"category": "params",
"index": "password",
"timestamp": 123243414132
}, {
"id": "d947d31c3e794b70a25e5e2057997f8e",
"policy_id": "yuc0e55865544d1f8c95cf71df108c89",
"path": "/register",
"category": "header",
"index": "x-auth-token",
"timestamp": 1343243243123
}
]
}
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
创建
URI格式
POST /v1/{project_id}/waf/policy/{policy_id}/privacy
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
请求消息
请求参数
请求参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
path |
是 |
String |
隐私屏蔽规则应用的URL(默认完全匹配)。 |
category |
是 |
String |
屏蔽类别。固定值为params,header。 |
index |
是 |
String |
屏蔽字段名。 |
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
隐私屏蔽规则ID。 |
policy_id |
String |
策略ID。 |
path |
String |
隐私屏蔽规则应用的URL(默认完全匹配)。 |
category |
String |
屏蔽字段,取值范围是:params,header。 |
index |
String |
屏蔽字段名。 |
timestamp |
Long |
创建隐私屏蔽规则的时间。 |
举栗
以创建隐私屏蔽规则为例
请求样例
{
"path": "/login",
"category": "params",
"index": "name"
}
响应样例
{
"id": "e1c0e55865544d1f8c95cf71df108c6b",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"path": "/login",
"category":"params",
"index": "name",
"timestamp": 123243414132
}
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
删除
URI格式
DELETE /v1/{project_id}/waf/policy/{policy_id}/privacy/{privacy_rule_id}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
privacy_rule_id |
是 |
String |
隐私屏蔽规则ID。 |
请求消息
请求参数
无
响应消息
响应参数
无
正常状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
204 |
No Content |
服务器成功处理了请求,没有返回任何内容。 |
查询(详细信息)
URI格式
GET /v1/{project_id}/waf/policy/{policy_id}/privacy/{privacy_rule_id}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
privacy_rule_id |
是 |
String |
隐私屏蔽规则的ID。 |
请求消息
请求参数
无
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
隐私屏蔽规则ID。 |
policy_id |
String |
策略ID。 |
path |
String |
隐私屏蔽规则应用的URL(默认完全匹配)。 |
category |
String |
屏蔽字段,取值范围是:params,header。 |
index |
String |
屏蔽字段名。 |
timestamp |
Long |
创建隐私屏蔽规则的时间。 |
举栗
以查询id为“e1c0e55865544d1f8c95cf71df108c6b”的隐私屏蔽规则为例。
响应样例
{
"id": "e1c0e55865544d1f8c95cf71df108c6b",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"path": "/login",
"category": "params",
"index": "password",
"timestamp": 12324435345
}
状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
更新
URI格式
PUT /v1/{project_id}/waf/policy/{policy_id}/privacy/{privacy_rule_id}
Path参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
project_id |
是 |
String |
用户操作的项目ID。 |
policy_id |
是 |
String |
策略ID。 |
privacy_rule_id |
是 |
String |
隐私屏蔽规则的ID。 |
请求消息
请求参数
请求参数说明 |
|||
名称 |
是否必选 |
参数类型 |
说明 |
path |
是 |
String |
隐私屏蔽规则应用的URL(默认完全匹配)。 |
category |
是 |
String |
屏蔽字段,取值范围是:params,header。 |
index |
是 |
String |
屏蔽字段名。 |
响应消息
响应参数
响应参数说明 |
||
名称 |
参数类型 |
说明 |
id |
String |
隐私屏蔽规则ID。 |
policy_id |
String |
策略ID。 |
path |
String |
隐私屏蔽应用的URL(默认完全匹配)。 |
category |
String |
屏蔽字段,取值范围是:params,header。 |
index |
String |
屏蔽字段名。 |
timestamp |
Long |
创建隐私屏蔽规则的时间。 |
举栗
以更新隐私屏蔽规则为例
请求样例
{
"path": "/login",
"category": "params",
"index": "password"
}
响应样例
{
"id": "e1c0e55865544d1f8c95cf71df108c6b",
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
"path": "/login",
"category": "params",
"index": "password",
"timestamp": 123434534543
}
状态码
状态码 |
||
状态码 |
编码 |
状态说明 |
200 |
OK |
客户端请求已处理成功。 |
- 点赞
- 收藏
- 关注作者
评论(0)