All Products
Search
Document Center

Performance Testing:ListJMeterReports

Last Updated:Jul 31, 2025

Queries JMeter reports based on specified conditions.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
pts:ListJMeterReportslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

The number of the report page to return.

1
PageSizeintegerYes

The number of reports to return.

10
SceneIdstringNo

The ID of the scenario whose report you want to view.

10YPA8H
ReportIdstringNo

The report ID.

7R4RE352
BeginTimelongNo

The beginning of the time range to query. Unit: ms.

1637115303000
EndTimelongNo

The end of the time range to query.

1637115306000
KeywordstringNo

The report keyword.

test

Response parameters

ParameterTypeDescriptionExample
object

The sample response.

Codestring

The system status code.

200
HttpStatusCodeinteger

The HTTP status code.

200
Messagestring

The returned message. If the request was successful, this parameter is left empty.

PageNumberinteger

The number of the returned report page.

1
PageSizeinteger

The number of returned reports.

10
Reportsarray<object>

The reports.

JMeterReportViewobject

The report.

ActualStartTimelong

The start time of the stress testing.

1637157073000
Durationstring

The stress testing duration.

ReportIdstring

The report ID.

7R4RE352
ReportNamestring

The report name.

test
Vumlong

The consumed Virtual User Minutes (VUM).

1000
RequestIdstring

The request ID.

A8E16480-15C1-555A-922F-B736A005E52D
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
TotalCountlong

The total number of reports returned based on the condition.

100

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "HttpStatusCode": 200,
  "Message": "",
  "PageNumber": 1,
  "PageSize": 10,
  "Reports": [
    {
      "ActualStartTime": 1637157073000,
      "Duration": "",
      "ReportId": "7R4RE352",
      "ReportName": "test",
      "Vum": 1000
    }
  ],
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "Success": true,
  "TotalCount": 100
}

Error codes

HTTP status codeError codeError message
403ReportNotExistThe report does not exist.

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

Change history

Change timeSummary of changesOperation
2021-11-23The Error code has changedView Change Details
2021-11-19Add OperationView Change Details