GetJMeterReportDetails - Performance Testing - Alibaba Cloud Documentation Center

Obtains the details of a JMeter report.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
pts:GetJMeterReportDetails	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ReportId	string	Yes	The report ID.	KS2YE3J2

Response parameters

Parameter	Type	Description	Example
	object	GetJMeterReportDetailsResponse
Code	string	The system status code. If the request was successful, this parameter is not returned.	4001
CodeKey	string	The code key that corresponds to the key in Medusa. If no code key is available, or if the content corresponding to the code key fails to be obtained or is empty, the returned message is displayed as the default information.
DocumentUrl	string	The URL used to access the document.
DynamicCtx	string	The returned dynamic contents that are separated by the && operator.
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message. If the request was successful, this parameter is not returned.
ReportOverView	object	The details of the report.
AgentCount	integer	The number of used engines.	1
EndTime	string	The end of the queried time range.	2023-05-03 10:45:11
ReportId	string	The report ID.	GHB56VD
ReportName	string	The report name.
StartTime	string	The beginning of the queried time range.	2023-05-03 10:35:11
Vum	long	The consumed Virtual User Minutes (VUM).	4452
RequestId	string	The request ID.	A8E16480-15C1-555A-922F-B736A005E52D
SamplerMetricsList	array<object>	The dimensions of APIs.
SamplerMetricsList	object	The dimensions of the API. An API has only one entry.
AllCount	long	The total number of requests.	731
ApiName	string	The API name.
AvgRt	double	The average RT. Unit: milliseconds.	44.2
AvgTps	double	The average TPS.	12
FailCountReq	long	The request failure rate.	10
MaxRt	double	The maximum RT. Unit: milliseconds.	78
MinRt	double	The minimum RT. Unit: milliseconds.	11
Seg75Rt	double	The 75th percentile of RT. Unit: milliseconds.	22.4
Seg90Rt	double	The 90th percentile of RT. Unit: milliseconds.	65
Seg99Rt	double	The 99th percentile of RT. Unit: milliseconds.	77
SuccessRateReq	double	The request success rate. The parameter value must be a non-negative number less than or equal to 100.	100
SceneMetrics	object	The dimensions of the whole scenario.
AllCount	long	The total number of requests.	717
AvgRt	double	The average response time (RT). Unit: milliseconds.	23
AvgTps	double	The average transactions per second (TPS).	78
FailCountReq	long	The request failure rate.	34
Seg90Rt	double	The 90th percentile of RT. Unit: milliseconds.	35
Seg99Rt	double	The 99th percentile of RT. Unit: milliseconds.	56
SuccessRateReq	double	The request success rate. The parameter value must be a non-negative number less than or equal to 100.	0.99
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Code": 4001,
  "CodeKey": "",
  "DocumentUrl": "",
  "DynamicCtx": "",
  "HttpStatusCode": 200,
  "Message": "",
  "ReportOverView": {
    "AgentCount": 1,
    "EndTime": "2023-05-03 10:45:11",
    "ReportId": "GHB56VD",
    "ReportName": "",
    "StartTime": "2023-05-03 10:35:11",
    "Vum": 4452
  },
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "SamplerMetricsList": [
    {
      "AllCount": 731,
      "ApiName": "",
      "AvgRt": 44.2,
      "AvgTps": 12,
      "FailCountReq": 10,
      "MaxRt": 78,
      "MinRt": 11,
      "Seg75Rt": 22.4,
      "Seg90Rt": 65,
      "Seg99Rt": 77,
      "SuccessRateReq": 100
    }
  ],
  "SceneMetrics": {
    "AllCount": 717,
    "AvgRt": 23,
    "AvgTps": 78,
    "FailCountReq": 34,
    "Seg90Rt": 35,
    "Seg99Rt": 56,
    "SuccessRateReq": 0.99
  },
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history