IP 高防

产品文档

IP 高防

帮助中心 > OpenAPI & SDK > IP 高防 > describeBlackListRulesOfWebRule

describeBlackListRulesOfWebRule

描述

查询网站类规则的黑名单规则列表

请求方式

GET

请求地址

https://ipanti.jdcloud-api.com/v1/regions/{regionId}/instances/{instanceId}/webRules/{webRuleId}/webBlackListRules

名称 类型 是否必需 默认值 描述
regionId String True 区域 ID, 高防不区分区域, 传 cn-north-1 即可
instanceId String True 高防实例 Id
webRuleId String True 网站规则 Id

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 页码, 默认为1
pageSize Integer False 分页大小, 默认为10, 取值范围[10, 100]

返回参数

名称 类型 描述
result Result
requestId String
error Error

Error

名称 类型 描述
err Err

Err

名称 类型 描述
code Long 同http code
details Object
message String
status String 具体错误

Result

名称 类型 描述
dataList WebBlackListRule[ ]
currentCount Integer 当前页数量
totalCount Integer 总数
totalPage Integer 总页数

WebBlackListRule

名称 类型 描述
id String 黑名单规则 Id
name String 黑名单规则名称
mode Integer 匹配模式:
- 0: uri
- 1: ip
- 2: cookie
- 3: geo
- 4: header
key String 匹配 key.
- mode 为 cookie 时, 为 cookie 的 name
- mode 为 header 时, 为 header 的 key
value String 匹配 value.
- mode 为 uri 时, 为要匹配的 uri
- mode 为 ip 时, 为引用的 ip 黑白名单 Id
- mode 为 cookie 时, 为 cookie 的 value
- mode 为 header 时, 为 header 的 value
pattern Integer 匹配规则, mode 为 uri, cookie 和 header 时有效. 包含以下匹配规则:
- 0: 完全匹配
- 1: 前缀匹配
- 2: 包含
- 3: 正则匹配
- 4: 后缀匹配
action Integer 命中后处理动作.
- 0: 放行
- 1: CC 防护
actionValue String 命中后处理值, action 为 2 时 actionValue 为跳转路径
status Integer 规则状态.
- 0: 关闭
- 1: 开启
geoList Geo[ ] geo 黑名单地域列表, mode 不为 geo 或未设置时此字段为空

Geo

名称 类型 描述
label String geo 拦截地域
value String geo 拦截地域编码

返回码

返回码 描述
200 OK
更新时间:2020-03-09 18:47:32