Consulta de una lista de política
Función
Consulta de una lista de política
URI
GET /v1/{project_id}/waf/policy
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
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 |
Nombre |
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 total de políticas |
items |
Array of PolicyResponse objects |
Contenido de la política |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de política |
name |
String |
Nombre de la política |
action |
PolicyAction object |
Operación |
options |
PolicyOption object |
Opción |
level |
Integer |
Nivel de protección |
full_detection |
Boolean |
Modo de detección en la regla de protección precisa |
bind_host |
Array of BindHost objects |
Información básica sobre el dominio protegido. |
timestamp |
Long |
Hora en que se crea una política |
extend |
Map<String,String> |
Campo extendido |
Parámetro |
Tipo |
Descripción |
---|---|---|
category |
String |
Nivel de protección. El valor puede ser log o block. log: WAF solo registra eventos. block: WAF bloquea eventos. Valores de enumeración:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
webattack |
Boolean |
Si la protección web básica está habilitada Valores de enumeración:
|
common |
Boolean |
Si la comprobación general está activada Valores de enumeración:
|
crawler |
Boolean |
Si la protección antideslizante está activada Valores de enumeración:
|
crawler_engine |
Boolean |
Si el motor de búsqueda está habilitado Valores de enumeración:
|
crawler_scanner |
Boolean |
Si la detección antideslizante está activada Valores de enumeración:
|
crawler_script |
Boolean |
Si el antideslizador JavaScript está activado Valores de enumeración:
|
crawler_other |
Boolean |
Si está activada la comprobación de otro rastreador Valores de enumeración:
|
webshell |
Boolean |
Si la detección de webshell está habilitada Valores de enumeración:
|
cc |
Boolean |
Si las reglas de protección contra ataques de CC están habilitadas Valores de enumeración:
|
custom |
Boolean |
Si la protección precisa está habilitada Valores de enumeración:
|
whiteblackip |
Boolean |
Si la protección de listas negras y blancas está habilitada. Valores de enumeración:
|
geoip |
Boolean |
Si el control de acceso de geolocalización está habilitado Valores de enumeración:
|
ignore |
Boolean |
Si el enmascaramiento de falsa alarma está habilitado. Valores de enumeración:
|
privacy |
Boolean |
Si el enmascaramiento de datos está habilitado Valores de enumeración:
|
antitamper |
Boolean |
Si la protección contra manipulaciones web está activada Valores de enumeración:
|
antileakage |
Boolean |
Si la prevención de fugas de información está activada Valores de enumeración:
|
bot_enable |
Boolean |
Si la mitigación de bots está habilitada Valores de enumeración:
|
modulex_enabled |
Boolean |
Si la protección contra ataques CC para moduleX está habilitada. Esta función se encuentra en la prueba beta abierta (OBT). Durante la OBT, solo se admite el modo de solo registro. Valores de enumeración:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de nombre de dominio |
hostname |
String |
Nombre de dominio |
waf_type |
String |
Modo de nombre de dominio: cloud (modo de cloud) / premium (modo dedicado) |
mode |
String |
Este parámetro es requerido solamente por el modo dedicado. |
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: 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?enterprise_project_id=0
Ejemplo de respuestas
Código de estado: 200
La solicitud se ha realizado correctamente.
{ "total" : 1, "items" : [ { "id" : "41cba8aee2e94bcdbf57460874205494", "name" : "policy_2FHwFOKz", "level" : 2, "action" : { "category" : "log", "modulex_category" : "log" }, "options" : { "webattack" : true, "common" : true, "crawler" : true, "crawler_engine" : false, "crawler_scanner" : true, "crawler_script" : false, "crawler_other" : false, "webshell" : false, "cc" : true, "custom" : true, "precise" : false, "whiteblackip" : true, "geoip" : true, "ignore" : true, "privacy" : true, "antitamper" : true, "anticrawler" : false, "antileakage" : false, "followed_action" : false, "bot_enable" : true, "modulex_enabled" : false }, "hosts" : [ ], "extend" : { }, "timestamp" : 1650527546218, "full_detection" : false, "bind_host" : [ ] } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
La solicitud se ha realizado correctamente. |
400 |
Error de solicitud. |
401 |
Permisos de token insuficientes. |
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.