HAMcast developers

Changes between Version 13 and Version 14 of documentation/tools/monitoring/rest/collector


Ignore:
Timestamp:
03/20/12 16:12:24 (12 years ago)
Author:
zagaria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • documentation/tools/monitoring/rest/collector

    v13 v14  
    11= Collector interface =
    22
    3 ==== std::string function_wrapper::group_list(std::vector<std::string> args) ====
     3==== group_list ====
    44
    55    Description: This call returns a list of HAMcast groups. The groups in this list are a merged set of groups gathered from all reachable HAMcast nodes.
    … …  
    99    Arguments : none
    1010
    11     XML :
     11    Query :
     12{{{
     13POST /group_list HTTP/1.1
     14User-Agent: HAMcast Monitoring
     15Content-Length:0
     16Content-Type: text/plain; charset=utf-8
     17}}}
     18
     19    Response :
    1220     {{{
    13 <method>
    14  /group_list
    15 <\method>
     21HTTP/1.1 200 OK
     22Content-Length: 124
     23Content-Type: text/xml; charset=utf-8
     24
     25<?xml version="1.0" encoding="utf-8"?>
     26<method>/group_list</method>
    1627<groups>
    17  <group>
    18   group1
    19  <\group>
    20  <group>
    21    group2
    22  <\group>
    23 <\groups>
    24 }}}
    25 
    26 ==== std::string function_wrapper::node_list(std::vector<std::string> args) ====
     28  <group>ip://239.0.0.2:1234</group>
     29</groups>
     30}}}
     31
     32==== node_list ====
    2733
    2834    Description: Returns a list of daemon-id. The list contains the daemon-ids of all reachable HAMcast nodes.
    … …  
    3137
    3238    Arguments : none
    33 
    34     XML :
    35 {{{
    36 <method>
    37  /node_list
    38 <\method>
     39   
     40    Query :
     41{{{
     42POST /node_list HTTP/1.1
     43User-Agent: HAMcast Monitoring
     44Content-Length:0
     45Content-Type: text/plain; charset=utf-8
     46}}}
     47   
     48    Response :
     49{{{
     50HTTP/1.1 200 OK
     51Content-Length: 402
     52Content-Type: text/xml; charset=utf-8
     53
     54<?xml version="1.0" encoding="utf-8"?>
     55<method>/node_list</method>
    3956<nodes>
    40  <node>
    41   daemon-id
    42  <node>
    43  <node>
    44   daemon-id
    45  <node>
    46 <\nodes>
    47 }}}
    48 
    49 ==== std::string function_wrapper::group_data(std::vector<std::string> args) ====
     57  <node>129.13.214.10</node>
     58  <node>129.13.214.210</node>
     59  <node>129.187.143.20</node>
     60  <node>130.75.73.66</node>
     61  <node>130.83.244.170</node>
     62  <node>131.246.112.2</node>
     63  <node>131.246.112.31</node>
     64  <node>132.187.230.65</node>
     65  <node>84.46.89.78</node>
     66</nodes>
     67}}}
     68
     69==== group_data ====
    5070
    5171    Description: Returns a list of daemon-id. The list contains the daemon-ids of all reachable HAMcast nodes that joined the given group.
    … …  
    5575    Arguments : HAMcast group uri
    5676
    57     XML :
    58 {{{
    59 <method>
    60  /group_data
    61 </method>
     77    Query :
     78{{{
     79POST /group_data HTTP/1.1
     80User-Agent: HAMcast Monitoring
     81Content-Length:26
     82Content-Type: text/plain; charset=utf-8
     83
     84arg0=ip://239.0.0.2:1234
     85}}}
     86
     87    Response :
     88{{{
     89HTTP/1.1 200 OK
     90Content-Length: 419
     91Content-Type: text/xml; charset=utf-8
     92
     93<?xml version="1.0" encoding="utf-8"?>
     94<method>/group_data</method>
    6295<group>
    63  <name>
    64   group name
    65  </name>
    66  <member>
    67   daemon-id
    68  </member>
    69  <member>
    70   daemon-id
    71  </member>
     96  <name>ip://239.0.0.2:1234</name>
     97  <member>129.13.214.10</member>
     98  <member>129.13.214.210</member>
     99  <member>129.187.143.20</member>
     100  <member>130.75.73.66</member>
     101  <member>130.83.244.170</member>
     102  <member>131.246.112.2</member>
     103  <member>131.246.112.31</member>
     104  <member>132.187.230.65</member>
     105  <member>84.46.89.78</member>
    72106</group>
    73107}}}
    74108
    75 ==== std::string function_wrapper::node_data(std::vector<std::string> args) ====
     109==== node_data ====
    76110
    77111    Description: Returns detailed interface and group information about a node, interface and groups.
    … …  
    85119    Arguments : daemon-id
    86120
    87     XML :
    88 {{{
    89 <name>
    90  daemon-id
    91 </name>
     121    Query :
     122{{{
     123POST /node_data HTTP/1.1
     124User-Agent: HAMcast Monitoring
     125Content-Length:20
     126Content-Type: text/plain; charset=utf-8
     127
     128arg0=129.13.214.10
     129}}}
     130
     131    Response :
     132{{{
     133HTTP/1.1 200 OK
     134Content-Length: 676
     135Content-Type: text/xml; charset=utf-8
     136
     137<?xml version="1.0" encoding="utf-8"?>
     138<name>129.13.214.10</name>
     139<img>false</img>
    92140<interfaces>
    93  <interface>
    94   <name>
    95    IPv4
    96   <name>
    97   <technology>
    98    native
    99   </technology>
    100   <id>
    101    1
    102   </id>
    103   <address>
    104    ip-address
    105   </address>
    106   <groups>
    107    <group>
    108     <name>
    109      group1
    110     </name>
    111     <parent>
    112      address
    113     </parent>
    114     <children>
    115      <child>
    116       address
    117      </child>
    118      <child>
    119       address
    120      </child>
    121     </children>
    122    </group>
    123   </groups>
    124  <interface>
     141  <interface>
     142    <name>scribe</name>
     143    <tech>ALM</tech>
     144    <id>1</id>
     145    <addr>scribe://31001132311312033110130111220211220021133010133323303030310133321221122203113311</addr>
     146    <groups>
     147      <group>
     148        <name>ip://239.0.0.2:1234</name>
     149        <parent>scribe://00303033131001320112231003213203131012203111132203012230202101012110210313231210</parent>
     150        <children>
     151          <child>scribe://21002321012323310010133022332200330131312130003122221031210122310033231011211301</child>
     152        </children>
     153      </group>
     154    </groups>
     155  </interface>
    125156</interfaces>
    126157}}}
    127158
    128 ==== std::string function_wrapper::group_tree(std::vector<std::string> args) ====
     159==== group_tree ====
    129160
    130161    Description: Returns a list of edges between nodes for a given group. The edges are directed from source to destination.
    131162
    132 
    133163    URL : /group_tree
    134164
    135165    Arguments : HAMcast group uri
    136 
    137     XML :
    138 {{{
    139 <method>
    140  /group_tree
    141 </method>
     166   
     167    Query :
     168{{{
     169POST /group_tree HTTP/1.1
     170User-Agent: HAMcast Monitoring
     171Content-Length:26
     172Content-Type: text/plain; charset=utf-8
     173
     174arg0=ip://239.0.0.2:1234
     175}}}
     176 
     177    Response :
     178{{{
     179HTTP/1.1 200 OK
     180Content-Length: 913
     181Content-Type: text/xml; charset=utf-8
     182
     183<?xml version="1.0" encoding="utf-8"?>
     184<method>/group_tree</method>
     185<name>ip://239.0.0.2:1234</name>
    142186<edges>
    143  <edge>
    144   <from>
    145    daemon-id
    146   </from>
    147   <to>
    148    daemon-id
    149   </to>
    150  </edge>
    151  <edge>
    152   <from>
    153    daemon-id
    154   </from>
    155   <to>
    156    daemon-id
    157   </to>
    158  </edge>
     187  <edge>
     188    <from>129.13.214.10</from>
     189    <to>131.246.112.31</to>
     190  </edge>
     191  <edge>
     192    <from>130.75.73.66</from>
     193    <to>131.246.112.31</to>
     194  </edge>
     195  <edge>
     196    <from>130.75.73.66</from>
     197    <to>84.46.89.71</to>
     198  </edge>
     199  <edge>
     200    <from>130.75.73.66</from>
     201    <to>129.13.214.10</to>
     202  </edge>
     203  <edge>
     204    <from>130.83.244.170</from>
     205    <to>130.75.73.66</to>
     206  </edge>
     207  <edge>
     208    <from>130.83.244.170</from>
     209    <to>129.13.214.210</to>
     210  </edge>
     211  <edge>
     212    <from>130.83.244.170</from>
     213    <to>132.187.230.65</to>
     214  </edge>
     215  <edge>
     216    <from>130.83.244.170</from>
     217    <to>129.187.143.20</to>
     218  </edge>
     219  <edge>
     220    <from>130.83.244.170</from>
     221    <to>129.13.214.10</to>
     222  </edge>
     223  <edge>
     224    <from>130.83.244.170</from>
     225    <to>131.246.112.2</to>
     226  </edge>
    159227</edges>
    160228}}}