Skip to content

REST API Monitor

Jump to bottomEditNew page
grabarczyk-t edited this page Jun 2, 2014 · 10 revisions
idzasóbopis
[[RST_MT_MSLREST-API-Monitor#rst_mt_msl]]GET measurements
[[RST_MT_CMSOREST-API-Monitor#rst_mt_cmso]]GET complex/types
[[RST_MT_CMSAREST-API-Monitor#rst_mt_cmsa]]POST measurements
[[RST_MT_MSGREST-API-Monitor#rst_mt_msg]]GET measurements/{id}
[[RST_MT_MSVLREST-API-Monitor#rst_mt_msvl]]GET measurements/{id}/data
[[RST_MT_CPLXREST-API-Monitor#rst_mt_cplx]]GET complex/{id}
[[RST_MT_CMSDREST-API-Monitor#rst_mt_cmsd]]DELETE measurements/{id}
[[RST_MT_RSLREST-API-Monitor#rst_mt_rsl]]GET resources

RST_MT_MSL

Pobranie listy aktualnych pomiarów na danym monitorze.

######Zasób URL GET measurements

######Parametry

  1. resource - nazwa zasobu po którym chcemy filtrować
  2. metric - nazwa metryki po której chcemy filtrować

######Linki

  • self - uri danego pomiaru
  • data - uri do danych danego pomiaru
  • addComplex - adres pod którym można dodać pomiar złożony na podstawie danego pomiaru
    • pojawia się wyłącznie jeśli użytkownik jest zalogowany
  • delete - adres po którym można usunąć dany pomiar
    • pojawia się wyłącznie jeśli dany pomiar jest pomiarem złożonym i został stworzony przez obecnie zalogowanego użytkownika
  • complexDetails - adres pod którym są szczegółowe informacje o pomiarze złożonym
    • pojawia się wyłącznie jeśli dany pomiar jest pomiarem złożonym

######Autoryzacja

  • Dostępny dla wszystkich
  • Niektóre opcje niedostępne dla niezalogowanych użytkowników - patrz Linki.

######Przykład Odpowiedz serwera:

{
"_embedded" : {
"measurements" : [ {
"resource" : "zeus_1F",
"metric" : "cpuUsage",
"unit": "%",
"_links" : {
"self" : {
"href" : "http://monitor1/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08"
},
"data" : {
"href" : "http://monitor1/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08/data"
}
}
}, {
"resource" : "atena_2F",
"metric" : "memUsage",
"unit": "%",
"_links" : {
"self" : {
"href" : "http://monitor1/measurements/bffb94a2-2152-4559-992e-f9348da19619"
},
"data" : {
"href" : "http://monitor1/measurements/bffb94a2-2152-4559-992e-f9348da19619/data"
}
}
} ]
}
}

######Przykład z filtrowaniem

Adres URL: measurements?metric=cpuUsage

{
"_embedded": {
"measurements": [
{
"resource": "atena_2F",
"metric": "cpuUsage",
"_links": {
"self": {
"href": "http://127.0.0.1:8081/measurements/359a2051-ab94-40f6-b89a-f4ffec4da2a7"
}
}
},
{
"resource": "zeus_1F",
"metric": "cpuUsage",
"_links": {
"self": {
"href": "http://127.0.0.1:8081/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08"
}
}
}
]
}
}

RST_MT_CMSO

Pobranie typów pomiarów złożonych

Zwraca listę możliwych typów pomiarów złożonych. Struktura zawiera parametry pomiarów, proponowaną nazwę oraz informację czy parametr jest wymagany

######Zasób URL GET complex/types

######Autoryzacja Wymaga zalogowania jako użytkownik

######Przykład Wiadomość:

{
"_embedded":
{
"typeList":
[
{
"typeName" : "Średnia ruchoma",
"typeCode" : "move_avg",
"params":
[
{
"paramName":"Szerokosc okna",
"paramCode":"windowsPeriod",
"required": true
},
{
"paramName":"Interwal",
"paramCode":"interval",
"required": true
}
]
}
]
}
}

RST_MT_CMSA

Dodawanie nowego pomiaru złozonego

Akceptowalne typy pomiarów złożonych:

  1. Średnia ruchoma [move_avg]. Parametry :

    • time_window: szerokość okna - z ilu sekund mają być brane pomiary pod uwagę
    • interval: czas wyliczania średniej - co ile sekund ma być wyliczana średnia

  2. Threshold [thresh]. Parametry :

    • thresh_value: wartość progu

######Zasób URL POST measurements

######Autoryzacja Wymaga zalogowania jako użytkownik

######Przykład Wiadomość:

{
"baseMeasurementUri":"http://127.0.0.1:8081/measurements/359a2051-ab94-40f6-b89a-f4ffec4da2a7",
"type" : "move_avg",
"params": [
{
"paramCode":"time_window",
"value": 10
},
{
"paramCode":"interval",
"value": 5
}
]
}

RST_MT_CPLX

Pobranie informacji o pomiarze złożonym

######Zasób URL GET /complex/{id}

######Linki

  • self - uri do szczegółów danego pomiaru złożonego
  • measurementDetails - uri do szczegółów pomiaru podstawowego tego pomiaru złożonego
  • baseMeasurement - uri do szczegółów pomiaru podstawowego, na którym opiera się dany pomiar złożony

######Autoryzacja Nie wymaga autoryzacji

######Przykład Wiadomość:

{
"type" : "move_avg",
"params": [
{
"paramCode":"windowsPeriod",
"value": 10
},
{
"paramCode":"interval",
"value": 5
}
],
"_links": {
"self": {
"href": "http://monitor1/complex/c40fac9f-8c96-4476-b435-aa52e4b17e08"
},
"measurementDetails": {
"href": "http://monitor1/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08"
},
"baseMeasurement": {
"href": "http://monitor1/measurements/359a2051-ab94-40f6-b89a-f4ffec4da2a7"
}
}
}

RST_MT_CMSD

usuwanie złożonego pomiaru

######Zasób URL DELETE measurements/{id}

######Autoryzacja Wymaga zalogowania jako użytkownik

RST_MT_MSG

Pobranie pomiaru na danym monitorze.

######Zasób URL GET measurements/{id}

######Linki

  • self - uri danego pomiaru
  • data - uri do danych danego pomiaru
  • addComplex - adres pod którym można dodać pomiar złożony na podstawie danego pomiaru
    • pojawia się wyłącznie jeśli użytkownik jest zalogowany
  • delete - adres po którym można usunąć dany pomiar
    • pojawia się wyłącznie jeśli dany pomiar jest pomiarem złożonym i został stworzony przez obecnie zalogowanego użytkownika
  • complexDetails - adres pod którym są szczegółowe informacje o pomiarze złożonym
    • pojawia się wyłącznie jeśli dany pomiar jest pomiarem złożonym

######Autoryzacja

  • Dostępny dla wszystkich
  • Niektóre opcje niedostępne dla niezalogowanych użytkowników - patrz Linki.

######Przykład Odpowiedz serwera:

{
"resource": "zeus_1F",
"metric": "cpuUsage",
"unit": "%",
"_links": {
"self": {
"href": "http://monitor1/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08"
},
"data": {
"href": "http://monitor1/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08/data"
}
}
}

RST_MT_MSVL

Pobranie danych do wykresu dla pomiaru o okreslonym Id

######Zasób URL GET measurements/{id}/data

######Autoryzacja Dostępny dla wszystkich

######Parametry

  1. limit - określa czy ograniczyć dane do jednego rekordu. Możliwe wartości:
    • all - wszystkie wartości [ domyślny parametr ]
    • last - ostatnie X wartości
    • since - wartości z ostatnich X sekund
  2. value - wartość parametru dla limitu

######Przykład Adres URL: GET measurements/f621a2b0-b76b-11e3-a5e2-0800200c9a62/data?limit=all

Odpowiedz serwera:

{
"_embedded": {
"data": [
{
"timestamp": 1398071005,
"data": 30
},
{
"timestamp": 1398072005,
"data": 76
},
{
"timestamp": 1398075305,
"data": 34
}
]
}
}

Adres URL: GET measurements/f621a2b0-b76b-11e3-a5e2-0800200c9a66/data?limit=last

Odpowiedz serwera:

{
"_embedded": {
"data": [
{
"timestamp": 1398071605,
"data": 30
}
]
}
}

RST_MT_RSL

Lista zasobów

######Zasób URL GET resources

######Linki

  • measurements - uri wskazujące na kolekcję pomiarów, które należą do danego zasobu

######Autoryzacja Dostępny dla wszystkich

######Przykład Odpowiedz serwera:

{
"_embedded": {
"resources": [
{
"name": "atena_2F",
"_links": {
"measurements": {
"href": "http://127.0.0.1:8081/measurements?resource=atena_2F"
}
}
},
{
"name": "zeus_1F",
"_links": {
"measurements": {
"href": "http://127.0.0.1:8081/measurements?resource=zeus_1F"
}
}
}
]
}
}
Add a custom footer
Add a custom sidebar

Clone this wiki locally