Páginas filhas
  • TOTVS Discovery

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Definições Gerais

Estrutura com informações de saúde

Quando necessário, o JSON de retorno de qualquer um dos serviços descritos neste documento deverá possuir uma lista com a estrutura de informações de saúde da informação retornada. Esta estrutura deve seguir conforme descrito abaixo:

AtributoTipoDescriçãoObrigatório?Valores
typeStringTipo da informação da situação encontrada.Sim
  • sucess: Sucesso (OK)
  • warning: Alerta/Aviso
  • error: Erro | Com contorno
  • danger: Erro Fatal/Sem contorno
messageStringBreve mensagem sobre a situação encontrada.Sim
detailStringDetalhes sobre a situação encontrada.Não
helpUrlStringPágina de ajuda sobre a situação encontrada.Não

Serviços

Serviço de descoberta de recursos (nós) aptos para avalição através do TOTVS Discovery.

GET /discovery/v1/resources

O método GET /discovery/v1/resources é utilizado para a descoberta dos recursos (nós) que serão exibidos no Dashboard do TOTVS Discovery para avaliação de performance e saúde de cada um destes.

No JSON de retorno, no atributo items, deve constar as seguintes informações:

AtributoTipoDescriçãoObrigatório?Valores
idStringID do nó descoberto.Sim
categoryStringCategoria do nó descoberto.Sim
  • server: Servidor de Aplicação
  • machine: ???
  • database: Banco de Dados
  • lsv: Servidor de Licenças
  • gateway: ???
hostStringIP ou domínio do nó descoberto.Sim
portNumericPorta do nó descoberto.Sim
healthArrayEstrutura com as informações de saúde do nó descoberto.Sim

Exemplo JSON de retorno

Bloco de código
languagejs