为多个策略批量添加威胁情报访问控制规则 - BatchCreateIpReputationRule
功能介绍
选中多个策略为这些策略批量添加威胁情报访问控制规则
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/rule/ip-reputation
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policyids |
否 |
String |
参数解释: 域名id。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
|
enterprise_project_id |
否 |
String |
参数解释: 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。 约束限制: 不涉及 取值范围:
默认取值: 0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: 规则名称 约束限制: 不涉及 取值范围: 规则名称只能由字母、数字、-、_和.组成,长度不能超过64个字符 默认取值: 不涉及 |
|
type |
是 |
String |
参数解释: 信誉类型(目前只支持idc) 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
tags |
是 |
Array of strings |
参数解释: 标签列表,用于指定关联的情报标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
action |
是 |
action object |
参数解释: 防护动作配置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
description |
否 |
String |
参数解释: 规则描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
policy_ids |
是 |
Array of strings |
参数解释: 添加规则的策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取,多个策略之间用“,”隔开 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 规则ID,唯一标识该规则 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
policyid |
String |
参数解释: 所属防护策略ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
name |
String |
参数解释: 规则名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
policyname |
String |
参数解释: 所属策略名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
timestamp |
Long |
参数解释: 规则创建时间戳(毫秒级) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
description |
String |
参数解释: 规则描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
status |
Integer |
参数解释: 规则状态(1表示开启,0表示关闭) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
type |
String |
参数解释: 规则类型(如idc表示机房IP情报类型) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
tags |
Array of strings |
参数解释: 标签列表,关联的情报标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
action |
action object |
参数解释: 防护动作配置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码: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/ip-reputation?enterprise_project_id=0
{
"name" : "dddd",
"type" : "idc",
"tags" : [ "HW" ],
"action" : {
"category" : "block"
},
"policy_ids" : [ "1368ab6534634aaf9e0fd7575d0d3584", "9d7f27e4073640618ee20947471f1a25" ]
}
响应示例
状态码:200
参数解释:
OK
约束限制:
不涉及
取值范围:
不涉及
默认取值:
不涉及
{
"name" : "dddd",
"type" : "idc",
"tags" : [ "HW" ],
"action" : {
"category" : "block"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
参数解释: OK 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
400 |
参数解释: 请求失败 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
401 |
参数解释: token权限不足 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
500 |
参数解释: 服务器内部错误 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
错误码
请参见错误码。