KloudBuster Rest API Specification
A tool to load OpenStack clouds end to end in both control plane and data plane.
Version: 0.1.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
get /config/az_list/{session_id}get /config/default_configget /config/hypervisor_list/{session_id}post /config/running_configdelete /config/running_config/{session_id}get /config/running_config/{session_id}put /config/running_config/{session_id}get /config/topology_config/{session_id}post /kloudbuster/cleanup/{session_id}get /kloudbuster/log/{session_id}get /kloudbuster/report/{session_id}post /kloudbuster/run_test/{session_id}post /kloudbuster/stage/{session_id}get /kloudbuster/status/{session_id}post /kloudbuster/stop_test/{session_id}get /kloudbuster/version
Up
get /config/az_list/{session_id}
(configAzListSessionIdGet)
Get the available availability zone list
Path parameters
session_id (required)
Path Parameter — The session to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The available availability zones for the session
400
Cannot get the availability zone list
404
The session_id is not found or invalid
Up
get /config/default_config
(configDefaultConfigGet)
Get the default KloudBuster configuration from server
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The default configuration
Up
get /config/hypervisor_list/{session_id}
(configHypervisorListSessionIdGet)
Get the available hypervisor list
Path parameters
session_id (required)
Path Parameter — The session to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The available hypervisors for the session
400
Cannot get the hypervisor list
404
The session_id is not found or invalid
Up
post /config/running_config
(configRunningConfigPost)
Create a new KloudBuster session with provided configuration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
arg (required)
Body Parameter — The configuration for KloudBuster
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Session is already existed
201
Session is created successfully
400
Error while parsing the configuration file
Up
delete /config/running_config/{session_id}
(configRunningConfigSessionIdDelete)
Terminate the given session in KloudBuster server
Path parameters
session_id (required)
Path Parameter — The session to be terminated
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The session is terminated successfully
403
Session can be destroyed only if it is at READY
404
The session_id is not found or invalid
Up
get /config/running_config/{session_id}
(configRunningConfigSessionIdGet)
Get the running configuration of a KloudBuster session
Path parameters
session_id (required)
Path Parameter — The session to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The running configuration
404
The session_id is not found or invalid
Up
put /config/running_config/{session_id}
(configRunningConfigSessionIdPut)
Update KloudBuster configuration for an existing session
Path parameters
session_id (required)
Path Parameter — The session to be updated
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
arg (required)
Body Parameter — The configuration to be updated
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Configuration of given session is updated successfully
400
Invalid JSON or error while parsing the configuration file
403
Cannot update configuration if KloudBuster is busy or in error state
404
The session_id is not found or invalid
Up
get /config/topology_config/{session_id}
(configTopologyConfigSessionIdGet)
Get the topology configuration of a KloudBuster session
Path parameters
session_id (required)
Path Parameter — The session to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The topology configuration
404
The session_id is not found or invalid
Up
post /kloudbuster/cleanup/{session_id}
(kloudbusterCleanupSessionIdPost)
Cleanup KloudBuster for a given session
Path parameters
session_id (required)
Path Parameter — The session to be run
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successfully cleaned up the given session
403
No resources has been staged, or session is busy
404
The session_id is not found or invalid
Up
get /kloudbuster/log/{session_id}
(kloudbusterLogSessionIdGet)
Get KloudBuster console log for a given session
Path parameters
session_id (required)
Path Parameter — The session to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
offset (optional)
Query Parameter — The offset of the log file to read
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
400
Parameter is missing or invalid
404
The session_id is not found or invalid
Up
get /kloudbuster/report/{session_id}
(kloudbusterReportSessionIdGet)
Get the latest KloudBuster periodical report for a given session.\nSet final to true to retrieve the final report.
Path parameters
session_id (required)
Path Parameter — The session to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
final (optional)
Query Parameter — Set to true to retrieve the final report
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
404
The session_id is not found or invalid
Up
post /kloudbuster/run_test/{session_id}
(kloudbusterRunTestSessionIdPost)
Run KloudBuster for a given session
Path parameters
session_id (required)
Path Parameter — The session to be run
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successfully start the given session
403
Unable to start the tests when status is not at STAGED
404
The session_id is not found or invalid
Up
post /kloudbuster/stage/{session_id}
(kloudbusterStageSessionIdPost)
Stage all resources to run KloudBuster for a given session
Path parameters
session_id (required)
Path Parameter — The session to be staged
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successfully staged all resources for the given session
403
Unable to stage resources when status is not at READY
404
The session_id is not found or invalid
Up
get /kloudbuster/status/{session_id}
(kloudbusterStatusSessionIdGet)
Get KloudBuster server status for a given session
Path parameters
session_id (required)
Path Parameter — The session to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
404
The session_id is not found or invalid
Up
post /kloudbuster/stop_test/{session_id}
(kloudbusterStopTestSessionIdPost)
Stop the KloudBuster tests for a given session
Path parameters
session_id (required)
Path Parameter — The session to be stopped
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Scheduled to stop the tests for the given session
403
Unable to stop the tests when status is not at RUNNING
404
The session_id is not found or invalid
Up
get /kloudbuster/version
(kloudbusterVersionGet)
Get KloudBuster server version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
[ Jump to Methods ]
Table of Contents
AZ_ListConfiguration_NewConfiguration_UpdateHypervisor_ListTopology_Config
server
array[String] Available availability zones for server cloud
client
array[String] Available availability zones for client cloud
credentials
String Credentials for the clouds
kb_cfg
String User overrided configs
topo_cfg
String Topology config
tenants_cfg
String Tenant and User list for reusing
storage_mode
Boolean Running web UI for storage testing
kb_cfg
String User overrided configs
topo_cfg
String Topology config
tenants_cfg
String Tenant and User list for reusing
server
array[String] Available hypervisors for server cloud
client
array[String] Available hypervisors for client cloud
servers_rack
array[String] Hypervisors to hold server VMs
clients_rack
array[String] Hypervisors to hold client VMs