Mudanças entre as edições de "BlueMonitorAPI"
De MSTECH wiki
(→CategoriesTree) |
(→Inventory) |
||
(19 revisões intermediárias por 2 usuários não estão sendo mostradas) | |||
Linha 8: | Linha 8: | ||
== Devices == | == Devices == | ||
− | + | '''[[BMAPI POST api/v1/devices|POST api/v1/devices]]''' | |
− | + | Cadastra uma máquina no BlueMonitor | |
== Devices Signals == | == Devices Signals == | ||
+ | '''[[BMAPI POST api/v1/devices/(k4Chave)/signals|POST api/v1/devices/{k4Chave}/signals]]''' | ||
+ | Registra a atualização do sinal da máquina, indicando que a mesma está ligada | ||
+ | == Devices TurnOff == | ||
+ | '''[[BMAPI GET api/v1/devices/(k4Chave)/turnoff|GET api/v1/devices/{k4Chave}/turnoff]]''' | ||
+ | Retorna se a máquina deve desligar | ||
+ | '''[[BMAPI POST api/v1/devices/(k4Chave)/turnoff|POST api/v1/devices/{k4Chave}/turnoff]]''' | ||
+ | Registra que a máquina está desligando | ||
== Devices Updates == | == Devices Updates == | ||
− | + | '''[[BMAPI GET api/v1/devices/(k4Chave)/updates|GET api/v1/devices/{k4Chave}/updates]]''' | |
− | + | Retorna os updates associados à máquina | |
== Devices Updates Status == | == Devices Updates Status == | ||
+ | '''[[BMAPI POST api/v1/devices/(k4Chave)/updates/(updateId)/status|POST api/v1/devices/{k4Chave}/updates/{updateId}/status]]''' | ||
+ | Cadastra um novo status de atualização entre um update e uma máquina | ||
+ | '''[[BMAPI PUT api/v1/devices/(k4Chave)/updates/(updateId)/status/(id)|PUT api/v1/devices/{k4Chave}/updates/{updateId}/status/{id}]]''' | ||
+ | Atualiza um status de atualização entre um update e uma máquina | ||
+ | == CIE Updates == | ||
+ | '''[[BMAPI GET api/v1/administrativeunit/(cie)/(type?)/(id:int?)|GET api/v1/administrativeunit/{cie}/{type?}/{id:int?}]]''' | ||
+ | Retorna os updates associados à uma CIE, com um tipo de dispositivo específico opcional. | ||
== Devices Types == | == Devices Types == | ||
+ | '''[[BMAPI GET api/v1/deviceTypes|GET api/v1/deviceTypes]]''' | ||
+ | Retorna os Tipos de máquinas | ||
+ | |||
+ | == Domains Categories == | ||
+ | '''[[BMAPI GET api/v1/domains/(k1Chave)/categories|GET api/v1/domains/{k1Chave}/categories]]''' | ||
+ | Retorna as categorias do domínio. | ||
+ | |||
+ | == Domains Categories AdministrativeUnits== | ||
+ | '''[[BMAPI GET api/v1/domains/(k1Chave)/categories/(categoriesId)/administrativeUnit|GET api/v1/domains/{k1Chave}/categories/{categoriesId}/administrativeUnit]]''' | ||
+ | Retorna as Unidades Administrativas que estão associadas à uma categoria do domínio. | ||
+ | |||
+ | == Device Image Protection == | ||
+ | '''[[BMAPI GET api/v1/ImageProtection/(k4)|GET api/v1/ImageProtection/{k4}]]''' | ||
+ | Retorna dados sobre a proteção do update para uma máquina específica. | ||
+ | |||
+ | '''[[BMAPI POST api/v1/ImageProtection|POST api/v1/ImageProtection]]''' | ||
+ | Cria um novo registro referente a proteção de update de um dispositivo. | ||
+ | |||
+ | '''[[BMAPI PUT api/v1/ImageProtection|PUT api/v1/ImageProtection]]''' | ||
+ | Atualiza um registro referente a proteção de update de um dispositivo. | ||
+ | |||
+ | == Inventory == | ||
+ | |||
+ | === Ambientes === | ||
+ | Configuração: Tabela ''PARAMETRO'' do BlueMonitor | ||
+ | ==== Teste (bluemonitor-teste.devedu.ms) ==== | ||
+ | http://192.168.44.11:9200 | ||
+ | '''Btracker:''' /bluemonitorteste/report | ||
+ | '''Inventário software:''' inventorysoftwareteste | ||
+ | '''Inventário hardware:''' inventoryhardwareteste | ||
+ | |||
+ | ==== Desenvolvimento ==== | ||
+ | http://192.168.44.11:9200 | ||
+ | '''Btracker:''' /bluemonitor/report | ||
+ | '''Inventário software:''' inventorysoftware | ||
+ | '''Inventário hardware:''' inventoryhardware | ||
+ | |||
+ | ==== Demo ==== | ||
+ | http://demo-kibana.mstech.com.br | ||
+ | http://demo-logstash.mstech.com.br | ||
+ | http://demo-elasticsearch.mstech.com.br | ||
+ | '''Btracker:''' /bluemonitordemo/report | ||
+ | '''Inventário software:''' inventorysoftwaredemo | ||
+ | '''Inventário hardware:''' inventoryhardwaredemo | ||
+ | |||
+ | ==== Chamadas API ==== | ||
+ | '''[[BMAPI POST api/v1/inventoryhardware/|POST api/v1/inventoryhardware/]]''' | ||
+ | Envia um inventário para o ElasticSearch através do BlueMonitor. | ||
+ | |||
+ | '''[[BMAPI POST api/v1/inventorysoftware/|POST api/v1/inventorysoftware/]]''' | ||
+ | Envia um inventário para o ElasticSearch através do BlueMonitor. |
Edição atual tal como às 14h39min de 21 de novembro de 2017
Índice
CategoriesTree
GET api/v1/categoriesTree/{k1Chave} Retorna uma arvore com todas as categorias e unidades administrativas que compõe toda a estrutura de localizações do domínio.
Devices
POST api/v1/devices Cadastra uma máquina no BlueMonitor
Devices Signals
POST api/v1/devices/{k4Chave}/signals Registra a atualização do sinal da máquina, indicando que a mesma está ligada
Devices TurnOff
GET api/v1/devices/{k4Chave}/turnoff Retorna se a máquina deve desligar
POST api/v1/devices/{k4Chave}/turnoff Registra que a máquina está desligando
Devices Updates
GET api/v1/devices/{k4Chave}/updates Retorna os updates associados à máquina
Devices Updates Status
POST api/v1/devices/{k4Chave}/updates/{updateId}/status Cadastra um novo status de atualização entre um update e uma máquina
PUT api/v1/devices/{k4Chave}/updates/{updateId}/status/{id} Atualiza um status de atualização entre um update e uma máquina
CIE Updates
GET api/v1/administrativeunit/{cie}/{type?}/{id:int?} Retorna os updates associados à uma CIE, com um tipo de dispositivo específico opcional.
Devices Types
GET api/v1/deviceTypes Retorna os Tipos de máquinas
Domains Categories
GET api/v1/domains/{k1Chave}/categories Retorna as categorias do domínio.
Domains Categories AdministrativeUnits
GET api/v1/domains/{k1Chave}/categories/{categoriesId}/administrativeUnit Retorna as Unidades Administrativas que estão associadas à uma categoria do domínio.
Device Image Protection
GET api/v1/ImageProtection/{k4} Retorna dados sobre a proteção do update para uma máquina específica.
POST api/v1/ImageProtection Cria um novo registro referente a proteção de update de um dispositivo.
PUT api/v1/ImageProtection Atualiza um registro referente a proteção de update de um dispositivo.
Inventory
Ambientes
Configuração: Tabela PARAMETRO do BlueMonitor
Teste (bluemonitor-teste.devedu.ms)
http://192.168.44.11:9200 Btracker: /bluemonitorteste/report Inventário software: inventorysoftwareteste Inventário hardware: inventoryhardwareteste
Desenvolvimento
http://192.168.44.11:9200 Btracker: /bluemonitor/report Inventário software: inventorysoftware Inventário hardware: inventoryhardware
Demo
http://demo-kibana.mstech.com.br http://demo-logstash.mstech.com.br http://demo-elasticsearch.mstech.com.br Btracker: /bluemonitordemo/report Inventário software: inventorysoftwaredemo Inventário hardware: inventoryhardwaredemo
Chamadas API
POST api/v1/inventoryhardware/ Envia um inventário para o ElasticSearch através do BlueMonitor.
POST api/v1/inventorysoftware/ Envia um inventário para o ElasticSearch através do BlueMonitor.