Stop Virtual Users Immediately Method
This Eggplant Performance Test Controller REST method instructs some virtual users to stop immediately.
URL
/test_controller/api/1.0/<workspace>/<project>/<test>/stop_virtual_users_immediately
HTTP Method
POST: Instructs some virtual users to stop immediately
POST Data Parameters
The POST data should be an object, mapping a VU group name to a range of virtual users to stop.
Response Parameters
| Type | Description |
|---|---|
<string> | Engine for which the Virtual Users were stopped. For each engine there is a list containing two values: a <boolean> indicating whether the request to stop was processed successfully and a <string> containing a message. |
Example Request
To stop the first two virtual users in the demoScript VU group:
http:/test_controller/api/1.0/Demo%20Workspace/Demo/demoScript/stop_virtual_users_immediately
POST Data
{
"demoScript": "1-2"
}
Example Response
{
"intel.win32.clr4_6.0": [true, "Virtual users instructed to stop immediately"]
}