产品文档

Web 应用防火墙

2023-06-27 09:14:43

listIps

描述

获取网站黑白名单ip配置

请求方式

POST

请求地址

https://waf.jdcloud-api.com/v1/regions/{regionId}/wafInstanceIds/{wafInstanceId}/userdefine:listIps

名称 类型 是否必需 默认值 描述
regionId String True 实例所属的地域ID
wafInstanceId String True 实例Id

请求参数

名称 类型 是否必需 默认值 描述
req ListDenySkipRulesReq True 请求
content-language String True 语言,"en":英文,"zh":中文

ListDenySkipRulesReq

名称 类型 是否必需 默认值 描述
wafInstanceId String True WAF实例id
domain String True 域名
iswhite Integer True 0表示黑名单 1表示白名单
pageIndex Integer False 页码,[1-100],默认是1
pageSize Integer False 页大小,[1-100],默认是10

返回参数

名称 类型 描述
result Result
requestId String 此次请求的ID

Result

名称 类型 描述
wafInstanceId String 实例id
domain String 域名
iswhite String 0表示黑名单 1表示白名单
pageIndex Integer 页码,[1-100]
pageSize Integer 页大小,[1-100]
count Integer 总数
data IpListCfg[] ip黑白名单信息

IpListCfg

名称 类型 描述
id Integer 序号id
updateTime String 规则更新时间,秒级时间戳, 0 表示历史数据无记录
disable Integer 0-使用中 1-禁用
val String ruleType为0时,支持ipv4/8,ipv4/16,ipv4/24,ipv4/32,ipv6/64;ruleType为1时,为ip集名称
ruleType Integer 0-单ip 1-ip集
atCfg AtCfg action配置
tag String 备注
skipRuleId String 白名单不检查指定Web防护规则id, 多个逗号分隔

AtCfg

名称 类型 描述
denyAction DenyActionCfg 黑名单动作配置
skipAction SkipActionCfg 白名单动作配置

SkipActionCfg

名称 类型 描述
passAll Integer 是否跳过所有阶段,1表示是,0表示否
cc Integer 是否执行cc防护,1表示是,0表示否
waf Integer 是否执行waf防护,1表示是,0表示否
deny Integer 是否执行deny防护,1表示是,0表示否
rateLimit Integer 是否执行限速,1表示是,0表示否
bot Integer 是否执行bot,1表示是,0表示否
risk Integer 是否执行风控,1表示是,0表示否

DenyActionCfg

名称 类型 描述
atOp Integer 黑名单匹配动作类型 观察 5:notice 人机识别 3:verify@captcha, 4:verify@jscookie, 6:verify@rdtcookie 拦截 1:forbidden@, 2:redirect@ 动态防护 7:cc动态防护(仅cc安全防护支持)
atVal String 黑名单匹配动作内容 当atOp为3-7时,atVal为空,atOp=1时,atVal为自定义页面,atOp=2时,atVal为跳转url。

返回码

HTTP状态码 错误码 描述
200 OK
文档反馈

开始与售前顾问沟通

可直接拨打电话 400-098-8505转1

我们的产品专家为您找到最合适的产品/解决⽅案

在线咨询 5*8⼩时

1v1线上咨询获取售前专业咨询

点击咨询
企微服务助手

专业产品顾问,随时随地沟通