WAF3.0 API¶
GET 查询条件参数¶
GET /prod-api/waf/wafv3/custom/rules/describeParameter
获取**创建/编辑自定义控制规则**时所需的元数据:可选「匹配对象(targets)」、各对象支持的「运算符(operators)」、运算符下可选值的 UI 模型(valueModelMap),以及规则命中后的「处置动作(actions)」。
无请求体。前端或对接方应先调用本接口,再按返回结构组装 编辑自定义控制规则 中的 rules.conditions 与 rules.action。
请求参数¶
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Authorization | header | string | 是 | 鉴权 | Bearer Token |
返回示例
200 Response
{
"msg": "成功",
"code": 200,
"data": {
"targets": [
{
"valueModelMap": {
"NOT_IP_IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "black",
"value": 52
},
{
"label": "vfg",
"value": 83
}
],
"label": "自定义"
}
]
},
"IP_IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "black",
"value": 52
},
{
"label": "whitelist_1",
"value": 57
},
{
"label": "22_22",
"value": 81
},
{
"label": "vfg",
"value": 83
}
],
"label": "自定义"
}
]
}
},
"operators": [
"IP_IN_LIST",
"NOT_IP_IN_LIST"
],
"name": "IP",
"remark": "",
"optionals": null,
"value": "IP_SRC",
"target": "IP_SRC"
},
{
"valueModelMap": {
"IN": {
"type": "multiple_group",
"values": [
{
"children": [
{
"label": "阿联酋",
"value": "AE"
},
{
"label": "乌兹别克斯坦",
"value": "UZ"
},
{
"label": "蒙古国 蒙古",
"value": "MN"
}
],
"label": "亚洲",
"value": "亚洲"
},
{
"children": [
{
"label": "美属萨摩亚",
"value": "AS"
},
{
"label": "赫德岛和麦克唐纳群岛",
"value": "HM"
},
{
"label": "库克群岛",
"value": "CK"
},
{
"label": "新西兰",
"value": "NZ"
}
],
"label": "大洋洲",
"value": "大洋洲"
},
{
"children": [
{
"label": "安哥拉",
"value": "AO"
},
{
"label": "布基纳法索",
"value": "BF"
},
{
"label": "莫桑比克",
"value": "MZ"
},
{
"label": "冈比亚",
"value": "GM"
},
{
"label": "肯尼亚",
"value": "KE"
}
],
"label": "非洲",
"value": "非洲"
},
{
"children": [
{
"label": "安道尔",
"value": "AD"
},
{
"label": "阿尔巴尼亚",
"value": "AL"
},
{
"label": "英国",
"value": "GB"
},
{
"label": "葡萄牙",
"value": "PT"
}
],
"label": "欧洲",
"value": "欧洲"
},
{
"children": [
{
"label": "安提瓜和巴布达",
"value": "AG"
},
{
"label": "安圭拉",
"value": "AI"
},
{
"label": "南乔治亚岛和南桑威奇群岛",
"value": "GS"
},
{
"label": "危地马拉",
"value": "GT"
},
{
"label": "圣皮埃尔和密克隆",
"value": "PM"
},
{
"label": "圣卢西亚",
"value": "LC"
}
],
"label": "美洲",
"value": "美洲"
},
{
"children": [
{
"label": "南极洲",
"value": "AQ"
}
],
"label": "南极洲",
"value": "南极洲"
}
]
},
"NOT_IN": {
"type": "multiple_group",
"values": [
{
"children": [
{
"label": "阿联酋",
"value": "AE"
},
{
"label": "阿富汗",
"value": "AF"
},
{
"label": "亚美尼亚",
"value": "AM"
},
{
"label": "阿塞拜疆",
"value": "AZ"
},
{
"label": "孟加拉",
"value": "BD"
},
{
"label": "巴林",
"value": "BH"
},
{
"label": "文莱",
"value": "BN"
},
{
"label": "不丹",
"value": "BT"
},
{
"label": "塞浦路斯",
"value": "CY"
},
{
"label": "格鲁吉亚",
"value": "GE"
},
{
"label": "香港(中国)",
"value": "HK"
},
{
"label": "印尼",
"value": "ID"
},
{
"label": "以色列",
"value": "IL"
},
{
"label": "印度",
"value": "IN"
},
{
"label": "伊拉克",
"value": "IQ"
},
{
"label": "伊朗",
"value": "IR"
},
{
"label": "约旦",
"value": "JO"
},
{
"label": "日本",
"value": "JP"
},
{
"label": "柬埔寨",
"value": "KH"
},
{
"label": "科威特",
"value": "KW"
},
{
"label": "黎巴嫩",
"value": "LB"
},
{
"label": "斯里兰卡",
"value": "LK"
},
{
"label": "缅甸",
"value": "MM"
},
{
"label": "澳门(中国)",
"value": "MO"
},
{
"label": "马尔代夫",
"value": "MV"
},
{
"label": "马来西亚",
"value": "MY"
},
{
"label": "尼泊尔",
"value": "NP"
},
{
"label": "阿曼",
"value": "OM"
},
{
"label": "菲律宾",
"value": "PH"
},
{
"label": "巴基斯坦",
"value": "PK"
},
{
"label": "巴勒斯坦",
"value": "PS"
},
{
"label": "卡塔尔",
"value": "QA"
},
{
"label": "新加坡",
"value": "SG"
},
{
"label": "叙利亚",
"value": "SY"
},
{
"label": "泰国",
"value": "TH"
},
{
"label": "东帝汶",
"value": "TL"
},
{
"label": "土耳其",
"value": "TR"
},
{
"label": "越南",
"value": "VN"
},
{
"label": "也门",
"value": "YE"
},
{
"label": "中国 内地",
"value": "CN"
},
{
"label": "台湾(中国)",
"value": "TW"
},
{
"label": "沙特阿拉伯",
"value": "SA"
},
{
"label": "老挝",
"value": "LA"
},
{
"label": "朝鲜 北朝鲜",
"value": "KP"
},
{
"label": "韩国 南朝鲜",
"value": "KR"
},
{
"label": "吉尔吉斯斯坦",
"value": "KG"
},
{
"label": "哈萨克斯坦",
"value": "KZ"
},
{
"label": "塔吉克斯坦",
"value": "TJ"
},
{
"label": "土库曼斯坦",
"value": "TM"
},
{
"label": "乌兹别克斯坦",
"value": "UZ"
},
{
"label": "蒙古国 蒙古",
"value": "MN"
}
],
"label": "亚洲",
"value": "亚洲"
},
{
"children": [
{
"label": "美属萨摩亚",
"value": "AS"
},
{
"label": "澳大利亚",
"value": "AU"
},
{
"label": "科科斯群岛",
"value": "CC"
},
{
"label": "圣诞岛",
"value": "CX"
},
{
"label": "斐济群岛",
"value": "FJ"
},
{
"label": "密克罗尼西亚联邦",
"value": "FM"
},
{
"label": "关岛",
"value": "GU"
},
{
"label": "赫德岛和麦克唐纳群岛",
"value": "HM"
},
{
"label": "基里巴斯",
"value": "KI"
},
{
"label": "马绍尔群岛",
"value": "MH"
},
{
"label": "诺福克岛",
"value": "NF"
},
{
"label": "瑙鲁",
"value": "NR"
},
{
"label": "法属波利尼西亚",
"value": "PF"
},
{
"label": "巴布亚新几内亚",
"value": "PG"
},
{
"label": "皮特凯恩群岛",
"value": "PN"
},
{
"label": "帕劳",
"value": "PW"
},
{
"label": "所罗门群岛",
"value": "SB"
},
{
"label": "托克劳",
"value": "TK"
},
{
"label": "汤加",
"value": "TO"
},
{
"label": "图瓦卢",
"value": "TV"
},
{
"label": "瓦利斯和富图纳",
"value": "WF"
},
{
"label": "萨摩亚",
"value": "WS"
},
{
"label": "北马里亚纳群岛",
"value": "MP"
},
{
"label": "新喀里多尼亚",
"value": "NC"
},
{
"label": "瓦努阿图",
"value": "VU"
},
{
"label": "纽埃",
"value": "NU"
},
{
"label": "美国本土外小岛屿",
"value": "UM"
},
{
"label": "库克群岛",
"value": "CK"
},
{
"label": "新西兰",
"value": "NZ"
}
],
"label": "大洋洲",
"value": "大洋洲"
},
{
"children": [
{
"label": "安哥拉",
"value": "AO"
},
{
"label": "布基纳法索",
"value": "BF"
},
{
"label": "布隆迪",
"value": "BI"
},
{
"label": "贝宁",
"value": "BJ"
},
{
"label": "博茨瓦纳",
"value": "BW"
},
{
"label": "中非",
"value": "CF"
},
{
"label": "喀麦隆",
"value": "CM"
},
{
"label": "佛得角",
"value": "CV"
},
{
"label": "吉布提",
"value": "DJ"
},
{
"label": "阿尔及利亚",
"value": "DZ"
},
{
"label": "埃及",
"value": "EG"
},
{
"label": "西撒哈拉",
"value": "EH"
},
{
"label": "厄立特里亚",
"value": "ER"
},
{
"label": "加蓬",
"value": "GA"
},
{
"label": "加纳",
"value": "GH"
},
{
"label": "几内亚",
"value": "GN"
},
{
"label": "赤道几内亚",
"value": "GQ"
},
{
"label": "几内亚比绍",
"value": "GW"
},
{
"label": "英属印度洋领地",
"value": "IO"
},
{
"label": "科摩罗",
"value": "KM"
},
{
"label": "利比里亚",
"value": "LR"
},
{
"label": "莱索托",
"value": "LS"
},
{
"label": "利比亚",
"value": "LY"
},
{
"label": "摩洛哥",
"value": "MA"
},
{
"label": "马达加斯加",
"value": "MG"
},
{
"label": "马里",
"value": "ML"
},
{
"label": "毛里塔尼亚",
"value": "MR"
},
{
"label": "马拉维",
"value": "MW"
},
{
"label": "纳米比亚",
"value": "NA"
},
{
"label": "尼日尔",
"value": "NE"
},
{
"label": "尼日利亚",
"value": "NG"
},
{
"label": "留尼汪",
"value": "RE"
},
{
"label": "卢旺达",
"value": "RW"
},
{
"label": "塞舌尔",
"value": "SC"
},
{
"label": "苏丹",
"value": "SD"
},
{
"label": "塞拉利昂",
"value": "SL"
},
{
"label": "塞内加尔",
"value": "SN"
},
{
"label": "索马里",
"value": "SO"
},
{
"label": "南苏丹",
"value": "SS"
},
{
"label": "圣多美和普林西比",
"value": "ST"
},
{
"label": "斯威士兰",
"value": "SZ"
},
{
"label": "乍得",
"value": "TD"
},
{
"label": "多哥",
"value": "TG"
},
{
"label": "突尼斯",
"value": "TN"
},
{
"label": "坦桑尼亚",
"value": "TZ"
},
{
"label": "乌干达",
"value": "UG"
},
{
"label": "马约特",
"value": "YT"
},
{
"label": "南非",
"value": "ZA"
},
{
"label": "赞比亚",
"value": "ZM"
},
{
"label": "津巴布韦",
"value": "ZW"
},
{
"label": "刚果(布)",
"value": "CG"
},
{
"label": "刚果(金)",
"value": "CD"
},
{
"label": "莫桑比克",
"value": "MZ"
},
{
"label": "冈比亚",
"value": "GM"
},
{
"label": "埃塞俄比亚",
"value": "ET"
},
{
"label": "法属南部领地",
"value": "TF"
},
{
"label": "圣赫勒拿",
"value": "SH"
},
{
"label": "毛里求斯",
"value": "MU"
},
{
"label": "科特迪瓦",
"value": "CI"
},
{
"label": "肯尼亚",
"value": "KE"
}
],
"label": "非洲",
"value": "非洲"
},
{
"children": [
{
"label": "安道尔",
"value": "AD"
},
{
"label": "阿尔巴尼亚",
"value": "AL"
},
{
"label": "奥地利",
"value": "AT"
},
{
"label": "奥兰群岛",
"value": "AX"
},
{
"label": "波黑",
"value": "BA"
},
{
"label": "比利时",
"value": "BE"
},
{
"label": "保加利亚",
"value": "BG"
},
{
"label": "白俄罗斯",
"value": "BY"
},
{
"label": "瑞士",
"value": "CH"
},
{
"label": "捷克",
"value": "CZ"
},
{
"label": "德国",
"value": "DE"
},
{
"label": "丹麦",
"value": "DK"
},
{
"label": "爱沙尼亚",
"value": "EE"
},
{
"label": "西班牙",
"value": "ES"
},
{
"label": "芬兰",
"value": "FI"
},
{
"label": "法罗群岛",
"value": "FO"
},
{
"label": "法国",
"value": "FR"
},
{
"label": "直布罗陀",
"value": "GI"
},
{
"label": "希腊",
"value": "GR"
},
{
"label": "克罗地亚",
"value": "HR"
},
{
"label": "匈牙利",
"value": "HU"
},
{
"label": "爱尔兰",
"value": "IE"
},
{
"label": "马恩岛",
"value": "IM"
},
{
"label": "冰岛",
"value": "IS"
},
{
"label": "意大利",
"value": "IT"
},
{
"label": "泽西岛",
"value": "JE"
},
{
"label": "列支敦士登",
"value": "LI"
},
{
"label": "立陶宛",
"value": "LT"
},
{
"label": "卢森堡",
"value": "LU"
},
{
"label": "拉脱维亚",
"value": "LV"
},
{
"label": "摩纳哥",
"value": "MC"
},
{
"label": "摩尔多瓦",
"value": "MD"
},
{
"label": "黑山",
"value": "ME"
},
{
"label": "马其顿",
"value": "MK"
},
{
"label": "马耳他",
"value": "MT"
},
{
"label": "荷兰",
"value": "NL"
},
{
"label": "挪威",
"value": "NO"
},
{
"label": "波兰",
"value": "PL"
},
{
"label": "罗马尼亚",
"value": "RO"
},
{
"label": "塞尔维亚",
"value": "RS"
},
{
"label": "俄罗斯",
"value": "RU"
},
{
"label": "瑞典",
"value": "SE"
},
{
"label": "斯洛文尼亚",
"value": "SI"
},
{
"label": "斯瓦尔巴群岛和 扬马延岛",
"value": "SJ"
},
{
"label": "斯洛伐克",
"value": "SK"
},
{
"label": "圣马力诺",
"value": "SM"
},
{
"label": "乌克兰",
"value": "UA"
},
{
"label": "梵蒂冈",
"value": "VA"
},
{
"label": "根西岛",
"value": "GG"
},
{
"label": "英国",
"value": "GB"
},
{
"label": "葡萄牙",
"value": "PT"
}
],
"label": "欧洲",
"value": "欧洲"
},
{
"children": [
{
"label": "安提瓜和巴布达",
"value": "AG"
},
{
"label": "安圭拉",
"value": "AI"
},
{
"label": "阿根廷",
"value": "AR"
},
{
"label": "阿鲁巴",
"value": "AW"
},
{
"label": "巴巴多斯",
"value": "BB"
},
{
"label": "圣巴泰勒米岛",
"value": "BL"
},
{
"label": "百慕大",
"value": "BM"
},
{
"label": "玻利维亚",
"value": "BO"
},
{
"label": "荷兰加勒比区",
"value": "BQ"
},
{
"label": "巴西",
"value": "BR"
},
{
"label": "巴哈马",
"value": "BS"
},
{
"label": "布韦岛",
"value": "BV"
},
{
"label": "伯利兹",
"value": "BZ"
},
{
"label": "加拿大",
"value": "CA"
},
{
"label": "智利",
"value": "CL"
},
{
"label": "哥伦比亚",
"value": "CO"
},
{
"label": "哥斯达黎加",
"value": "CR"
},
{
"label": "古巴",
"value": "CU"
},
{
"label": "多米尼克",
"value": "DM"
},
{
"label": "多米尼加",
"value": "DO"
},
{
"label": "厄瓜多尔",
"value": "EC"
},
{
"label": "马尔维纳斯群岛( 福克兰)",
"value": "FK"
},
{
"label": "格林纳达",
"value": "GD"
},
{
"label": "法属圭亚那",
"value": "GF"
},
{
"label": "格陵兰",
"value": "GL"
},
{
"label": "瓜德罗普",
"value": "GP"
},
{
"label": "南乔治亚岛和南桑威奇群岛",
"value": "GS"
},
{
"label": "危地马拉",
"value": "GT"
},
{
"label": "圭亚那",
"value": "GY"
},
{
"label": "洪都拉斯",
"value": "HN"
},
{
"label": "海地",
"value": "HT"
},
{
"label": "牙买加",
"value": "JM"
},
{
"label": "开曼群岛",
"value": "KY"
},
{
"label": "法属圣马丁",
"value": "MF"
},
{
"label": "马提尼克",
"value": "MQ"
},
{
"label": "蒙塞拉特岛",
"value": "MS"
},
{
"label": "墨西哥",
"value": "MX"
},
{
"label": "尼加拉瓜",
"value": "NI"
},
{
"label": "巴拿马",
"value": "PA"
},
{
"label": "秘鲁",
"value": "PE"
},
{
"label": "波多黎各",
"value": "PR"
},
{
"label": "巴拉圭",
"value": "PY"
},
{
"label": "苏里南",
"value": "SR"
},
{
"label": "萨尔瓦多",
"value": "SV"
},
{
"label": "特克斯和凯科斯群岛",
"value": "TC"
},
{
"label": "美国",
"value": "US"
},
{
"label": "乌拉圭",
"value": "UY"
},
{
"label": "委内瑞拉",
"value": "VE"
},
{
"label": "英属维尔京群岛",
"value": "VG"
},
{
"label": "美属维尔京群岛",
"value": "VI"
},
{
"label": "特立尼达和多巴哥",
"value": "TT"
},
{
"label": "圣文森特和格林纳丁斯",
"value": "VC"
},
{
"label": "圣基茨和尼维斯",
"value": "KN"
},
{
"label": "圣皮埃尔和密克隆",
"value": "PM"
},
{
"label": "圣卢西亚",
"value": "LC"
}
],
"label": "美洲",
"value": "美洲"
},
{
"children": [
{
"label": "南极洲",
"value": "AQ"
}
],
"label": "南极洲",
"value": "南极洲"
}
]
}
},
"operators": [
"IN",
"NOT_IN"
],
"name": "国家/地区",
"remark": "",
"groupList": [
{
"children": [
{
"label": "阿联酋",
"value": "AE"
},
{
"label": "阿富汗",
"value": "AF"
},
{
"label": "亚美尼亚",
"value": "AM"
},
{
"label": "阿塞拜疆",
"value": "AZ"
},
{
"label": "孟加拉",
"value": "BD"
},
{
"label": "巴林",
"value": "BH"
},
{
"label": "文莱",
"value": "BN"
},
{
"label": "不丹",
"value": "BT"
},
{
"label": "塞浦路斯",
"value": "CY"
},
{
"label": "格鲁吉亚",
"value": "GE"
},
{
"label": "香港(中国)",
"value": "HK"
},
{
"label": "印尼",
"value": "ID"
},
{
"label": "以色列",
"value": "IL"
},
{
"label": "印度",
"value": "IN"
},
{
"label": "伊拉克",
"value": "IQ"
},
{
"label": "伊朗",
"value": "IR"
},
{
"label": "约旦",
"value": "JO"
},
{
"label": "日本",
"value": "JP"
},
{
"label": "柬埔寨",
"value": "KH"
},
{
"label": "科威特",
"value": "KW"
},
{
"label": "黎巴嫩",
"value": "LB"
},
{
"label": "斯里兰卡",
"value": "LK"
},
{
"label": "缅甸",
"value": "MM"
},
{
"label": "澳门(中国)",
"value": "MO"
},
{
"label": "马尔代夫",
"value": "MV"
},
{
"label": "马来西亚",
"value": "MY"
},
{
"label": "尼泊尔",
"value": "NP"
},
{
"label": "阿曼",
"value": "OM"
},
{
"label": "菲律宾",
"value": "PH"
},
{
"label": "巴基斯坦",
"value": "PK"
},
{
"label": "巴勒斯坦",
"value": "PS"
},
{
"label": "卡塔尔",
"value": "QA"
},
{
"label": "新加坡",
"value": "SG"
},
{
"label": "叙利亚",
"value": "SY"
},
{
"label": "泰国",
"value": "TH"
},
{
"label": "东帝汶",
"value": "TL"
},
{
"label": "土耳其",
"value": "TR"
},
{
"label": "越南",
"value": "VN"
},
{
"label": "也门",
"value": "YE"
},
{
"label": "中国 内地",
"value": "CN"
},
{
"label": "台湾(中国)",
"value": "TW"
},
{
"label": "沙特阿拉伯",
"value": "SA"
},
{
"label": "老挝",
"value": "LA"
},
{
"label": "朝鲜 北朝鲜",
"value": "KP"
},
{
"label": "韩国 南朝鲜",
"value": "KR"
},
{
"label": "吉尔吉斯斯坦",
"value": "KG"
},
{
"label": "哈萨克斯坦",
"value": "KZ"
},
{
"label": "塔吉克斯坦",
"value": "TJ"
},
{
"label": "土库曼斯坦",
"value": "TM"
},
{
"label": "乌兹别克斯坦",
"value": "UZ"
},
{
"label": "蒙古国 蒙古",
"value": "MN"
}
],
"label": "亚洲",
"value": "亚洲"
},
{
"children": [
{
"label": "美属萨摩亚",
"value": "AS"
},
{
"label": "澳大利亚",
"value": "AU"
},
{
"label": "科科斯群岛",
"value": "CC"
},
{
"label": "圣诞岛",
"value": "CX"
},
{
"label": "斐济群岛",
"value": "FJ"
},
{
"label": "密克罗尼西亚联邦",
"value": "FM"
},
{
"label": "关岛",
"value": "GU"
},
{
"label": "赫德岛和麦克唐纳群岛",
"value": "HM"
},
{
"label": "基里巴斯",
"value": "KI"
},
{
"label": "马绍尔群岛",
"value": "MH"
},
{
"label": "诺福克岛",
"value": "NF"
},
{
"label": "瑙鲁",
"value": "NR"
},
{
"label": "法属波利尼西亚",
"value": "PF"
},
{
"label": "巴布亚新几内亚",
"value": "PG"
},
{
"label": "皮特凯恩群岛",
"value": "PN"
},
{
"label": "帕劳",
"value": "PW"
},
{
"label": "所罗门群岛",
"value": "SB"
},
{
"label": "托克劳",
"value": "TK"
},
{
"label": "汤加",
"value": "TO"
},
{
"label": "图瓦卢",
"value": "TV"
},
{
"label": "瓦利斯和富图纳",
"value": "WF"
},
{
"label": "萨摩亚",
"value": "WS"
},
{
"label": "北马里亚纳群岛",
"value": "MP"
},
{
"label": "新喀里多尼亚",
"value": "NC"
},
{
"label": "瓦努阿图",
"value": "VU"
},
{
"label": "纽埃",
"value": "NU"
},
{
"label": "美国本土外小岛屿",
"value": "UM"
},
{
"label": "库克群岛",
"value": "CK"
},
{
"label": "新西兰",
"value": "NZ"
}
],
"label": "大洋洲",
"value": "大洋洲"
},
{
"children": [
{
"label": "安哥拉",
"value": "AO"
},
{
"label": "布基纳法索",
"value": "BF"
},
{
"label": "布隆迪",
"value": "BI"
},
{
"label": "贝宁",
"value": "BJ"
},
{
"label": "博茨瓦纳",
"value": "BW"
},
{
"label": "中非",
"value": "CF"
},
{
"label": "喀麦隆",
"value": "CM"
},
{
"label": "佛得角",
"value": "CV"
},
{
"label": "吉布提",
"value": "DJ"
},
{
"label": "阿尔及利亚",
"value": "DZ"
},
{
"label": "埃及",
"value": "EG"
},
{
"label": "西撒哈拉",
"value": "EH"
},
{
"label": "厄立特里亚",
"value": "ER"
},
{
"label": "加蓬",
"value": "GA"
},
{
"label": "加纳",
"value": "GH"
},
{
"label": "几内亚",
"value": "GN"
},
{
"label": "赤道几内亚",
"value": "GQ"
},
{
"label": "几内亚比绍",
"value": "GW"
},
{
"label": "英属印度洋领地",
"value": "IO"
},
{
"label": "科摩罗",
"value": "KM"
},
{
"label": "利比里亚",
"value": "LR"
},
{
"label": "莱索托",
"value": "LS"
},
{
"label": "利比亚",
"value": "LY"
},
{
"label": "摩洛哥",
"value": "MA"
},
{
"label": "马达加斯加",
"value": "MG"
},
{
"label": "马里",
"value": "ML"
},
{
"label": "毛里塔尼亚",
"value": "MR"
},
{
"label": "马拉维",
"value": "MW"
},
{
"label": "纳米比亚",
"value": "NA"
},
{
"label": "尼日尔",
"value": "NE"
},
{
"label": "尼日利亚",
"value": "NG"
},
{
"label": "留尼汪",
"value": "RE"
},
{
"label": "卢旺达",
"value": "RW"
},
{
"label": "塞舌尔",
"value": "SC"
},
{
"label": "苏丹",
"value": "SD"
},
{
"label": "塞拉利昂",
"value": "SL"
},
{
"label": "塞内加尔",
"value": "SN"
},
{
"label": "索马里",
"value": "SO"
},
{
"label": "南苏丹",
"value": "SS"
},
{
"label": "圣多美和普林西比",
"value": "ST"
},
{
"label": "斯威士兰",
"value": "SZ"
},
{
"label": "乍得",
"value": "TD"
},
{
"label": "多哥",
"value": "TG"
},
{
"label": "突尼斯",
"value": "TN"
},
{
"label": "坦桑尼亚",
"value": "TZ"
},
{
"label": "乌干达",
"value": "UG"
},
{
"label": "马约特",
"value": "YT"
},
{
"label": "南非",
"value": "ZA"
},
{
"label": "赞比亚",
"value": "ZM"
},
{
"label": "津巴布韦",
"value": "ZW"
},
{
"label": "刚果(布)",
"value": "CG"
},
{
"label": "刚果(金)",
"value": "CD"
},
{
"label": "莫桑比克",
"value": "MZ"
},
{
"label": "冈比亚",
"value": "GM"
},
{
"label": "埃塞俄比亚",
"value": "ET"
},
{
"label": "法属南部领地",
"value": "TF"
},
{
"label": "圣赫勒拿",
"value": "SH"
},
{
"label": "毛里求斯",
"value": "MU"
},
{
"label": "科特迪瓦",
"value": "CI"
},
{
"label": "肯尼亚",
"value": "KE"
}
],
"label": "非洲",
"value": "非洲"
},
{
"children": [
{
"label": "安道尔",
"value": "AD"
},
{
"label": "阿尔巴尼亚",
"value": "AL"
},
{
"label": "奥地利",
"value": "AT"
},
{
"label": "奥兰群岛",
"value": "AX"
},
{
"label": "波黑",
"value": "BA"
},
{
"label": "比利时",
"value": "BE"
},
{
"label": "保加利亚",
"value": "BG"
},
{
"label": "白俄罗斯",
"value": "BY"
},
{
"label": "瑞士",
"value": "CH"
},
{
"label": "捷克",
"value": "CZ"
},
{
"label": "德国",
"value": "DE"
},
{
"label": "丹麦",
"value": "DK"
},
{
"label": "爱沙尼亚",
"value": "EE"
},
{
"label": "西班牙",
"value": "ES"
},
{
"label": "芬兰",
"value": "FI"
},
{
"label": "法罗群岛",
"value": "FO"
},
{
"label": "法国",
"value": "FR"
},
{
"label": "直布罗陀",
"value": "GI"
},
{
"label": "希腊",
"value": "GR"
},
{
"label": "克罗地亚",
"value": "HR"
},
{
"label": "匈牙利",
"value": "HU"
},
{
"label": "爱尔兰",
"value": "IE"
},
{
"label": "马恩岛",
"value": "IM"
},
{
"label": "冰岛",
"value": "IS"
},
{
"label": "意大利",
"value": "IT"
},
{
"label": "泽西岛",
"value": "JE"
},
{
"label": "列支敦士登",
"value": "LI"
},
{
"label": "立陶宛",
"value": "LT"
},
{
"label": "卢森堡",
"value": "LU"
},
{
"label": "拉脱维亚",
"value": "LV"
},
{
"label": "摩纳哥",
"value": "MC"
},
{
"label": "摩尔多瓦",
"value": "MD"
},
{
"label": "黑山",
"value": "ME"
},
{
"label": "马其顿",
"value": "MK"
},
{
"label": "马耳他",
"value": "MT"
},
{
"label": "荷兰",
"value": "NL"
},
{
"label": "挪威",
"value": "NO"
},
{
"label": "波兰",
"value": "PL"
},
{
"label": "罗马尼亚",
"value": "RO"
},
{
"label": "塞尔维亚",
"value": "RS"
},
{
"label": "俄罗斯",
"value": "RU"
},
{
"label": "瑞典",
"value": "SE"
},
{
"label": "斯洛文尼亚",
"value": "SI"
},
{
"label": "斯瓦尔巴群岛和 扬马延岛",
"value": "SJ"
},
{
"label": "斯洛伐克",
"value": "SK"
},
{
"label": "圣马力诺",
"value": "SM"
},
{
"label": "乌克兰",
"value": "UA"
},
{
"label": "梵蒂冈",
"value": "VA"
},
{
"label": "根西岛",
"value": "GG"
},
{
"label": "英国",
"value": "GB"
},
{
"label": "葡萄牙",
"value": "PT"
}
],
"label": "欧洲",
"value": "欧洲"
},
{
"children": [
{
"label": "安提瓜和巴布达",
"value": "AG"
},
{
"label": "安圭拉",
"value": "AI"
},
{
"label": "阿根廷",
"value": "AR"
},
{
"label": "阿鲁巴",
"value": "AW"
},
{
"label": "巴巴多斯",
"value": "BB"
},
{
"label": "圣巴泰勒米岛",
"value": "BL"
},
{
"label": "百慕大",
"value": "BM"
},
{
"label": "玻利维亚",
"value": "BO"
},
{
"label": "荷兰加勒比区",
"value": "BQ"
},
{
"label": "巴西",
"value": "BR"
},
{
"label": "巴哈马",
"value": "BS"
},
{
"label": "布韦岛",
"value": "BV"
},
{
"label": "伯利兹",
"value": "BZ"
},
{
"label": "加拿大",
"value": "CA"
},
{
"label": "智利",
"value": "CL"
},
{
"label": "哥伦比亚",
"value": "CO"
},
{
"label": "哥斯达黎加",
"value": "CR"
},
{
"label": "古巴",
"value": "CU"
},
{
"label": "多米尼克",
"value": "DM"
},
{
"label": "多米尼加",
"value": "DO"
},
{
"label": "厄瓜多尔",
"value": "EC"
},
{
"label": "马尔维纳斯群岛( 福克兰)",
"value": "FK"
},
{
"label": "格林纳达",
"value": "GD"
},
{
"label": "法属圭亚那",
"value": "GF"
},
{
"label": "格陵兰",
"value": "GL"
},
{
"label": "瓜德罗普",
"value": "GP"
},
{
"label": "南乔治亚岛和南桑威奇群岛",
"value": "GS"
},
{
"label": "危地马拉",
"value": "GT"
},
{
"label": "圭亚那",
"value": "GY"
},
{
"label": "洪都拉斯",
"value": "HN"
},
{
"label": "海地",
"value": "HT"
},
{
"label": "牙买加",
"value": "JM"
},
{
"label": "开曼群岛",
"value": "KY"
},
{
"label": "法属圣马丁",
"value": "MF"
},
{
"label": "马提尼克",
"value": "MQ"
},
{
"label": "蒙塞拉特岛",
"value": "MS"
},
{
"label": "墨西哥",
"value": "MX"
},
{
"label": "尼加拉瓜",
"value": "NI"
},
{
"label": "巴拿马",
"value": "PA"
},
{
"label": "秘鲁",
"value": "PE"
},
{
"label": "波多黎各",
"value": "PR"
},
{
"label": "巴拉圭",
"value": "PY"
},
{
"label": "苏里南",
"value": "SR"
},
{
"label": "萨尔瓦多",
"value": "SV"
},
{
"label": "特克斯和凯科斯群岛",
"value": "TC"
},
{
"label": "美国",
"value": "US"
},
{
"label": "乌拉圭",
"value": "UY"
},
{
"label": "委内瑞拉",
"value": "VE"
},
{
"label": "英属维尔京群岛",
"value": "VG"
},
{
"label": "美属维尔京群岛",
"value": "VI"
},
{
"label": "特立尼达和多巴哥",
"value": "TT"
},
{
"label": "圣文森特和格林纳丁斯",
"value": "VC"
},
{
"label": "圣基茨和尼维斯",
"value": "KN"
},
{
"label": "圣皮埃尔和密克隆",
"value": "PM"
},
{
"label": "圣卢西亚",
"value": "LC"
}
],
"label": "美洲",
"value": "美洲"
},
{
"children": [
{
"label": "南极洲",
"value": "AQ"
}
],
"label": "南极洲",
"value": "南极洲"
}
],
"optionals": null,
"value": "COUNTRY_CODE",
"target": "COUNTRY_CODE"
},
{
"valueModelMap": {
"IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "zhuji",
"value": 79
},
{
"label": "zhuji",
"value": 80
}
],
"label": "自定义"
}
]
},
"NOT_IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "zhuji",
"value": 79
},
{
"label": "zhuji",
"value": 80
}
],
"label": "自定义"
}
]
}
},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES",
"IN_LIST",
"NOT_IN_LIST"
],
"name": "主机名",
"remark": "例如:example.com",
"optionals": null,
"value": "HOST",
"target": "HOST"
},
{
"valueModelMap": {},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES"
],
"name": "参数名",
"remark": "例如:page=1234中的page",
"optionals": null,
"value": "ARGS_NAMES",
"target": "ARGS_NAMES"
},
{
"valueModelMap": null,
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES"
],
"name": "POST参数",
"remark": "来自POST请求体的参数值",
"optionals": null,
"value": "ARGS_POST",
"target": "ARGS_POST"
},
{
"valueModelMap": null,
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES"
],
"name": "POST参数名",
"remark": "来自POST请求体参数的名称",
"optionals": null,
"value": "ARGS_POST_NAMES",
"target": "ARGS_POST_NAMES"
},
{
"valueModelMap": {},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES"
],
"name": "查询字符串",
"remark": "例如:page=1234",
"optionals": null,
"value": "",
"target": "ARGS"
},
{
"valueModelMap": {
"IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "uri",
"value": 62
}
],
"label": "自定义"
}
]
},
"NOT_IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "uri",
"value": 62
}
],
"label": "自定义"
}
]
}
},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"BEGINS_WITH",
"NOT_BEGINS_WITH",
"ENDS_WITH",
"NOT_ENDS_WITH",
"MATCHES",
"NOT_MATCHES",
"IN_LIST",
"NOT_IN_LIST"
],
"name": "Uri",
"remark": "例如:/contact?page=1234",
"optionals": null,
"value": "REQUEST_URI",
"target": "REQUEST_URI"
},
{
"valueModelMap": {},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES"
],
"name": "Cookies",
"remark": "例如:name=value,中的value",
"optionals": null,
"value": "",
"target": "REQUEST_COOKIES"
},
{
"valueModelMap": {},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES"
],
"name": "请求头",
"remark": "",
"optionals": null,
"value": "",
"target": "REQUEST_HEADERS"
},
{
"valueModelMap": {},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES",
"EXIST",
"NOT_EXIST"
],
"name": "请求头名",
"remark": "例如:Content-type",
"optionals": null,
"value": "REQUEST_HEADERS_NAMES",
"target": "REQUEST_HEADERS_NAMES"
},
{
"valueModelMap": {
"INT_EQ": {
"type": "select",
"values": [
{
"label": "不存在",
"value": "0"
},
{
"label": "存在",
"value": "1"
}
]
}
},
"operators": [
"INT_EQ"
],
"name": "检查请求头名",
"remark": "请求头的名称集合,忽略大小写",
"optionals": [
"0",
"1"
],
"value": "",
"target": "CHECK_REQUEST_HEADERS_NAMES"
},
{
"valueModelMap": {},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES",
"IN_LIST",
"NOT_IN_LIST"
],
"name": "用户代理",
"remark": "例如:Mozilla/5.0 (Windows NT 10.0; Win64; x64)...",
"optionals": null,
"value": "USER_AGENT",
"target": "USER_AGENT"
},
{
"valueModelMap": {
"IN": {
"type": "multiple",
"values": [
"HTTP/1.0",
"HTTP/1.1",
"HTTP/1.2",
"HTTP/2",
"HTTP/3"
]
},
"NOT_IN": {
"type": "multiple",
"values": [
"HTTP/1.0",
"HTTP/1.1",
"HTTP/1.2",
"HTTP/2",
"HTTP/3"
]
}
},
"operators": [
"IN",
"NOT_IN",
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS"
],
"name": "请求协议",
"remark": "例如:HTTP/1.0",
"optionals": [
"HTTP/1.0",
"HTTP/1.1",
"HTTP/1.2",
"HTTP/2",
"HTTP/3"
],
"value": "REQUEST_PROTOCOL",
"target": "REQUEST_PROTOCOL"
},
{
"valueModelMap": {
"IN": {
"type": "multiple",
"values": [
"GET",
"POST",
"PUT",
"DELETE",
"PURGE",
"HEAD",
"OPTIONS",
"PATCH"
]
},
"NOT_IN": {
"type": "multiple",
"values": [
"GET",
"POST",
"PUT",
"DELETE",
"PURGE",
"HEAD",
"OPTIONS",
"PATCH"
]
}
},
"operators": [
"IN",
"NOT_IN"
],
"name": "请求方法",
"remark": "例如:GET",
"optionals": [
"GET",
"POST",
"PUT",
"DELETE",
"PURGE",
"HEAD",
"OPTIONS",
"PATCH"
],
"value": "REQUEST_METHOD",
"target": "REQUEST_METHOD"
},
{
"valueModelMap": {},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES",
"IN_LIST",
"NOT_IN_LIST"
],
"name": "Referer",
"remark": "",
"optionals": null,
"value": "REFERER",
"target": "REFERER"
},
{
"valueModelMap": {
"IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "123",
"value": 82
}
],
"label": "自定义"
}
]
},
"NOT_IN_LIST": {
"type": "data_list",
"values": [
{
"options": [
{
"label": "123",
"value": 82
}
],
"label": "自定义"
}
]
}
},
"operators": [
"EQ",
"NOT_EQ",
"CONTAINS",
"NOT_CONTAINS",
"MATCHES",
"NOT_MATCHES",
"IN_LIST",
"NOT_IN_LIST"
],
"name": "X-Forwarded-For",
"remark": "",
"optionals": null,
"value": "X_FORWARDED_FOR",
"target": "X_FORWARDED_FOR"
}
],
"actions": [
{
"operators": [
"log"
],
"name": "拦截",
"value": "DENY",
"parameters": null
},
{
"operators": [
"log"
],
"name": "仅记录不拦截",
"value": "LOG",
"parameters": null
},
{
"operators": [
"nolog",
"log"
],
"name": "跳过规则",
"value": "SKIP_RULES",
"parameters": {
"limitRules": "limitRules",
"custodyRules": "custodyRules",
"remainRules": "remainRules"
}
},
{
"operators": [
"nolog",
"log"
],
"name": "加白规则ID",
"value": "WHITE_RULE_IDS",
"parameters": null
},
{
"operators": [
"nolog",
"log"
],
"name": "重定向",
"value": "REDIRECT",
"parameters": {
"301": "301",
"302": "302",
"303": "303",
"307": "307"
}
}
]
}
}
说明:上例为便于阅读的节选。实际
targets还包含参数名、POST 参数、Cookies、请求头、Referer、X-Forwarded-For 等;国家/地区的multiple_group/groupList含完整大洲与国家代码列表,以接口实时返回为准。
返回结果¶
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
| 401 | Unauthorized | 未授权 | - |
| 403 | Forbidden | 无权限 | - |
返回数据结构¶
状态码 200
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| » msg | string | 是 | 提示信息 | - |
| » code | integer | 是 | 状态码 | 200 表示成功 |
| » data | object | 是 | 元数据 | 含 targets、actions |
| »» targets | [object] | 是 | 匹配对象列表 | 配置条件时选择「检查什么」 |
| »» actions | [object] | 是 | 处置动作列表 | 配置 rules.action.action 时选择 |
data.targets[] 单条匹配对象¶
| 字段 | 类型 | 说明 |
|---|---|---|
name |
string | 界面展示名,如「IP」「国家/地区」「Uri」 |
target |
string | 提交规则时写入条件的字段,与 编辑自定义控制规则 中 conditions[].target 一致;部分项 value 为空字符串时以 target 为准(如 ARGS、REQUEST_COOKIES) |
value |
string | 与 target 通常相同;历史兼容字段,对接时优先使用 target |
remark |
string | 字段说明/填写提示 |
operators |
string[] | 该匹配对象支持的**运算符编码**列表,见下表 |
valueModelMap |
object | 以运算符为键,描述该运算符下「可选值」如何展示与取值;无预设时为 {} |
optionals |
string[] 或 null | 部分类型的固定可选值(如 HTTP 方法枚举);无则为 null |
groupList |
array 或 null | 仅「国家/地区」等分组多选类型存在;扁平化的洲/国家树,便于前端组件绑定 |
valueModelMap 常见 type 与含义¶
| type | 适用运算符(示例) | 含义 | values 结构要点 |
|---|---|---|---|
data_list |
IP_IN_LIST、NOT_IP_IN_LIST、IN_LIST、NOT_IN_LIST |
从**数据集合**中选列表 | values[].label 为分组名(如「自定义」);values[].options[] 中 label 为集合名称,value 为 dataListId(整数) |
multiple_group |
IN、NOT_IN(国家/地区) |
分组多选 | values[] 含 label、value、children[];children 中 value 为国家/地区代码(如 CN) |
multiple |
IN、NOT_IN(协议、方法等) |
扁平多选 | values 为字符串数组,或 {label,value} 对象数组 |
select |
INT_EQ(检查请求头名) |
下拉单选 | values[] 为 {label, value},如存在/不存在 |
valueModelMap 的**键名**与 operators 中的运算符编码一致:配置某条条件时,先选 target,再选 operator,最后按该 operator 在 valueModelMap 中的模型填写 values。
部分 target 的 valueModelMap 为 {}(如查询字符串、请求头、Cookies),表示无预设枚举/列表,需配合 EQ、CONTAINS、MATCHES 等运算符**自由输入**匹配值。
运算符编码对照(targets[].operators)¶
| 编码 | 界面含义 |
|---|---|
EQ |
等于 |
NOT_EQ |
不等于 |
INT_EQ |
等于(整型/存在性,如请求头是否存在) |
IN |
包含以下各项 |
NOT_IN |
不包含以下各项 |
CONTAINS |
包含 |
NOT_CONTAINS |
不包含 |
MATCHES |
与正则表达式匹配 |
NOT_MATCHES |
与正则表达式不匹配 |
BEGINS_WITH |
开头匹配 |
NOT_BEGINS_WITH |
开头不匹配 |
ENDS_WITH |
末尾匹配 |
NOT_ENDS_WITH |
末尾不匹配 |
IN_LIST |
在数据集合中 |
NOT_IN_LIST |
不在数据集合中 |
IP_IN_LIST |
源 IP 在数据集合中 |
NOT_IP_IN_LIST |
源 IP 不在数据集合中 |
EXIST |
存在 |
NOT_EXIST |
不存在 |
WAF3.0 完整 target 编码一览(data.targets)¶
| target | name(展示) | 典型 operators |
|---|---|---|
IP_SRC |
IP | IP_IN_LIST、NOT_IP_IN_LIST |
COUNTRY_CODE |
国家/地区 | IN、NOT_IN |
HOST |
主机名 | EQ…IN_LIST 等 |
ARGS_NAMES |
参数名 | EQ…MATCHES |
ARGS_POST |
POST参数 | 同上 |
ARGS_POST_NAMES |
POST参数名 | 同上 |
ARGS |
查询字符串 | 自由输入类运算符 |
REQUEST_URI |
Uri | 含 BEGINS_WITH、ENDS_WITH、IN_LIST 等 |
REQUEST_COOKIES |
Cookies | 自由输入类 |
REQUEST_HEADERS |
请求头 | 自由输入类 |
REQUEST_HEADERS_NAMES |
请求头名 | 含 EXIST、NOT_EXIST |
CHECK_REQUEST_HEADERS_NAMES |
检查请求头名 | INT_EQ |
USER_AGENT |
用户代理 | 含 IN_LIST 等 |
REQUEST_PROTOCOL |
请求协议 | IN、NOT_IN 等 |
REQUEST_METHOD |
请求方法 | IN、NOT_IN |
REFERER |
Referer | 含 IN_LIST 等 |
X_FORWARDED_FOR |
X-Forwarded-For | 含 IN_LIST 等 |
列表接口 列出自定义控制规则 返回的 targets[].value 即上表中的 target 编码;targets[].name 为对应中文名。
data.actions 字段说明¶
规则命中后的处置方式;保存规则时 rules.action.action 填下表中的 **value**(不是 name)。
| 字段 | 类型 | 说明 |
|---|---|---|
name |
string | 中文展示名 |
value |
string | 动作编码,提交用 |
operators |
string[] | 该动作可选的日志策略:log(记录)、nolog(不记录) |
parameters |
object 或 null | 附加参数;仅部分动作有值 |
WAF3.0 动作对照¶
| value | name | parameters |
|---|---|---|
DENY |
拦截 | 无 |
LOG |
仅记录不拦截 | 无 |
SKIP_RULES |
跳过规则 | 对象,键:remainRules(其余自定义规则)、limitRules(限速规则)、custodyRules(托管规则) |
WHITE_RULE_IDS |
加白规则ID | 无 |
REDIRECT |
重定向 | 对象,键为状态码:301、302、303、307 |
SKIP_RULES 的 parameters 键说明¶
| 键 | 含义 |
|---|---|
remainRules |
跳过其余自定义规则 |
limitRules |
跳过全部限速规则 |
custodyRules |
跳过全部托管(基础防护)规则 |
与编辑规则接口的关系¶
- 调用本接口获取
targets、actions。 - 用户选择匹配对象 → 从该项的
operators选运算符 → 按valueModelMap[operator]填写values(数据集合填 dataListId,国家填 国家代码 等)。 - 组装 编辑自定义控制规则 请求体中的
rules.conditions与rules.action。
数据集合选项来自本接口 type: data_list 的 options;集合维护见 数据集合相关接口。