IP 高防

IP 高防

产品文档

IP 高防

帮助中心 > OpenAPI & SDK > IP 高防 > modifyBlackListRuleOfWebRule
搜本产品

modifyBlackListRuleOfWebRule

描述

修改网站类规则的黑名单规则

请求方式

PATCH

请求地址

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

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

请求参数

名称 类型 是否必需 默认值 描述
webBlackListRuleSpec WebBlackListRuleSpec True 修改网站类规则的黑名单规则请求参数

WebBlackListRuleSpec

名称 类型 是否必需 默认值 描述
name String True 黑名单规则名称
mode Integer True 模式:
- 0: uri
- 1: ip
- 2: cookie
- 3: geo
- 4: header
key String False 匹配 key, mode 为 cookie 和 header 时必传.
- mode 为 cookie 时, 传 cookie 的 name
- mode 为 header 时, 传 header 的 key
value String True 匹配 value.
- mode 为 uri 时, 传要匹配的 uri
- mode 为 ip 时, 传引用的 ip 黑白名单 Id
- mode 为 cookie 时, 传 cookie 的 value
- mode 为 geo 时, 传 geo 区域编码以 ',' 分隔的字符串. 查询 describeWebRuleBlackListGeoAreas 接口获取可设置的地域编码列表
- mode 为 header 时, 传 header 的 value
pattern Integer False 匹配规则, mode 为 uri, cookie 和 header 时必传. 支持以下匹配规则:
- 0: 完全匹配
- 1: 前缀匹配
- 2: 包含
- 3: 正则匹配
- 4: 后缀匹配
action Integer True 命中后处理动作.
- 0: 封禁并返回自定义页面
- 1: 跳转
- 2: 验证码
actionValue String False 命中后处理值, 命中后处理动作为跳转时有效, 表示跳转路径
status Integer True 规则状态.
- 0: 关闭
- 1: 开启
pageId String False 关联的自定义页面id, 命中后处理动作为封禁并返回自定义页面时有效, 为空时表示默认页面

返回参数

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

Error

名称 类型 描述
err Err

Err

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

Result

名称 类型 描述
code Integer 修改结果, 0: 修改失败, 1: 修改成功
message String 修改失败时给出具体原因

返回码

返回码 描述
200 OK
更新时间：2020-11-20 14:33:11
feedback