IP 高防

产品文档

IP 高防

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

describeForwardRules

描述

查询某个实例下的非网站转发配置

请求方式

GET

请求地址

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

名称 类型 是否必需 默认值 描述
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, port: 转发端口, originPort: 源站端口, serviceIp: 高防IP(仅支持BGP线路的实例)
searchValue String False 查询类型值
sorts Sort[ ] False 排序属性:
port - 按转发端口排序,默认不排序,asc表示按转发端口升序,desc表示按转发端口降序

Sort

名称 类型 是否必需 默认值 描述
name String False 排序条件的名称
direction String False 排序条件的方向

返回参数

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

Error

名称 类型 描述
err Err

Err

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

Result

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

ForwardRule

名称 类型 描述
id String 规则 Id
instanceId String 实例 Id
protocol String TCP 或 UDP
cname String 规则的 CNAME
originType String 回源类型: ip 或者 domain
serviceIp String 该规则使用中的高防 IP
serviceIpConfig ServiceIpConfig 已配置的高防 IP 列表
port Integer 端口号
algorithm String 转发规则.
- wrr: 带权重的轮询
- rr: 不带权重的轮询
- sh: 源地址hash
originAddr OriginAddrItem[ ]
onlineAddr String[ ] 备用的回源地址列表
originDomain String 回源域名
originPort Integer 回源端口号
status Integer 0: 防御状态
1: 回源状态

OriginAddrItem

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

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