Changes between Version 2 and Version 3 of GENIMonitoring/API


Ignore:
Timestamp:
02/23/16 16:47:09 (7 years ago)
Author:
Caylin Hickey
Comment:

Added initial Info request information.

Legend:

Unmodified
Added
Removed
Modified
  • GENIMonitoring/API

    v2 v3  
    4141
    4242{{{
    43 http://genimondev.uky.edu/API/data/?q={%22ts%22:{%22lt%22:1456162423790000,%22gte%22:1456158823790000},%22obj%22:{%22type%22:%22aggregate%22,%22id%22:[%22ukypks2-ig%22]},%22output%22:%22json%22}
     43http://genimondev.uky.edu/API/data/?q={"obj":{"id":["pks2.sdn.uky.edu_node_pc1"],"type":"node"},"output":"json","ts":{"gte":1456260153962,"lt":1456263753962}}
    4444}}}
    4545
     
    8686      ],
    8787      "units": _____                                                             // describes the units fo the eventType
    88     }
     88    },
     89    ...
    8990  ]
    9091}}}
     92
     93== Info ==
     94
     95=== Request ===
     96
     97==== Request Format ====
     98
     99{{{
     100  {
     101    eventType: [
     102      "opsmonitoring:_____",
     103      ...
     104    ],
     105    ts: {
     106      ts: #####,         // milliseconds or microseconds, defaults to now() if omitted
     107    },
     108    obj: {
     109      type*: _______,     // string of object type  (aggregate, node, interface, etc.)
     110      id: [
     111        _______,         // string of either urn or id of a requested target, returns all if omitted
     112        ...
     113      ]
     114    },
     115    output: _______      // string of output format type. currently only json for info requests
     116  }
     117}}}
     118
     119==== Example Request URL ====
     120
     121{{{
     122http://genimondev.uky.edu/API/info/?q={"obj":{"id":["pks2.sdn.uky.edu_node_pc1"],"type":"node"},"output":"json"}
     123}}}
     124
     125=== Response ===
     126
     127==== Response Format (JSON) ====
     128
     129{{{
     130  [
     131    {
     132      _____: _____,          // These will be fields specific to the type of object requested
     133      ...
     134    },
     135    ...
     136  ]
     137}}}
     138
     139==== Response Format (XML) ====
     140
     141''Note: This is currently in the debugging stages, but will resemble the JSON format just using XML structures