查询条件参数¶
1. 接口描述¶
接口请求路径：GET /prod-api/waf/nlaV1/custom/rules/describeParameter
describeParameter 返回配置自定义控制规则时可用的匹配字段（targets）与执行动作（actions）元数据，供前端渲染条件表单与动作选项。完整枚举以接口实时返回为准。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
本接口无业务请求参数。
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值：200 |
| msg | String | 提示信息。示例值：成功 |
| data | Object | 元数据 |
| data.targets | [ParameterTarget] | 匹配字段列表 |
| data.actions | [ParameterAction] | 执行动作列表 |
4. 示例¶
示例1 查询条件与动作元数据¶
输入示例¶
代码调用¶
请将 {登录域名}、token 替换为实际值。
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class DescribeParameterTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/waf/nlaV1/custom/rules/describeParameter";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpGet httpGet = new HttpGet(url);
httpGet.setHeader("Authorization", "Bearer " + token);
try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
int statusCode = response.getStatusLine().getStatusCode();
String body = EntityUtils.toString(response.getEntity(), "UTF-8");
System.out.println("Status Code: " + statusCode);
System.out.println("Body: " + body);
}
}
}
}
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{登录域名}/prod-api/waf/nlaV1/custom/rules/describeParameter"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
req, err := http.NewRequest(http.MethodGet, url, nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+token)
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println("Status Code:", resp.StatusCode)
fmt.Println("Body:", string(body))
}
输出示例（节选）¶
{
"msg": "成功",
"code": 200,
"data": {
"targets": [
{
"name": "IP",
"target": "IP_SRC",
"value": "IP_SRC",
"operators": ["IP_IN_LIST", "NOT_IP_IN_LIST"],
"valueModelMap": {
"IP_IN_LIST": { "type": "data_list", "values": [] }
},
"optionals": [],
"remark": ""
},
{
"name": "主机名",
"target": "HOST",
"value": "HOST",
"operators": ["EQ", "NOT_EQ", "CONTAINS", "MATCHES", "IN_LIST"],
"remark": "例如：example.com"
},
{
"name": "请求方法",
"target": "REQUEST_METHOD",
"value": "REQUEST_METHOD",
"operators": ["IN", "NOT_IN"],
"optionals": ["GET", "POST", "PUT", "DELETE", "HEAD", "OPTIONS", "PATCH"]
}
],
"actions": [
{
"name": "拦截",
"value": "DENY",
"operators": ["nolog", "log"],
"parameters": null
},
{
"name": "重定向",
"value": "REDIRECT",
"operators": ["nolog", "log"],
"parameters": { "301": "301", "302": "302", "303": "303", "307": "307" }
},
{
"name": "鉴权",
"value": "AUTHENTICATION",
"operators": ["nolog", "log"],
"parameters": null
}
]
}
}
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
6. 数据模型¶
ParameterTarget¶
匹配字段元数据。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 中文展示名。示例值：主机名 |
| target | String | 维度编码，写入规则条件的 target。示例值：HOST |
| value | String | 同 target 或辅助标识 |
| operators | Array of String | 该字段可用运算符编码列表 |
| valueModelMap | Object | 以运算符为键的取值 UI 模型（如 data_list / multiple / multiple_group）；可能为空 |
| optionals | Array | 可选枚举值（如协议、方法）；可能为空 |
| groupList / selectList | Array | 分组或扁平下拉数据（如国家/省份）；视字段而定 |
| remark | String | 填写提示 |
常见 target：IP_SRC（IP）、COUNTRY_CODE（国家/地区）、PROVINCE_CODE（省份/地区）、HOST（主机名）、ARGS（查询字符串）、REQUEST_URI（Uri 请求）、URI（路径）、REQUEST_HEADERS（请求头）、USER_AGENT（用户代理）、REQUEST_PROTOCOL（请求协议）、REQUEST_METHOD（请求方法）、REFERER（Referer）、X_FORWARDED_FOR（X-Forwarded-For）。
常用运算符：EQ / NOT_EQ（等于 / 不等于）、IN / NOT_IN（属于 / 不属于）、CONTAINS / NOT_CONTAINS（包含 / 不包含）、MATCHES / NOT_MATCHES（正则匹配 / 不匹配）、BEGINS_WITH / ENDS_WITH（开头 / 末尾）、IN_LIST / NOT_IN_LIST（在 / 不在数据集合）、IP_IN_LIST / NOT_IP_IN_LIST（IP 在 / 不在数据集合）。
ParameterAction¶
执行动作元数据。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 中文展示名。示例值：拦截 |
| value | String | 动作编码，写入规则 rules.action.action。取值：DENY（拦截）、LOG（仅记录不拦截）、ALLOW（跳过后续规则）、LIMIT_RATE（频率限速）、CAPTCHA（人机验证）、DETECTION_ROBOT（验证爬虫）、REDIRECT（重定向）、AUTHENTICATION（鉴权）。示例值：DENY |
| operators | Array of String | 日志选项，通常为 log / nolog |
| parameters | Object | 附加参数元数据；多数为 null；REDIRECT 含状态码映射 { "301":"301", "302":"302", "303":"303", "307":"307" } |