1506 lines
38 KiB
HTML
1506 lines
38 KiB
HTML
<?xml version="1.0"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>KloudBuster Rest API Specification</title>
|
|
<style type="text/css">
|
|
body {
|
|
font-family: Trebuchet MS, sans-serif;
|
|
font-size: 15px;
|
|
color: #444;
|
|
margin-right: 24px;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 25px;
|
|
}
|
|
h2 {
|
|
font-size: 20px;
|
|
}
|
|
h3 {
|
|
font-size: 16px;
|
|
font-weight: bold;
|
|
}
|
|
hr {
|
|
height: 1px;
|
|
border: 0;
|
|
color: #ddd;
|
|
background-color: #ddd;
|
|
display: none;
|
|
}
|
|
|
|
.app-desc {
|
|
clear: both;
|
|
margin-left: 20px;
|
|
}
|
|
.param-name {
|
|
width: 100%;
|
|
}
|
|
.license-info {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.license-url {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.model {
|
|
margin: 0 0 0px 20px;
|
|
}
|
|
|
|
.method {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.method-notes {
|
|
margin: 10px 0 20px 0;
|
|
font-size: 90%;
|
|
color: #555;
|
|
}
|
|
|
|
pre {
|
|
padding: 10px;
|
|
margin-bottom: 2px;
|
|
}
|
|
|
|
.http-method {
|
|
text-transform: uppercase;
|
|
}
|
|
|
|
pre.get {
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
pre.post {
|
|
background-color: #10a54a;
|
|
}
|
|
|
|
pre.put {
|
|
background-color: #c5862b;
|
|
}
|
|
|
|
pre.delete {
|
|
background-color: #a41e22;
|
|
}
|
|
|
|
.huge {
|
|
color: #fff;
|
|
}
|
|
|
|
pre.example {
|
|
background-color: #f3f3f3;
|
|
padding: 10px;
|
|
border: 1px solid #ddd;
|
|
}
|
|
|
|
code {
|
|
white-space: pre;
|
|
}
|
|
|
|
.nickname {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-path {
|
|
font-size: 1.5em;
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
.up {
|
|
float:right;
|
|
}
|
|
|
|
.parameter {
|
|
width: 500px;
|
|
}
|
|
|
|
.param {
|
|
width: 500px;
|
|
padding: 10px 0 0 20px;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-desc {
|
|
width: 700px;
|
|
padding: 0 0 0 20px;
|
|
color: #777;
|
|
}
|
|
|
|
.param-type {
|
|
font-style: italic;
|
|
}
|
|
|
|
.param-enum-header {
|
|
width: 700px;
|
|
padding: 0 0 0 60px;
|
|
color: #777;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-enum {
|
|
width: 700px;
|
|
padding: 0 0 0 80px;
|
|
color: #777;
|
|
font-style: italic;
|
|
}
|
|
|
|
.field-label {
|
|
padding: 0;
|
|
margin: 0;
|
|
clear: both;
|
|
}
|
|
|
|
.field-items {
|
|
padding: 0 0 15px 0;
|
|
margin-bottom: 15px;
|
|
}
|
|
|
|
.return-type {
|
|
clear: both;
|
|
padding-bottom: 10px;
|
|
}
|
|
|
|
.param-header {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-tags {
|
|
text-align: right;
|
|
}
|
|
|
|
.method-tag {
|
|
background: none repeat scroll 0% 0% #24A600;
|
|
border-radius: 3px;
|
|
padding: 2px 10px;
|
|
margin: 2px;
|
|
color: #FFF;
|
|
display: inline-block;
|
|
text-decoration: none;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<h1>KloudBuster Rest API Specification</h1>
|
|
<div class="app-desc">A tool to load OpenStack clouds end to end in both control plane and data plane.</div>
|
|
<div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div>
|
|
<div class="app-desc">Contact Info: <a href="hello@helloreverb.com">hello@helloreverb.com</a></div>
|
|
<div class="app-desc">Version: 0.1.0</div>
|
|
<div class="license-info">All rights reserved</div>
|
|
<div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
|
|
<h2>Access</h2>
|
|
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
|
|
<h2>Table of Contents </h2>
|
|
<div class="method-summary"></div>
|
|
|
|
<ol>
|
|
|
|
|
|
|
|
<li><a href="#configAzListSessionIdGet"><code><span class="http-method">get</span> /config/az_list/{session_id}</code></a></li>
|
|
|
|
<li><a href="#configDefaultConfigGet"><code><span class="http-method">get</span> /config/default_config</code></a></li>
|
|
|
|
<li><a href="#configHypervisorListSessionIdGet"><code><span class="http-method">get</span> /config/hypervisor_list/{session_id}</code></a></li>
|
|
|
|
<li><a href="#configRunningConfigPost"><code><span class="http-method">post</span> /config/running_config</code></a></li>
|
|
|
|
<li><a href="#configRunningConfigSessionIdDelete"><code><span class="http-method">delete</span> /config/running_config/{session_id}</code></a></li>
|
|
|
|
<li><a href="#configRunningConfigSessionIdGet"><code><span class="http-method">get</span> /config/running_config/{session_id}</code></a></li>
|
|
|
|
<li><a href="#configRunningConfigSessionIdPut"><code><span class="http-method">put</span> /config/running_config/{session_id}</code></a></li>
|
|
|
|
<li><a href="#configTopologyConfigSessionIdGet"><code><span class="http-method">get</span> /config/topology_config/{session_id}</code></a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="#kloudbusterCleanupSessionIdPost"><code><span class="http-method">post</span> /kloudbuster/cleanup/{session_id}</code></a></li>
|
|
|
|
<li><a href="#kloudbusterLogSessionIdGet"><code><span class="http-method">get</span> /kloudbuster/log/{session_id}</code></a></li>
|
|
|
|
<li><a href="#kloudbusterReportSessionIdGet"><code><span class="http-method">get</span> /kloudbuster/report/{session_id}</code></a></li>
|
|
|
|
<li><a href="#kloudbusterRunTestSessionIdPost"><code><span class="http-method">post</span> /kloudbuster/run_test/{session_id}</code></a></li>
|
|
|
|
<li><a href="#kloudbusterStageSessionIdPost"><code><span class="http-method">post</span> /kloudbuster/stage/{session_id}</code></a></li>
|
|
|
|
<li><a href="#kloudbusterStatusSessionIdGet"><code><span class="http-method">get</span> /kloudbuster/status/{session_id}</code></a></li>
|
|
|
|
<li><a href="#kloudbusterStopTestSessionIdPost"><code><span class="http-method">post</span> /kloudbuster/stop_test/{session_id}</code></a></li>
|
|
|
|
<li><a href="#kloudbusterVersionGet"><code><span class="http-method">get</span> /kloudbuster/version</code></a></li>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method"><a name="configAzListSessionIdGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /config/az_list/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configAzListSessionIdGet</span>)</div>
|
|
|
|
<div class="method-notes">Get the available availability zone list</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be queried </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#AZ_List">AZ_List</a>
|
|
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
The available availability zones for the session
|
|
|
|
|
|
<h4 class="field-label">400</h4>
|
|
Cannot get the availability zone list
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="configDefaultConfigGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /config/default_config</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configDefaultConfigGet</span>)</div>
|
|
|
|
<div class="method-notes">Get the default KloudBuster configuration from server</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
The default configuration
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="configHypervisorListSessionIdGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /config/hypervisor_list/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configHypervisorListSessionIdGet</span>)</div>
|
|
|
|
<div class="method-notes">Get the available hypervisor list</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be queried </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Hypervisor_List">Hypervisor_List</a>
|
|
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
The available hypervisors for the session
|
|
|
|
|
|
<h4 class="field-label">400</h4>
|
|
Cannot get the hypervisor list
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="configRunningConfigPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /config/running_config</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configRunningConfigPost</span>)</div>
|
|
|
|
<div class="method-notes">Create a new KloudBuster session with provided configuration</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">arg (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — The configuration for KloudBuster </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
Session is already existed
|
|
|
|
|
|
<h4 class="field-label">201</h4>
|
|
Session is created successfully
|
|
|
|
|
|
<h4 class="field-label">400</h4>
|
|
Error while parsing the configuration file
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="configRunningConfigSessionIdDelete"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /config/running_config/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configRunningConfigSessionIdDelete</span>)</div>
|
|
|
|
<div class="method-notes">Terminate the given session in KloudBuster server</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be terminated </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
The session is terminated successfully
|
|
|
|
|
|
<h4 class="field-label">403</h4>
|
|
Session can be destroyed only if it is at READY
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="configRunningConfigSessionIdGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /config/running_config/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configRunningConfigSessionIdGet</span>)</div>
|
|
|
|
<div class="method-notes">Get the running configuration of a KloudBuster session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be queried </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
The running configuration
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="configRunningConfigSessionIdPut"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="put"><code class="huge"><span class="http-method">put</span> /config/running_config/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configRunningConfigSessionIdPut</span>)</div>
|
|
|
|
<div class="method-notes">Update KloudBuster configuration for an existing session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be updated </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">arg (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — The configuration to be updated </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
Configuration of given session is updated successfully
|
|
|
|
|
|
<h4 class="field-label">400</h4>
|
|
Invalid JSON or error while parsing the configuration file
|
|
|
|
|
|
<h4 class="field-label">403</h4>
|
|
Cannot update configuration if KloudBuster is busy or in error state
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="configTopologyConfigSessionIdGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /config/topology_config/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">configTopologyConfigSessionIdGet</span>)</div>
|
|
|
|
<div class="method-notes">Get the topology configuration of a KloudBuster session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be queried </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#Topology_Config">Topology_Config</a>
|
|
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
The topology configuration
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method"><a name="kloudbusterCleanupSessionIdPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /kloudbuster/cleanup/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterCleanupSessionIdPost</span>)</div>
|
|
|
|
<div class="method-notes">Cleanup KloudBuster for a given session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be run </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
Successfully cleaned up the given session
|
|
|
|
|
|
<h4 class="field-label">403</h4>
|
|
No resources has been staged, or session is busy
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="kloudbusterLogSessionIdGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /kloudbuster/log/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterLogSessionIdGet</span>)</div>
|
|
|
|
<div class="method-notes">Get KloudBuster console log for a given session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be queried </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The offset of the log file to read </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
|
|
|
|
<h4 class="field-label">400</h4>
|
|
Parameter is missing or invalid
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="kloudbusterReportSessionIdGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /kloudbuster/report/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterReportSessionIdGet</span>)</div>
|
|
|
|
<div class="method-notes">Get the latest KloudBuster periodical report for a given session.\nSet final to true to retrieve the final report.</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be queried </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">final (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Set to true to retrieve the final report </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="kloudbusterRunTestSessionIdPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /kloudbuster/run_test/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterRunTestSessionIdPost</span>)</div>
|
|
|
|
<div class="method-notes">Run KloudBuster for a given session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be run </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
Successfully start the given session
|
|
|
|
|
|
<h4 class="field-label">403</h4>
|
|
Unable to start the tests when status is not at STAGED
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="kloudbusterStageSessionIdPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /kloudbuster/stage/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterStageSessionIdPost</span>)</div>
|
|
|
|
<div class="method-notes">Stage all resources to run KloudBuster for a given session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be staged </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
Successfully staged all resources for the given session
|
|
|
|
|
|
<h4 class="field-label">403</h4>
|
|
Unable to stage resources when status is not at READY
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="kloudbusterStatusSessionIdGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /kloudbuster/status/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterStatusSessionIdGet</span>)</div>
|
|
|
|
<div class="method-notes">Get KloudBuster server status for a given session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be queried </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="kloudbusterStopTestSessionIdPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /kloudbuster/stop_test/{session_id}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterStopTestSessionIdPost</span>)</div>
|
|
|
|
<div class="method-notes">Stop the KloudBuster tests for a given session</div>
|
|
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">session_id (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — The session to be stopped </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
Scheduled to stop the tests for the given session
|
|
|
|
|
|
<h4 class="field-label">403</h4>
|
|
Unable to stop the tests when status is not at RUNNING
|
|
|
|
|
|
<h4 class="field-label">404</h4>
|
|
The session_id is not found or invalid
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="method"><a name="kloudbusterVersionGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /kloudbuster/version</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">kloudbusterVersionGet</span>)</div>
|
|
|
|
<div class="method-notes">Get KloudBuster server version</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
String
|
|
</div>
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
|
|
<li><code>application/json</code></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="up"><a href="#__Models">Up</a></div>
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<h2>Table of Contents</h2>
|
|
<ol>
|
|
|
|
|
|
<li><a href="#AZ_List"><code>AZ_List</code></a></li>
|
|
|
|
|
|
|
|
<li><a href="#Configuration_New"><code>Configuration_New</code></a></li>
|
|
|
|
|
|
|
|
<li><a href="#Configuration_Update"><code>Configuration_Update</code></a></li>
|
|
|
|
|
|
|
|
<li><a href="#Hypervisor_List"><code>Hypervisor_List</code></a></li>
|
|
|
|
|
|
|
|
<li><a href="#Topology_Config"><code>Topology_Config</code></a></li>
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="AZ_List">AZ_List</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">server </div><div class="param-desc"><span class="param-type">array[String]</span> Available availability zones for server cloud</div>
|
|
|
|
<div class="param">client </div><div class="param-desc"><span class="param-type">array[String]</span> Available availability zones for client cloud</div>
|
|
|
|
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="Configuration_New">Configuration_New</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">credentials </div><div class="param-desc"><span class="param-type">String</span> Credentials for the clouds</div>
|
|
|
|
<div class="param">kb_cfg </div><div class="param-desc"><span class="param-type">String</span> User overrided configs</div>
|
|
|
|
<div class="param">topo_cfg </div><div class="param-desc"><span class="param-type">String</span> Topology config</div>
|
|
|
|
<div class="param">tenants_cfg </div><div class="param-desc"><span class="param-type">String</span> Tenant and User list for reusing</div>
|
|
|
|
<div class="param">storage_mode </div><div class="param-desc"><span class="param-type">Boolean</span> Running web UI for storage testing</div>
|
|
|
|
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="Configuration_Update">Configuration_Update</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">kb_cfg </div><div class="param-desc"><span class="param-type">String</span> User overrided configs</div>
|
|
|
|
<div class="param">topo_cfg </div><div class="param-desc"><span class="param-type">String</span> Topology config</div>
|
|
|
|
<div class="param">tenants_cfg </div><div class="param-desc"><span class="param-type">String</span> Tenant and User list for reusing</div>
|
|
|
|
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="Hypervisor_List">Hypervisor_List</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">server </div><div class="param-desc"><span class="param-type">array[String]</span> Available hypervisors for server cloud</div>
|
|
|
|
<div class="param">client </div><div class="param-desc"><span class="param-type">array[String]</span> Available hypervisors for client cloud</div>
|
|
|
|
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="Topology_Config">Topology_Config</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">servers_rack </div><div class="param-desc"><span class="param-type">array[String]</span> Hypervisors to hold server VMs</div>
|
|
|
|
<div class="param">clients_rack </div><div class="param-desc"><span class="param-type">array[String]</span> Hypervisors to hold client VMs</div>
|
|
|
|
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html>
|