Histórico da Página
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:
Atributo | Tipo | Descrição | Obrigatório? | Valores |
---|---|---|---|---|
code | String | Código/Chave do item avaliado. | Sim | |
message | String | Breve descrição do item avaliado. | Sim | |
detail | String | Detalhes do item avaliado. | Não | |
status | Boolean | Situação do item avaliado. | Sim |
|
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:
Atributo | Tipo | Descrição | Obrigatório? | Valores |
---|---|---|---|---|
id | String | ID do nó descoberto. | Sim | |
category | String | Categoria do nó descoberto. | Sim |
|
host | String | IP ou domínio do nó descoberto. | Sim | |
port | Numeric | Porta do nó descoberto. | Sim | |
info | Array | Estrutura com as informações dos itens avaliados. | Não | |
health | Array | Estrutura com as informações de saúde do nó descoberto. | Não |
...