Páginas filhas
  • TOTVS Discovery

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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:

AtributoTipoDescriçãoObrigatório?Valores
nameStringNome do ambiente.Sim

Exemplo JSON de retorno

Bloco de código
languagejs
{
	"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 (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:

AtributoTipoDescriçãoObrigatório?Valores
nameStringNome do ambiente.Sim
hostStringIP ou domínio do recurso.Sim
portNumberPorta do recurso.Não
categoryStringCategoria 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)
dateStringData de descoberta do recurso (no formato yyyy-mm-ddThh:mm:ss.nnnnnn+|-hh:mm).Sim
healthStringIndicador de saúde do recurso.NãoHealth:type
infoArrayLista com a estrutura com as informações dos itens avaliados.NãoInfo

Exemplo JSON de retorno

Bloco de código
languagejs
{
	"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"
			}]
		}]
	}]
}

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

GET /discovery/v1/config

Retorna as configurações atuais do TOTVS Discovery.

PUT /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:

AtributoTipoDescriçãoObrigatório?Valores
monitorPausedBooleanIndicador se o serviço de monitoramento está ou não pausado.Sim
historyDaysNumberQuantidade de dias para manter o histórico das informações de monitoramento.SimPadrão 30 dias
monitorIntervalNumberIntervalo em minutos do ciclo de monitoramento.SimPadrão 15 minutos

Exemplo JSON de retorno e atualização

Bloco de código
languagejs
{
	"monitorPaused": true|false,
	"historyDay": 30,
	"monitorInterval": 15
}