Consulta de la lista de certificados
Función
Esta API se utiliza para consultar la lista de certificados.
URI
GET /v1/{project_id}/waf/certificate
| 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 del certificado |
| host | No | Boolean | Si se desea obtener el nombre de dominio para el que se utiliza el certificado. El valor predeterminado es false. \n -true: Obtener los certificados que se han utilizado para los nombres de dominio. \n -false: obtenga los certificados que no se utilizan para ningún nombre de dominio. Predeterminado: false |
| exp_status | No | Integer | Estado del certificado. Las opciones son 0, 1 y 2. 0: El certificado es válido. 1: El certificado ha caducado; 2: El certificado caducará en el plazo de un mes. |
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 |
|---|---|---|
| items | Array of CertificateBody objects | Certificados |
| total | Integer | Número total de certificados |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de certificado |
| name | String | Nombre del certificado |
| content | String | Archivo de certificado, que está en formato PEM. |
| key | String | Clave privada del certificado, que está en formato PEM. |
| expire_time | Long | Marca de tiempo de caducidad del certificado. |
| exp_status | Integer | Estado del certificado. Las opciones son 0, 1 y 2. 0: El certificado es válido. 1: El certificado ha caducado; 2: El certificado caducará en el plazo de un mes. |
| timestamp | Long | Marca de tiempo de carga de certificado. |
| bind_host | Array of BindHost objects | Nombre de dominio asociado al certificado |
| 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/certificate?enterprise_project_id=0 Ejemplo de respuestas
Código de estado: 200
OK
{
"total" : 1,
"items" : [ {
"id" : "dc443ca4f29c4f7e8d4adaf485be317b",
"name" : "demo",
"timestamp" : 1643181401751,
"expire_time" : 1650794100000,
"bind_host" : [ ],
"exp_status" : 2
} ]
} 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.
