Adición de una regla de enmascaramiento de falsa alarma
Función
Esta API se utiliza para agregar una regla de enmascaramiento de falsa alarma.
URI
POST /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. Puede obtener el ID llamando a la API ListEnterpriseProject de EPS. |
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ámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
domain |
Sí |
Array of strings |
Nombre de dominio o sitio web a proteger. Si la longitud del array es 0, la regla entra en vigor para todos los nombres de dominio o sitios web. |
|
conditions |
Sí |
Array of CreateCondition objects |
Lista de condiciones |
|
mode |
Sí |
Integer |
El valor se fija en 1, indicando v2 reglas de enmascaramiento de falsa alarma. v1 se utiliza solo para la compatibilidad con versiones anteriores, y las reglas de falsa alarma no se pueden crear en v1. |
|
rule |
Sí |
String |
ID de las reglas de enmascaramiento de falsas alarmas incorporadas. 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. |
|
description |
No |
String |
Descripción de la regla de filtrado |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
category |
Sí |
String |
Tipo de campo. El valor puede ser ip, url, params, cookie, o header. |
|
contents |
Sí |
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 |
Sí |
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 |
No |
Integer |
Solo cuando se utiliza un subcampo definido por el usuario y el tipo de campo es url o ip, el parámetro check_all_indexes_logic no es necesario. En otros casos, su valor puede ser 1 o 2, 1: indica que todos los subcampos están marcados. 2 indica que se compruebacualquiera de los subcampos. |
|
index |
No |
String |
Si el tipo de campo es ip y el subcampo es la dirección IP del cliente, el parámetro index no es necesario. 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. |
Parámetros de respuesta
Código de estado: 200
|
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). |
|
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 |
El valor se fija en 1, lo que indica que se usan las reglas de enmascaramiento de falsas alarmas v2. v1 se utiliza solo para la compatibilidad con versiones anteriores, y las reglas de falsa alarma no se pueden crear en v1. |
|
conditions |
Array of Condition objects |
Lista de condiciones |
|
domain |
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 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
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0
{
"domain" : [ "we.test.418lab.cn" ],
"conditions" : [ {
"category" : "url",
"logic_operation" : "contain",
"contents" : [ "x.x.x.x" ],
"index" : null
} ],
"mode" : 1,
"description" : "demo",
"rule" : "091004"
}
Ejemplo de respuestas
Código de estado: 200
OK
{
"id" : "a57f20ced01e4e0d8bea8e7c49eea254",
"policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
"timestamp" : 1650522310447,
"description" : "demo",
"status" : 1,
"rule" : "091004",
"mode" : 1,
"conditions" : [ {
"category" : "url",
"contents" : [ "x.x.x.x" ],
"logic_operation" : "contain"
} ],
"domain" : [ "we.test.418lab.cn" ]
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
OK |
|
400 |
Error de solicitud. |
|
401 |
El token no tiene permisos necesarios. |
|
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.