批量更新防敏感信息泄露规则 - BatchUpdateAntileakageRule
功能介绍
批量更新防敏感信息泄露规则
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/waf/rule/antileakage/batch-update
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| url | 是 | String | 规则应用的url |
| category | 是 | String | 类别(响应码:code,敏感信息:sensitive) |
| contents | 是 | Array of strings | 内容(http状态码:400 、401、402 、 403 、404 、 405 、500 、501 、502 、503、 504 、507;手机:phone、身份证号:id_card、邮箱:email) |
| action | 否 | action object | 规则命中后操作对象 |
| description | 否 | String | 规则描述 |
| policy_rule_ids | 是 | Array of policy_rule_ids objects | 参数解释: 策略和规则id数组,关联防护策略与对应的规则集合 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policy_rule_ids | Array of policy_rule_ids objects | 参数解释: 策略和规则id数组,返回防护策略与对应规则的ID关联关系 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policy_id | String | 参数解释: 策略id,唯一标识一条防护策略 取值范围: 不涉及 |
| rule_ids | Array of strings | 参数解释: 规则id数组,返回当前防护策略下的多条规则ID 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
批量更新防敏感信息泄露规则
POST https://{endpoint}/v1/{project_id}/waf/rule/antileakage/batch-update?enterprise_project_id=0
{
"url" : "/attack",
"category" : "sensitive",
"contents" : [ "id_card" ],
"policy_rule_ids" : [ {
"rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
"policy_id" : "4a34899ab17a4811a6da57742f69135a"
} ]
} 响应示例
状态码:200
参数解释:
OK
约束限制:
不涉及
取值范围:
不涉及
默认取值:
不涉及
{
"policy_rule_ids" : [ {
"rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
"policy_id" : "4a34899ab17a4811a6da57742f69135a"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: OK 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 400 | 参数解释: 请求失败 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 401 | 参数解释: token权限不足 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 500 | 参数解释: 服务器内部错误 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
错误码
请参见错误码。