Consulta de la lista de reglas de enmascaramiento de falsa alarma
Función
Esta API se utiliza para consultar la lista de reglas de enmascaramiento de falsas alarmas.
URI
GET /v1/{project_id}/waf/policy/{policy_id}/ignore
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
policy_id |
Sí |
String |
ID de política. Se puede obtener llamando a la API ListPolicy. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enterprise_project_id |
No |
String |
ID del proyecto de empresa. Se puede obtener mediante el llamado API ListEnterpriseProject de EPS. |
page |
No |
Integer |
Número de página de los datos a devolver durante la consulta de paginación. El valor varía de 0 a 100000. El valor predeterminado es 1, que indica que se devuelven los datos de la primera página. Predeterminado: 1 |
pagesize |
No |
Integer |
Número de resultados en cada página durante la consulta de paginación. El valor varía de 1 a 100. El valor predeterminado es 10, lo que indica que cada página contiene 10 resultados. Predeterminado: 10 |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta). |
Content-Type |
Sí |
String |
Tipo de contenido Predeterminado: application/json;charset=utf8 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total |
Integer |
Número de reglas de enmascaramiento de falsas alarmas en la política |
items |
Array of IgnoreRuleBody objects |
Objetos de regla de enmascaramiento de falsa alarma |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de la regla |
policyid |
String |
ID de política |
timestamp |
Long |
Tiempo de creación de reglas. |
description |
String |
Descripción de la regla |
status |
Integer |
Estado de la regla. El valor puede ser 0 (deshabilitado) o 1 (habilitado). |
url |
String |
La ruta para falsas alarmas de enmascaramiento. Este parámetro sólo está disponible cuando el modo se establece en 0. |
rule |
String |
ID de la regla integrada que se va a enmascarar. Puede consultar el ID de regla seleccionando Policies > Policy Name > Basic Web Protection > Protection Rules en la consola WAF o en la página de detalles del evento. |
mode |
Integer |
Número de versión. El valor puede ser 0 o 1. 0: indica la versión anterior V1. 1 indica la nueva versión V2. Cuando el valor de modo es 0, el campo conditions no existe, pero existen los campos conditions y conditions. Cuando el valor de modo es 1, los campos url y url_logic no existen, pero el campo conditions existe. |
url_logic |
String |
Lógica de coincidencia. El valor puede ser equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix, regular_match,o regular_not_match. |
conditions |
Array of Condition objects |
Lista de condiciones |
domains |
Array of strings |
Nombre de dominio o sitio web protegido |
Parámetro |
Tipo |
Descripción |
---|---|---|
category |
String |
Tipo de campo. El valor puede ser ip, url, params, cookie, o header. |
contents |
Array of strings |
Contenido. La longitud de la matriz está limitada a 1. El formato de contenido varía según el tipo de campo. Por ejemplo, si el tipo de campo es ip, el valor debe ser una dirección IP o un intervalo de direcciones IP. Si el tipo de campo es url, el valor debe estar en el formato de URL estándar. Si el tipo de campo es params, cookie o header, el formato de contenido no está limitado. |
logic_operation |
String |
La lógica de coincidencia varía dependiendo del tipo de campo. Por ejemplo, si el tipo de campo es ip, la lógica puede ser equal o not_equal. Si el tipo de campo es url, params, cookie, o header, la lógica puede ser equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix, regular_match,or regular_not_match. |
check_all_indexes_logic |
Integer |
Si el tipo de campo es url o ip, el campo check_all_indexes_logic no existe. En otros casos, 1 indica que se comprueban todos los subcampos, 2 indica que se comprueba cualquier subcampo, y el null indica que se usan subcampos definidos por el usuario. |
index |
String |
Si el tipo de campo es ip y el subcampo es la dirección IP del cliente, el parámetro index no existe. Si el tipo de subcampo es X-Forwarded-For, el valor es x-forwarded-for. Si el tipo de campo es params, header, or cookie y el subcampo está definido por el usuario, el valor de index es el subcampo definido por el usuario. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Código de estad: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Solicitudes de ejemplo
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0&page=1&pagesize=10
Ejemplo de respuestas
Código de estado: 200
OK
{ "total" : 1, "items" : [ { "id" : "40484384970948d79fffe4e4ae1fc54d", "policyid" : "f385eceedf7c4c34a4d1def19eafbe85", "timestamp" : 1650512535222, "description" : "demo", "status" : 1, "rule" : "091004", "mode" : 1, "conditions" : [ { "category" : "ip", "contents" : [ "x.x.x.x" ], "logic_operation" : "equal" } ], "domain" : [ "we.test.418lab.cn" ] } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Error de solicitud. |
403 |
La cuota de recursos es insuficiente. |
401 |
Permisos de token insuficientes. |
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.