真实IP获取规则¶

POST 编辑IP获取规则集合 nlaV1:acl:edit¶

POST /prod-api/waf/realIP/modifyRealIPRules

Body 请求参数

新增规则集（请求体中不写 ruleId）：

{
    "domains": [
        { "label": "waf2.ruisuyun.com", "value": 215 },
        { "label": "gbp.gloria.com.cn", "value": 219 }
    ],
    "ruleName": "demo",
    "rules": [
        { "method": "SOCKET", "value": "" }
    ]
}

编辑规则集（需带上 ruleId）：

{
    "ruleId": 25,
    "domains": [
        { "label": "waf2.ruisuyun.com", "value": 215 },
        { "label": "gbp.gloria.com.cn", "value": 219 }
    ],
    "ruleName": "demo",
    "rules": [
        { "method": "SOCKET", "value": "" }
    ]
}

填写说明¶

场景	`ruleId`
新增规则集	请求体中不写该参数
编辑规则集	必填，取查询 IP 获取规则集合返回的 `rows[].ruleId`

请求参数¶

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是		-
body	body	ModifyRealIPRulesReqVO	是	ModifyRealIPRulesReqVO	-

返回示例

200 Response

{"msg":"成功","code":200,"data":{"ruleName":"demo","domains":[{"label":"waf2.demo.com","value":215},{"label":"gbp.demo.com.cn","value":219},{"label":"lwtest.demo.com","value":233}],"ruleId":25,"rules":[{"method":"SOCKET","value":""}]}}

返回结果¶

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	-
401	Unauthorized	Unauthorized	-
403	Forbidden	Forbidden	-
404	Not Found	Not Found	-

返回数据结构¶

状态码 200

名称	类型	必选	约束	中文名	说明
» msg	string	true	-		-
» code	integer	true	-		-
» data	object	true	-		-
»» ruleName	string	true	-	规则名称	-
»» domains	[object]	true	-	关联域名	-
»»» label	string	true	-		-
»»» value	integer	true	-		-
»» ruleId	integer	true	-	规则集 ID	新增成功后由接口返回；编辑时作为请求参数传入
»» rules	[object]	true	-	规则集	-
»»» method	string	false	-	方式	-
»»» value	string	false	-	值	-

数据模型¶

MapByLabelValue¶

{
  "label": {},
  "value": {}
}

MapByLabelValue

属性¶

名称	类型	必选	约束	中文名	说明
label	object	false	-	域名	-
value	object	false	-	值	-

ModifyRealIPRulesReqVO¶

{
  "domains": [
    {
      "label": "waf2.demo.com",
      "value": 215
    }
  ],
  "ruleName": "demo",
  "rules": [
    {
      "method": "SOCKET",
      "value": ""
    }
  ]
}

编辑时在上述基础上增加 ruleId。

ModifyRealIPRulesReqVO

属性¶

名称	类型	必选	约束	中文名	说明
domains	[MapByLabelValue]	true	-		-
ruleId	integer(int64)	否	-	规则集 ID	新增时请求体中不写该参数；编辑时必填，与查询接口 `rows[].ruleId` 一致
ruleName	string	true	-	规则名称	-
rules	[RealIPRuleModel]	false	-	规则集	-

RealIPRuleModel¶

{
  "method": "string",
  "value": "string"
}

RealIPRuleModel

属性¶

名称	类型	必选	约束	中文名	说明
method	string	false	-	方法	取值有: SOCKET：表示从socket连接中获取IP； X_FORWARDED_FOR_LEFT：表示从 X-Forwarded-For 中获取左起指定位置IP； X_FORWARDED_FOR_RIGHT：表示从 X-Forwarded-For 中获取右起指定位置IP； HTTP_HEADER：表示从HTTP header头中获取IP； UNTRUSTED_IP：表示从socket或X-Forwarded-For中获取最后一层未信任IP。
value	string	false	-	值	-