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:

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 retornada pelo TOTVS Discovery.

Esta estrutura deve seguir conforme descrito abaixo:

Serviços

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

GET /discovery/v1/environments/{name}

Retorna os ambientes disponíveis.

Parâmetros

PATH PARAM [name] Nome do ambiente que deseja-se filtrar ou nulo para trazer todos os ambientes

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

Exemplo JSON de retorno

{
	"total": 2,
	"hasNext": false,
	"items": [{
		"name": "PRODUCAO"
	},{
		"name": "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 (obrigatório)

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": "PRODUCAO",
		"host": "10.1.1.1",
		"port": 1234,
		"category": "server|machine|database|lsv|gateway",
		"date": "yyyy-mm-ddThh:mm:ss.nnnnnn+|-hh:mm",
		"status": "success|warning|error|danger",
		"info": [{
			"code": "cpu",
			"title": "CPU",
			"detail": "Central Processing Unit",
			"value": "90",
			"health": [{
				"status": "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"
			}, {
				"status": "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"
			}]
		}]
	}]
}

Serviço restrito de busca e atualização de configuração

GET /discovery/v1/config

Retorna as configurações atuais do TOTVS Discovery.

POST /discovery/v1/config

Atualiza as configurações atuais do TOTVS Discovery.

O JSON de retorno da busca e de atualização deverão possuir a mesma estrutura abaixo:

Exemplo JSON de retorno e atualização

{
	"monitorPaused": true|false,
	"historyDay": 30,
	"monitorInterval": 15
}