API

CloudTest API
API summary
Get started
API concepts
Rate limiting
Asynchronous operations
Errors
- 400
- 401
- 403
- 404
- 405
- 429
- 500

Cloud servers

Cloud servers

Test environments

Test environments
- Get a test environmentget
- Start or stop a test environmentpost

Grid Provisioning

Grids

Compositions

Compositions

Cloud servers

Cloud servers

Results management

Results
- Request a delete of test resultspost
Tasks

Query results

Results
- List resultsget
- Get a resultget
Ramp Details
- Get ramp and marker dataget
Aggregate data
- Get aggregate action dataget
- Get aggregate collection dataget
Load generators
- List load generatorsget
Virtual users
- Get virtual user countget
Virtual users time series
- Get a virtual user count time seriesget

Results database

Results database
- Get a results databaseget
- Start or stop a results databasepost

Seed data

Seed data

Server management

Servers
- List serversget
- Get a serverget

Tenant management

Tenants
- Initiate tenant sub-data deletionpost
Tasks

Tokens

Tokens
- Generate a tokenput
- Delete a tokendelete

Objects

Objects

Get a results database

get https://{hostname}/concerto/services/rest/CloudService/v1/rsdb/{rsdbId}

Returns a single rsdb. In order to interact with a result database you need the results database ID. See Get an object for more information.

Path Params

rsdbId

integer

required

Uniquely identifies each results database.

Headers

X-Auth-Token

string

required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

Responses

Response body

object

cloudServer

object

Information about a cloud server.

cloudType

string

required

The cloud provider, either EC2, EC2_CHINA, AZURE, COMPUTE_ENGINE, or RACKSPACE_OPENSTACK.

EC2 EC2_CHINA AZURE COMPUTE_ENGINE RACKSPACE_OPENSTACK

integer

required

≥ 1

Uniquely identifies each server.

instanceSize

string

The type of server instance which describes the memory, CPU, and other server class characteristics. See the cloud provider for detailed information.

launchCPAName

string

The CPA used to launch this server.

privateHostName

string

The internal hostname of the server.

publicHostName

string

The external hostname of the server.

region

string

The cloud provider region.

state

string

The current state of the server, either PENDING, BUSY, RUNNING, SHUTTING_DOWN, TERMINATED, FAILED, or BIDDING.

PENDING BUSY RUNNING SHUTTING_DOWN TERMINATED FAILED BIDDING

vendorID

string

The unique identifier used by the cloud provider to describe each instance.

zone

string

The cloud provider zone within the region.

state

string

The state of the results database. VOLUME_NOT_AVAILABLE means the volume does not exist or is in use by some other instance. VOLUME_NOT_FORMATTED shows that the user should execute a format action on the results database. VOLUME_FORMAT_FAILED shows that something went wrong with the volume formatting. TERMINATING shows that the instance is ending while TERMINATED states that the instance is torn down. The other states show the progress as a database instance starts. It will go from ALLOCATING_DATABASE to ALLOCATED_DATABASE to STARTING_MONITORS to CHECKING and finally to RUNNING.

VOLUME_NOT_AVAILABLE VOLUME_NOT_FORMATTED VOLUME_FORMAT_FAILED TERMINATING TERMINATED ALLOCATING_DATABASE ALLOCATED_DATABASE STARTING_MONITORS CHECKING RUNNING

400

Bad request. The URL or JSON request object is invalid.

401

Unauthorized. The security token is missing or invalid. See Get started for help initially running the API.

404

Not found. The requested object doesn't exist.

405

Method Not Allowed. Invalid method used to access resource.

Updated about 1 year ago

Get a virtual user count time series

Start or stop a results database

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/concerto/services/rest/CloudService/v1/rsdb/rsdbId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 1 year ago

Get a virtual user count time series

Start or stop a results database

API
CloudTest API
API summary
Get started
API concepts
Rate limiting
Asynchronous operations
Errors
500
429
405
404
403
401
400

Cloud servers
Cloud servers
Restart or terminate a cloud serverpost
Get a cloud serverget
List cloud serversget

Test environments
Test environments
Start or stop a test environmentpost
Get a test environmentget

Grid Provisioning
Grids
Start or stop a gridpost
Get a gridget
List gridsget

Compositions
Compositions
Composition commandsput
Get a compositionget
List active compositionsget
Start or load a compositionpost

Cloud servers
Cloud servers
Restart or terminate a cloud serverpost
Get a cloud serverget
List cloud serversget

Results management
Results
Request a delete of test resultspost
Tasks
Stop a results management taskdelete
Get a results management taskget
List results management tasksget

Query results
Results
Get a resultget
List resultsget
Ramp Details
Get ramp and marker dataget
Aggregate data
Get aggregate collection dataget
Get aggregate action dataget
Load generators
List load generatorsget
Virtual users
Get virtual user countget
Virtual users time series
Get a virtual user count time seriesget

Results database
Results database
Start or stop a results databasepost
Get a results databaseget

Seed data
Seed data
Delete seed datadelete
Get seed dataget
Append seed datapost

Server management
Servers
Get a serverget
List serversget

Tenant management
Tenants
Initiate tenant sub-data deletionpost
Tasks
Stop a tenant management taskdelete
Get a tenant management taskget
List tenant management tasksget

Tokens
Tokens
Delete a tokendelete
Generate a tokenput

Objects
Objects
Transfer object ownershippost
Delete an objectdelete
Get an objectget
Update an objectpost
Create an objectput
List objectsget

200Successful operation. Returns information about a results database.