Consulta de nombres de dominio protegidos por motores WAF dedicados
Función
Esta API se utiliza para consultar la lista de nombres de dominio conectados a instancias de WAF dedicadas.
URI
GET /v1/{project_id}/premium-waf/host
|
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 |
String |
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 |
String |
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 |
|
hostname |
No |
String |
Nombre de dominio |
|
policyname |
No |
String |
Nombre de la política. |
|
protect_status |
No |
Integer |
Estado de protección del nombre de dominio. \n - -1: Se omite la protección WAF. Las solicitudes del nombre de dominio se envían directamente al servidor backend y no pasan a través de WAF. \n - 0: La protección WAF está suspendida. WAF solo reenvía solicitudes del nombre de dominio y no detecta ataques. \n - 1: La protección WAF está habilitada. WAF detecta ataques basados en la política configurada. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
Content-Type |
Sí |
String |
Tipo de contenido Predeterminado: application/json;charset=utf8 |
|
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). |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
total |
Integer |
Número total de nombres de dominio protegidos |
|
items |
Array of SimplePremiumWafHost objects |
Detalles sobre el nombre de dominio protegido |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID de nombre de dominio |
|
hostname |
String |
Nombre de dominio |
|
policyid |
String |
ID de política |
|
protect_status |
Integer |
Estado de protección del nombre de dominio. \n - -1: Se omite la protección WAF. Las solicitudes del nombre de dominio se envían directamente al servidor backend y no pasan a través de WAF. \n - 0: La protección WAF está suspendida. WAF solo reenvía solicitudes del nombre de dominio y no detecta ataques. \n - 1: La protección WAF está habilitada. WAF detecta ataques basados en la política configurada. |
|
access_status |
Integer |
Estado de acceso |
|
flag |
Map<String,String> |
Identificador especial |
|
mode |
String |
Identificador del motor WAF dedicado en modo WAF especial, como ELB. |
|
pool_ids |
Array of strings |
Clúster de motor dedicado al que pertenece el nombre de dominio |
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}/premium-waf/host?enterprise_project_id=0
Ejemplo de respuestas
Código de estado: 200
OK
{
"total" : 1,
"items" : [ {
"id" : "ee896796e1a84f3f85865ae0853d8974",
"hostname" : "www.demo.com",
"extend" : { },
"region" : "cn-north-7",
"flag" : {
"pci_3ds" : "false",
"pci_dss" : "false"
},
"description" : "",
"policyid" : "df15d0eb84194950a8fdc615b6c012dc",
"protect_status" : 1,
"access_status" : 0,
"hostid" : "ee896796e1a84f3f85865ae0853d8974"
} ]
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
OK |
|
400 |
Solicitud no válida. |
|
401 |
Permisos de token insuficientes. |
|
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.