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 dos itens avaliados

Quando necessário, o JSON de retorno dos serviços de descoberta deverão possuir uma lista com a estrutura de informações dos itens que foram avaliados pelo TOTVS Discovery.

Esta estrutura deve seguir conforme descrito abaixo:

AtributoTipoDescriçãoObrigatório?Valores
codeStringCódigo/Chave do item avaliado.Sim
messageStringBreve descrição do item avaliado.Sim
detailStringDetalhes do item avaliado.Não
statusBooleanSituação do item avaliado.Sim
  • true: verdadeiro se o item avaliado não apresentou inconformidades
  • false: falso se o item avaliado apresentou inconformidades

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.

...

GET /discovery/v1/resources/{id}?category=[category]

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. Este método permite receber via PathParam o id do recurso que deseja-se retornar, caso não informado este id, serão retornados todos os recursos descobertos. É possível também filtrar pela categoria dos recursos, se informado o filtro category via QueryParam, o serviço deverá filtrar os recursos descobertos retornando apenas os recursos da categoria filtrada.

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
infoArrayEstrutura com as informações dos itens avaliados.Não
healthArrayEstrutura com as informações de saúde do nó descoberto.Não

...