User Tools

Site Tools


ov:cinderrest

The following REST interfaces are available on the Cinder module:

  1. GET: /servers
    • It shows the server list. For each server shows the {name} and the {status} of the server.
    • body: empty
    • return value: HTTP 200, xml
        <servers>
          <server>
            <name>{value: string}</name>
        	<status>{value: string [connected or disconnected]}</status>
          </server>
        </servers>
  2. GET: /server/{server name: string}
    • It shows the server {name} and its {status}.
    • body: empty
    • return value: HTTP 200, xml
        <server>
          <name>{value: string}</name>
          <status>{value: string [connected or disconnected]}</status>
        </server>
  3. GET: /stats
    • It shows the server list. For each server shows the monitored data.
    • body: empty
    • return value: HTTP 200, xml
        <servers>
          <server>
            <name>{value: string}</name>
            <total_memory>{value: integer}</total_memory>
            <free_memory_percentage>{value: integer [0-100]}</free_memory_percentage>
            <cpus>
              <cpu_node>
          	  <id>{value: string}</id>
          	  <load>{value: integer [0-100]}</load>
          	  <idle>{value: integer [0-100]}</idle>
          	  <freq>{value: integer}</freq>
          	</cpu_node>
            </cpus>
            <virtual_machines>
              <virtual_machine>
          	  <name>{value: string}</name>
                <used_memory>{value: integer}</used_memory>
                <used_cpu>{value: integer [0-100]}</used_cpu>
          	</virtual_machine>
            </virtual_machines>
            <network_functions>
              <network_function>
                <name>{value: string}</name>
                <used_memory>{value: integer}</used_memory>
                <used_cpu>{value: integer [0-100]}</used_cpu>
              </network_function>
            </network_functions>
          </server>
        </servers>
  4. POST: /server/{value: string}
    • It adds a server to the monitoring framework.
    • body: empty
    • return value: HTTP 201, empty body
  5. POST: /pu/{server name: string}
    • It adds a processing_unit (network_function or virtual_machine) running on server {server name} to the monitoring framework.
    • body: HTTP, xml
        <processing_units>
          <processing_unit>
            <type>{value: string [network_function or virtual_machine]}</type>
        	<description>{value: string}</description>
        	<process_name>{value: string}</process_name>
          </processing_unit>
        </processing_units>
    • return value: HTTP 201, empty body
  6. DELETE: /server/{value: string}
    • It removes the server {name} from monitoring.
    • body: empty
    • return value: HTTP 204, empty body
  7. DELETE: /pu/{server name: string}/{process name: string}
    • It removes the processing_unit {process name} running on {server name} from monitoring.
    • body: empty
    • return value: HTTP 204, empty body
ov/cinderrest.txt · Last modified: 2018/04/11 10:13 by 130.251.17.67