REST API Monitor

id	zasób	opis
[[RST_MT_MSL	REST-API-Monitor#rst_mt_msl]]	GET measurements
[[RST_MT_CMSA	REST-API-Monitor#rst_mt_cmsa]]	POST measurements/{id}
[[RST_MT_MSG	REST-API-Monitor#rst_mt_msg]]	GET measurements/{id}
[[RST_MT_MSVL	REST-API-Monitor#rst_mt_msvl]]	GET measurements/{id}/data
[[RST_MT_CMSD	REST-API-Monitor#rst_mt_cmsd]]	DELETE measurements/{id}
[[RST_MT_RSL	REST-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ć

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

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

{
  "_embedded" : {
    "measurements" : [ {
      "resource" : "cpuUsage",
      "metric" : "host",
	  "unit": "%",
      "_links" : {
        "self" : {
          "href" : "http://monitor1/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08"
        },
        "data" : {
          "href" : "http://monitor1/measurements/c40fac9f-8c96-4476-b435-aa52e4b17e08/data"
        }
      }
    }, {
      "resource" : "memUsage",
      "metric" : "zeus_cpu_1B",
	  "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=host

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

RST_MT_CMSA

Dodawanie nowego pomiaru złozonego

Akceptowalne typy pomiarów złożonych:

1. Średnia ruchoma [move_avg]. Parametry :
   • windowsPeriod: szerokość okna - z ilu minut mają być brane pomiary pod uwagę
   • interval: czas wyliczania średniej - co ile minut ma być wyliczana średnia

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

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

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

{
    "type" : "move_avg",
    "params": [
    {
      "paramName":"windowsPeriod",
      "value": 10
    },
    {
      "paramName":"interval",
      "value": 5
    }
    ]
}

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}

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

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

{
  "resource": "cpuUsage",
  "metric": "host",
  "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 minut
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

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

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

{
  "_embedded": {
    "resources": [
      {
        "name": "memUsage",
        "_links": {
          "measurements": {
            "href": "http://127.0.0.1:8081/measurements/filter?resource=memUsage"
          }
        }
      },
      {
        "name": "cpuUsage",
        "_links": {
          "measurements": {
            "href": "http://127.0.0.1:8081/measurements/filter?resource=cpuUsage"
          }
        }
      }
    ]
  }
}