Get Scenario
get_scenarioGet a single scenario including its Populations, plus a dashboard link and its launch readiness: the account's fuelBalance; launchBlockers, where an empty list means it can launch as it stands; and estimatedFuelLow and estimatedFuelHigh, the low and high ends of the Fuel estimate the Dashboard shows. The estimate is present whenever the test would burn Fuel, which is every test on an account without a plan, and on one with a plan, any test the plan does not cover; launch_load_test then runs the whole test on Fuel. Without an estimate, it runs on the account's plan and burns no Fuel. get_documentation topic 'faqs/plan-or-fuel' explains when a plan or Fuel applies. A field left out of a population is at its default: iterations and iterationsPerUser unlimited, aggressionMultiplier 1.0, and bandwidth unthrottled. Read get_documentation topic 'load-test-scenarios' for what the stages and ramps actually do.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | ||
| scenarioId | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| tags | No | ||
| maxBots | Yes | ||
| version | No | ||
| projectId | Yes | ||
| fuelBalance | Yes | ||
| populations | Yes | ||
| dashboardUrl | Yes | ||
| totalDuration | Yes | ||
| launchBlockers | Yes | ||
| populationCount | Yes | ||
| estimatedFuelLow | No | ||
| estimatedFuelHigh | No |