Consulta de la lista de nombres de dominio protegidos
Función
Esta API se utiliza para consultar la lista de nombres de dominio protegidos de una cuenta.
URI
GET /v1/{project_id}/composite-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 | 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 personalizable para un dominio |
| policyname | No | String | 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. |
| waf_type | No | String | Modo WAF del nombre de dominio |
| is_https | No | Boolean | Si se utiliza HTTPS para el nombre de dominio |
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 nombres de dominio protegidos. |
| cloud_total | Integer | Número de nombres de dominio en modo de cloud |
| premium_total | Integer | Número de nombres de dominio en modo dedicado |
| items | Array of CompositeHostResponse objects | Detalles sobre los nombres de dominio |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de nombre de dominio |
| hostname | String | Nombre de dominio agregado a la nube WAF. |
| policyid | String | ID de política |
| access_code | String | Prefijo de CNAME |
| 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 |
| proxy | Boolean | Si el proxy está habilitado. |
| timestamp | Long | Hora en que se agrega un nombre de dominio a WAF. |
| paid_type | String | Modo de pago basado en paquetes. Actualmente, solo se admite el método de prepago. |
| flag | HostFlag object | Configuración del nombre de dominio |
| waf_type | String | Modo de WAF que se utiliza para proteger el nombre de dominio. El valor puede ser cloud o premium. cloud: El WAF cloud se utiliza para proteger el dominio.premium: se utiliza una instancia WAF dedicada para proteger el nombre de dominio. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| pci_dss | String | Verdadero/Falso |
| pci_3ds | String | Verdadero/Falso |
| cname | String | antiguo/nuevo |
| is_dual_az | String | Verdadero/Falso |
| ipv6 | String | Verdadero/Falso |
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
POST https://{Endpoint}/v1/{project_id}/composite-waf/host?enterprise_project_id=0 Ejemplo de respuestas
Código de estado: 200
OK
{
"items" : [ {
"id" : "31af669f567246c289771694f2112289",
"hostid" : "31af669f567246c289771694f2112289",
"description" : "",
"type" : 1,
"proxy" : false,
"flag" : {
"pci_3ds" : "false",
"pci_dss" : "false",
"ipv6" : "false",
"cname" : "new",
"is_dual_az" : "true"
},
"region" : "cn-north-4",
"hostname" : "www.demo.com",
"access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
"policyid" : "41cba8aee2e94bcdbf57460874205494",
"timestamp" : 1650527546454,
"protect_status" : 0,
"access_status" : 0,
"exclusive_ip" : false,
"web_tag" : "",
"paid_type" : "prePaid",
"waf_type" : "cloud",
"bandwidth" : 0,
"qps" : 0
} ],
"total" : 1,
"cloud_total" : 1,
"cloud_domain_total" : 1,
"premium_total" : 0
} 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.
