真实IP获取规则¶
POST 查询IP获取规则集合 nlaV1:acl:query¶
POST /prod-api/waf/realIP/describeRealIPRules
Body 请求参数
请求参数¶
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Authorization | header | string | 是 | - | |
| body | body | DescribeRealIPRulesReqVO | 是 | DescribeRealIPRulesReqVO | - |
返回示例
200 Response
{"total":1,"rows":[{"ruleId":"23","ruleName":"text","rules":"[{\"method\":\"UNTRUSTED_IP\",\"value\":\"1.1.1.2\\n3.3.3.3\"},{\"method\":\"HTTP_HEADER\",\"value\":\"2\"},{\"method\":\"X_FORWARDED_FOR_LEFT\",\"value\":\"1\"},{\"method\":\"SOCKET\",\"value\":\"\"}]","updateTime":"2026-02-25 17:15:13","domains":[{"label":"waf2.demo.com","value":"215"},{"label":"waf4.demo.com","value":"216"},{"label":"gbp.demo.com.cn","value":"219"}]}],"code":200,"msg":"成功"}
返回结果¶
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 201 | Created | Created | - |
| 401 | Unauthorized | Unauthorized | - |
| 403 | Forbidden | Forbidden | - |
| 404 | Not Found | Not Found | - |
返回数据结构¶
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » total | integer | true | - | 总数 | - |
| » rows | [object] | true | - | 数据列表 | - |
| »» ruleId | string | false | - | 规则集 ID | 该条规则的唯一 ID;编辑 IP 获取规则集合 **编辑**时写入请求体,**新增**时不写 |
| »» ruleName | string | false | - | 规则名称 | - |
| »» rules | string | false | - | 规则集 | - |
| »» updateTime | string | false | - | 更新时间 | - |
| »» domains | [object] | false | - | 关联域名 | - |
| »»» label | string | true | - | - | |
| »»» value | string | true | - | - | |
| » code | integer | true | - | - | |
| » msg | string | true | - | - |
数据模型¶
DescribeRealIPRulesReqVO
DescribeRealIPRulesReqVO
属性¶
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| filters | [SearchFilterVo] | false | - | 搜索条件 | - |
| pageNum | integer(int32) | true | - | 当前页数 | - |
| pageSize | integer(int32) | true | - | 每页显示条目个数 | - |
SearchFilterVo
SearchFilterVo
属性¶
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| label | string | false | - | 参数名 | 规则名称/域名:ruleName/domain |
| value | [string] | false | - | 值 | 数组类型,传入单个值为模糊搜索,多个值为精确搜索 |