Objetivo

Definições Gerais

Os serviços e padrões descritos abaixo foram definidos conforme o Guia de implementação das APIs TOTVS.

Estrutura com informações dos itens avaliados

Quando necessário, o JSON de retorno deverá 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
`title`	`String`	Título do item avaliado.	Sim
`detail`	`String`	Detalhe do item avaliado.	Não
`value`	`String`	Valor do item avaliado.	Sim
`health`	`Array`	Lista com a estrutura com as informações de saúde do nó descoberto.	Não	Health

Estrutura com informações de saúde

Quando necessário, o JSON de retorno de deverá possuir uma lista com a estrutura de informações de saúde da informação retornada pelo TOTVS Discovery.

Esta estrutura deve seguir conforme descrito abaixo:

Atributo	Tipo	Descrição	Obrigatório?	Valores
`type`	`String`	Tipo da informação da situação encontrada.	Sim	sucess: sucesso warning: alerta error: erro não fatal danger: erro fatal
`message`	`String`	Breve mensagem sobre a situação encontrada.	Sim
`detail`	`String`	Detalhes sobre a situação encontrada.	Não
`helpUrl`	`String`	Página de ajuda sobre a situação encontrada.	Não

Serviços

Serviço público de busca dos ambientes disponíveis

GET /discovery/v1/environments/{name}

Retorna os ambientes disponíveis.

Permite receber via PathParam o nome do ambiente que deseja-se filtrar, caso não informado este parâmetro, serão retornados todos os ambientes.

Exemplo JSON de retorno

{
	"total": 2,
	"hasNext": false,
	"items": [{
		"name": "PROTHEUS-V12-PRODUCAO",
		"name": "PROTHEUS-V12-HOMOLOGACAO"
	}]
}

Serviço restrito de busca dos recursos de determinado ambiente

GET /discovery/v1/resources/{name}/[host]/[category]?info=[true|false]

Retorna os recursos dispoíveis de determinado ambiente.

Parâmetros

PATH PARAM {name} Nome do ambiente do qual deseja-se retornar os recursos disponíveis

PATH PARAM [host] IP ou domínio do recurso do ambiente selecionado

PATH PARAM [category] Categoria do recurso do ambiente selecionado

QUERY PARAM [info] Indicador se deverá ser retornado no JSON as informações avaliadas pelo TOTVS Discovery

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

Atributo	Tipo	Descrição	Obrigatório?	Valores
`name`	`String`	Nome do ambiente.	Sim
`host`	`String`	IP ou domínio do recurso.	Sim
`port`	`Numeric`	Porta do recurso.	Não
`category`	`String`	Categoria do recurso.	Sim	server: Servidor de Aplicação (ambiente) machine: Servidor Físico database: Banco de Dados lsv: Servidor de Licenças gateway: Outros recursos (DBAccess)
`date`	`String`	Data de descoberta do recurso (no formato yyyy-mm-ddThh:mm:ss.nnnnnn+\|-hh:mm).	Sim
`health`	`String`	Indicador de saúde do recurso.	Não	Health:type
`info`	`Array`	Lista com a estrutura com as informações dos itens avaliados.	Não	`Info`

Exemplo JSON de retorno

{
	"total": 2,
	"hasNext": false,
	"items": [{
		"name": "PROTHEUS-V12-PRODUCAO",
		"host": "10.1.1.1",
		"port": 1234,
		"category": "server|machine|database|lsv|gateway",
		"date": "yyyy-mm-ddThh:mm:ss.nnnnnn+|-hh:mm",
		"health": "success|warning|error|danger",
		"info": [{
			"code": "cpu",
			"title": "CPU",
			"detail": "Central Processing Unit",
			"value": "90",
			"health": [{
				"type": "success|warning|error|danger",
				"message": "Consumo de CPU em 80%",
				"details": "O alto consumo da CPU do servidor prejudica o desempenho do sistema",
				"helpUrl": "http://www.tdn.totvs.com.br"
			}, {
				"type": "success|warning|error|danger",
				"message": "Memória disponível no servidor abaixo da recomendada",
				"details": "O recomendado para o uso do TOTVS Microsiga Protheus é de no mínimo 8gb de RAM",
				"helpUrl": "http://www.tdn.totvs.com.br"
			}]
		}]
	}]
}