Get a composition

get https://{hostname}/concerto/services/rest/composition/instances/v1/{instanceId}

Returns a single composition instance.

Responses

Response body

object

instanceID

string

required

Uniquely identifies each instance.

name

string

required

The name of the composition.

partialLoad

boolean

required

Indicates that not all servers were able to load with the composition. You can proceed to play with fewer servers (thus likely fewer virtual users) or unload the composition and try again after diagnosing the situation.

path

string

required

The directory path of the composition.

resultName

string

The name of the result.

resultid

integer

Uniquely identifies each result. Use this in the Get a result to get information about its specific test results.

serverCount

integer

≥ 1

The number of maestro servers.

serverID

integer

≥ 1

The unique server ID of the alpha maestro. The alpha is the maestro load generator which is responsible for coordinating all other load generators.

startTime

string

The time the test started.

state

string

required

The state of the instance such as Playing or Terminating.

Loading Loaded Starting Playing Pausing Paused Resuming Stopping Aborting Closing Writing Completed Failed Stopped Aborted Unloaded

status

string

required

A detailed textual description of the current state of the instance.

totalTime

integer

The length of time the test has run in milliseconds.

uri

string

required

Use this URL to get the status of the given instance.

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.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/concerto/services/rest/composition/instances/v1/instanceId \
3
     --header 'accept: application/json'


xxxxxxxxxx
14
 
1
{
2
  "instanceID": "1-B5456861-50ED-466B-8AAC-D41DC05A260B",
3
  "name": "Quick Test Comp For Ramping",
4
  "partialLoad": false,
5
  "path": "/Analytics Unit Tests",
6
  "resultName": "Result from Tue May 05 16:12:29 PDT 2020",
7
  "resultid": 30601,
8
  "serverCount": 1,
9
  "serverID": 1,
10
  "startTime": "Tue May 05 16:12:29 PDT 2020",
11
  "state": "Playing",
12
  "status": "Playing",
13
  "totalTime": 13653
14
}

200The operation responds with the composition object.