loadgen

retrieve one registered load scenario

Returns a single registered load scenario (definition + state + live/terminal status). 404 if not registered.

get/mockserver/loadScenario/{name}

Request

  • Base URL: http://localhost:1080
  • URL: http://localhost:1080/mockserver/loadScenario/{name}
  • Auth: none declared

Response

load scenario returned

namestring
state'LOADED' | 'PENDING' | 'RUNNING' | 'COMPLETED' | 'STOPPED'
startDelayMillisinteger
elapsedMillisinteger
currentVusinteger

live count of active virtual users (present when running)

stageIndexinteger

0-based index of the currently-running stage (present when running)

stageType'VU' | 'RATE' | 'PAUSE'
currentTargetnumber

current setpoint for the running stage: target virtual users (VU), arrival rate in iterations/second (RATE), or 0 (PAUSE)

requestsSentinteger
succeededinteger
failedinteger
p50Millisnumber
p95Millisnumber
p99Millisnumber
p999Millisnumber

99.9th-percentile coordinated-omission-corrected latency (ms), from the per-run HDR histogram; available even when metrics are disabled

droppedIterationsinteger

iterations that were due but never dispatched because a safety cap was hit (sum of rate_limit and inflight_cap throttles for this run)

verdict'PASS' | 'FAIL'

in-run threshold verdict: PASS (all thresholds satisfied) or FAIL (any breached); absent when the scenario has no thresholds or none has been evaluated yet. A terminal FAIL should be mapped by clients to a non-zero CI exit code.

abortedByThresholdboolean

true when this run was terminated early by an abortOnFail threshold breach; absent means false

runIdstring
startedAtinteger
endedAtinteger

Changes

No recorded changes to this operation across all 1 revision of this API.