Consulta de la lista de reglas de la lista negra y la lista blanca
Función
Esta API se utiliza para consultar la lista de reglas de listas negras y listas blancas.
URI
GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip
| 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 |
| name | No | String | ID de la regla de lista negra o lista blanca |
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 | Cantidad de reglas |
| items | Array of WhiteBlackIpResponseBody objects | Reglas |
| 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). |
| addr | String | Listas negras y blancas |
| white | Integer | Acción protectora: \n - 0: Block \n - 1: Allow \n - 2: Log only |
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
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip?enterprise_project_id=0 Ejemplo de respuestas
Código de estado: 200
OK
{
"total" : 1,
"items" : [ {
"id" : "3c96caf769ca4f57814fcf4259ea89a1",
"policyid" : "4dddfd44fc89453e9fd9cd6bfdc39db2",
"policyname" : "hkhtest",
"timestamp" : 1650362891844,
"description" : "demo",
"status" : 1,
"addr" : "x.x.x.x",
"white" : 0
} ]
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | OK |
| 400 | Error de solicitud. |
| 401 | Permisos de token insuficientes. |
| 500 | Error del servidor interno |
Códigos de error
Consulte Códigos de error.