Consultar la lista de nombres de dominio protegidos con Cloud WAF
Función
Esta API se utiliza para consultar la lista de nombres de dominio protegidos con el WAF en la nube.
URI
GET /v1/{project_id}/waf/instance
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 |
hostname |
No |
String |
Nombre de dominio |
policyname |
No |
String |
Nombre de la política |
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 nombres de dominio protegidos con la instancia WAF en la nube |
items |
Array of CloudWafHostItem objects |
Detalles sobre el nombre de dominio protegido |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de nombre de dominio |
hostid |
String |
ID de nombre de dominio |
description |
String |
Descripción. |
type |
Integer |
Modo de implementación WAF |
proxy |
Boolean |
Si el proxy está habilitado |
flag |
Flag object |
Certificaciones soportadas por WAF |
hostname |
String |
Nombre de dominio agregado a la nube WAF. |
access_code |
String |
Prefijo de CNAME |
policyid |
String |
ID de política |
timestamp |
Long |
Hora en que se agrega un nombre de dominio a WAF. |
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 |
exclusive_ip |
Boolean |
Si se utiliza una dirección IP dedicada |
paid_type |
String |
Forma de pago. Actualmente, solo se admite el método de prepago. Valores de enumeración:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
pci_3ds |
String |
true: Se aprueba la certificación estándar PCI 3DS. false: no se aprueba la certificación estándar PCI 3DS. Valores de enumeración:
|
pci_dss |
String |
true: Se aprueba la certificación estándar PCI DSS. false: no se aprueba la certificación estándar PCI DSS. Valores de enumeración:
|
cname |
String |
old: Se utiliza el antiguo registro CNAME. new: se utiliza un nuevo registro CNAME. Valores de enumeración:
|
is_dual_az |
String |
true: WAF soporta multi-AZ DR. false: WAF no admite DR multi-AZ. Valores de enumeración:
|
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/instance?enterprise_project_id=0
Ejemplo de respuestas
Código de estado: 200
OK
{ "total" : 1, "items" : [ { "id" : "d0a4bc2f74e3407388a50243af700305", "hostid" : "d0a4bc2f74e3407388a50243af700305", "description" : "e", "type" : 1, "proxy" : false, "flag" : { "pci_3ds" : "false", "pci_dss" : "false", "ipv6" : "false", "cname" : "new", "is_dual_az" : "true" }, "region" : "cn-north-7", "hostname" : "www.demo.com", "access_code" : "7d06456ffaexxxxxxxxxxx281bc13b", "policyid" : "bb2124fabe6f42ff9fe4770eeccb2670", "timestamp" : 1642648030687, "protect_status" : 1, "access_status" : 0, "exclusive_ip" : false, "web_tag" : "iii", "paid_type" : "prePaid" } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Error de solicitud. |
401 |
Permisos de token insuficientes. |
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.