Situação da API
Este artigo tem a finalidade de documentar a verificação da situação da API utilizando o actuator healt.
Consultar situação da API
Método para verificar a integridade ou estado da API em execução. Geralmente é exercido pelo software de monitoramento para nos alertar se a instância em execução cair ou ficar insalubre por outros motivos, por exemplo, problemas de conectividade com nosso banco de dados, falta de espaço em disco, etc..
| Requisição | |
| Método | GET |
| URL | /api/actuator/health |
| Estrutura de dados da resposta | ||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
| status | String | 20 | Sim |
Status da API UP DOWN OUT_OF_SERVICE UNKNOWN |
Lista de status retornados da API
Exemplo de resposta
{
"status": "UP"
}