Create Scenario
create_scenarioCreate a scenario in a project — saving costs nothing and starts nothing. Launch it with launch_load_test at the "Read+Write+Execute" access level; below that level the tool is absent, and the user launches it from the Dashboard at the link. The save is refused for an engineId list_engines doesn't offer, a stage shorter than the minimum, or more bots or populations than the account allows, and the refusal names the limit. The summary's launchBlockers are reasons the user could not launch it right now; they never stop the save, so tell the user about a blocker instead of rewriting the scenario to avoid it. The 'load-test-scenarios' topic covers what the stages and ramps actually do.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The scenario name. | |
| tags | No | Tag names; a name the team doesn't have yet becomes a new tag. Omit for no tags. | |
| projectId | Yes | ||
| populations | Yes | The Populations, in order. Each needs a name, the scriptId of a script in this project, and stages — { target, duration, ramp } segments that run for duration milliseconds and reach target bots by the end, each starting from where the previous stage left off. Optional per population: id (send back the id get_scenario reported to keep a population's identity), engineId (an id from list_engines; defaults to the account's default region; loadEngineId is its deprecated alias), iterations, iterationsPerUser, aggressionMultiplier, and playbackOptions with connectionBps (bits per second), hostnameOverrides, and variableOverrides. Read get_documentation topic 'load-test-scenarios' for what stages and ramps do; list_engines carries the account's stage bounds and bot caps. |