GetJMeterSceneRunningData - Performance Testing - Alibaba Cloud Documentation Center

Retrieves the data generated during a JMeter stress test based on the scenario ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pts:GetJMeterSceneRunningData

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SceneId	string	Yes	The scenario ID.	DYYPZIH

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
Code	string	The status code of the request. This parameter is not returned if the request is successful.	200
DocumentUrl	string	The link to the documentation.	空
HttpStatusCode	integer	The HTTP status code. This parameter is not returned if the request is successful.	200
Message	string	The error message returned. This parameter is not returned if the request is successful.
RequestId	string	The request ID.	A8E16480-15C1-555A-922F-B736A005E52D
RunningData	object	The data of the running task.
AgentCount	integer	The number of stress testing engines.	2
AgentIdList	array	A list of stress testing engine IDs.
	string	A stress testing engine ID.	["116.19.153.94_3088020"]
AllSampleStat	object	The overall sampling statistics of the scenario.	{ "failTps":0,"successRtAvg":33,"successRtMin":29,"successRtSum":99407, "rtAvg":33.459104678559406,"rtMin":29,"failRtMax":0,"duration":997, "samplerId":-1, "successRtMax":133,"fullStat":{ "requestBytesSum":629926,"successRtAvg":33,"successRtMin":29,"successRtSum":174551,"count":5206,"rtSeg99":53, "successTps":2397.9732842008293,"rtSeg90":36, "rtSeg50":32, "rtSeg99Sum":53,"rtAvg":33.528812908182864, "rtMin":29, "failRtMax":0,"duration":2171, "successCount":5206, "rtSegStatCount":1,"tps":2397.9732842008293 }, "successCount":2971, "failRtSum":0,"failCount":0,"count":2971,"concurrency":100, "successTps":2979.939819458375,"tps":2979.939819458375,"failRtAvg":0, "failRtMin":0, "rtMax":133}
Concurrency	integer	The number of concurrent users.	1000
ErrorMessage	string	The error message returned for the failed stress testing flow. This parameter is not returned if the flow is successful.	Engine lease failed.
HasError	boolean	Indicates whether an error occurred in the stress testing flow.	false
HasReport	boolean	Indicates whether a report has been generated.	false
HoldFor	integer	The duration of the stress test. Unit: seconds.	600
IsDebugging	boolean	Indicates whether the test is a debug run.	false
ReportId	string	The ID of the stress testing task. This is also the report ID.	DYYPLDKS
SampleStatList	array<object>	The statistics of each sampler.
	object	The statistics of a sampler.	{ "failTps":0,"successRtAvg":33,"successRtMin":29,"successRtSum":99407, "rtAvg":33.459104678559406,"rtMin":29,"failRtMax":0,"duration":997, "samplerId":-1, "successRtMax":133,"fullStat":{ "requestBytesSum":629926,"successRtAvg":33,"successRtMin":29,"successRtSum":174551,"count":5206,"rtSeg99":53, "successTps":2397.9732842008293,"rtSeg90":36, "rtSeg50":32, "rtSeg99Sum":53,"rtAvg":33.528812908182864, "rtMin":29, "failRtMax":0,"duration":2171, "successCount":5206, "rtSegStatCount":1,"tps":2397.9732842008293 }, "successCount":2971, "failRtSum":0,"failCount":0,"count":2971,"concurrency":100, "successTps":2979.939819458375,"tps":2979.939819458375,"failRtAvg":0, "failRtMin":0, "rtMax":133}
SceneId	string	The scenario ID.	DYYPZIH
SceneName	string	The name of the scenario.	test
StageName	string	The current stage of the task.	任务执行
StartTimeTS	integer	The UNIX timestamp that indicates the start time of the stress test. Unit: milliseconds.	1639970040000
Status	string	The status of the stress test scenario.	RUNNING
Vum	integer	The number of virtual user minutes (VUMs) consumed.	100
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "DocumentUrl": "空",
  "HttpStatusCode": 200,
  "Message": "",
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "RunningData": {
    "AgentCount": 2,
    "AgentIdList": [
      "[\"116.19.153.94_3088020\"]"
    ],
    "AllSampleStat": {
      "failTps": 0,
      "successRtAvg": 33,
      "successRtMin": 29,
      "successRtSum": 99407,
      "rtAvg": 33.459104678559406,
      "rtMin": 29,
      "failRtMax": 0,
      "duration": 997,
      "samplerId": -1,
      "successRtMax": 133,
      "fullStat": {
        "requestBytesSum": 629926,
        "successRtAvg": 33,
        "successRtMin": 29,
        "successRtSum": 174551,
        "count": 5206,
        "rtSeg99": 53,
        "successTps": 2397.9732842008293,
        "rtSeg90": 36,
        "rtSeg50": 32,
        "rtSeg99Sum": 53,
        "rtAvg": 33.528812908182864,
        "rtMin": 29,
        "failRtMax": 0,
        "duration": 2171,
        "successCount": 5206,
        "rtSegStatCount": 1,
        "tps": 2397.9732842008293
      },
      "successCount": 2971,
      "failRtSum": 0,
      "failCount": 0,
      "count": 2971,
      "concurrency": 100,
      "successTps": 2979.939819458375,
      "tps": 2979.939819458375,
      "failRtAvg": 0,
      "failRtMin": 0,
      "rtMax": 133
    },
    "Concurrency": 1000,
    "ErrorMessage": "Engine lease failed.\n",
    "HasError": false,
    "HasReport": false,
    "HoldFor": 600,
    "IsDebugging": false,
    "ReportId": "DYYPLDKS",
    "SampleStatList": [
      {
        "failTps": 0,
        "successRtAvg": 33,
        "successRtMin": 29,
        "successRtSum": 99407,
        "rtAvg": 33.459104678559406,
        "rtMin": 29,
        "failRtMax": 0,
        "duration": 997,
        "samplerId": -1,
        "successRtMax": 133,
        "fullStat": {
          "requestBytesSum": 629926,
          "successRtAvg": 33,
          "successRtMin": 29,
          "successRtSum": 174551,
          "count": 5206,
          "rtSeg99": 53,
          "successTps": 2397.9732842008293,
          "rtSeg90": 36,
          "rtSeg50": 32,
          "rtSeg99Sum": 53,
          "rtAvg": 33.528812908182864,
          "rtMin": 29,
          "failRtMax": 0,
          "duration": 2171,
          "successCount": 5206,
          "rtSegStatCount": 1,
          "tps": 2397.9732842008293
        },
        "successCount": 2971,
        "failRtSum": 0,
        "failCount": 0,
        "count": 2971,
        "concurrency": 100,
        "successTps": 2979.939819458375,
        "tps": 2979.939819458375,
        "failRtAvg": 0,
        "failRtMin": 0,
        "rtMax": 133
      }
    ],
    "SceneId": "DYYPZIH",
    "SceneName": "test",
    "StageName": "任务执行",
    "StartTimeTS": 1639970040000,
    "Status": "RUNNING",
    "Vum": 100
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	ReportNotExist	The report does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.