...

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

Estrutura com informações dos

...

Quando necessário, o JSON de retorno deverá possuir uma lista com a estrutura de informações dos nós filhos para o nó descoberto pelo TOTVS Discovery.

Esta estrutura deve seguir conforme descrito abaixo:

...

itens avaliados

Âncora
info

...

info

...

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.

...

Estrutura com informações de saúde

Âncora
health

...

health

...

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.

...

Serviços

Serviço

...

público de busca dos ambientes disponíveis

GET /discovery/v1/resources/{host}/{port}/{category}environments/{name}?category=[category]

Retorna os ambientes disponíveis.

Permite receber via PathParam o nome do ambiente 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 host, port, category e name do recurso que deseja-se retornarfiltrar, caso não informado estes parâmetroseste parâmetro, 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.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:

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",
		"name": "PROTHEUS_V12_PROD",
		"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"
			}]
		}],
		"children": [{
			"host": "10.1.1.1",
			"port": 5555,
			"name": "DBACCESS",
			"category": "server|machine|database|lsv|gateway"

		}]
	}]
}