IP 高防

产品文档

IP 高防

describeWebRules

描述

查询某个实例下的网站类规则

请求方式

GET

请求地址

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

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

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 页码, 默认为1
pageSize Integer False 分页大小, 默认为10, 取值范围[10, 100]
searchType String False 查询类型名称, domain:源站域名, ip:源站 IP, rawDomain: 域名, serviceIp: 高防IP(仅支持BGP线路的实例)
searchValue String False 查询类型值

返回参数

名称 类型 描述
result Result
requestId String

Result

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

WebRule

名称 类型 描述
id String 规则 Id
instanceId String 实例 Id
domain String 子域名
cname String 规则的 CNAME
cnameStatus Integer CNAME 解析状态, 0: 解析异常, 1: 解析正常
serviceIp String 该规则使用中的高防 IP
serviceIpConfig ServiceIpConfig 已配置的高防 IP 列表
protocol WebRuleProtocol
customPortStatus Integer 是否为自定义端口号, 0: 为默认, 1: 为自定义
port Integer[ ] HTTP 协议的端口号, 如 80,81
httpsPort Integer[ ] HTTPS 协议的端口号, 如 443,8443
httpOrigin Integer 是否开启 HTTP 回源, 0: 为不开启, 1: 为开启, 当勾选 HTTPS 时可以配置该属性
status Integer 0: 防御状态, 1: 回源状态
originType String 回源类型: A 或者 CNAME
originAddr OriginAddrItem[ ] 回源域名, originType 为 A 时返回该字段
originDomain String 回源域名, originType 为 CNAME 时返回该字段
onlineAddr String[ ] 备用的回源地址列表, 为一个域名或者多个 IP 地址
httpCertStatus Integer 证书状态.
- 0: 异常
- 1: 正常
- 2: 证书未上传
certId String 证书 Id, (废弃, 绑定证书信息通过 certs 字段查看)
certName String 证书名称, (废弃, 绑定证书信息通过 certs 字段查看)
httpsCertContent String 证书内容, (废弃, 绑定证书信息通过 certs 字段查看)
httpsRsaKey String 证书私钥, (废弃, 绑定证书信息通过 certs 字段查看)
bindCerts Cert[ ] 网站规则绑定证书信息
forceJump Integer 是否开启 HTTPS 强制跳转, 当 protocol 为 HTTP_HTTPS 时可以配置该属性
- 0: 不强跳
- 1: 开启强跳
algorithm String 转发规则.
- wrr: 带权重的轮询
- rr: 不带权重的轮询
- sh: 源地址hash
ccStatus Integer CC 状态, 0: CC 关闭, 1: CC 开启
webSocketStatus Integer webSocket 状态, 0: 关闭, 1: 开启
blackListEnable Integer 黑名单状态, 0: 关闭, 1: 开启
whiteListEnable Integer 白名单状态, 0: 关闭, 1: 开启
geoRsRoute GeoRsRoute[ ] 按区域分流回源配置
enableKeepalive String 是否开启回源长连接, protocol 选项开启 https 时生效, 可取值
- on: 开启
- off: 关闭
httpVersion String http 版本, protocol 选项开启 https 时生效, 可取值 http1 或 http2
sslProtocols String[ ] SSL协议类型, protocol 选项开启 https 时生效, 可取值SSLv2,SSLv3,TLSv1.0,TLSv1.1,TLSv1.2
suiteLevel String 加密套件等级, protocol 选项开启 https 时生效, 可取值
- low: 低级
- middle: 中级
- high:高级
- custom:自定义
userSuiteLevel String[ ] 自定义加密套件等级, suiteLevel 为 custom 是有效
jsFingerprintEnable Integer 是否允许在 response 中插入 JS, 0: 关闭, 1: 开启
jsFingerprintScope Integer JS 指纹生效范围, 0: 所有页面, 1: 已配置的自定义页面
ccCustomStatus Integer CC自定义规则总开关, 0: 关闭, 1: 开启
enableHealthCheck Integer 健康检查开关, 0: 关闭, 1: 开启
proxyConnectTimeout Integer 回源连接超时时长, 单位 秒
enableUnderscores Integer 请求头支持下划线, 0: 关闭, 1: 开启

GeoRsRoute

名称 类型 描述
geo String 要设置的区域编码, 查询 describeWebRuleRSGeoAreas 接口获取可设置的地域编码
rsAddr String[ ] 对应区域的回源IP的列表

Cert

名称 类型 描述
certId String 证书id
certName String 证书名称

OriginAddrItem

名称 类型 描述
ip String 回源ip
weight Integer 权重
inJdCloud Boolean 是否为京东云内公网ip

WebRuleProtocol

名称 类型 描述
http Boolean http 协议
https Boolean https 协议

ServiceIpConfig

名称 类型 描述
serviceIps ServiceIpConfigItem[ ] 已配置的高防IP列表

ServiceIpConfigItem

名称 类型 描述
serviceIp String 高防IP
securityStatus String 安全状态.
- SAFE: 安全
- CLEANING: 清洗中
- BLOCKING: 封禁中
useStatus Integer 使用状态, 1: 使用中, 0: 备用候选

返回码

返回码 描述
200 OK
404 NOT_FOUND
更新时间:2022-01-24 14:52:40
feedback