ListPtsReports - Performance Testing - Alibaba Cloud Documentation Center

Lists PTS report summaries that match the specified criteria.

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 supports 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:ListPtsReports

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number. The value starts from 1.	1
PageSize	integer	Yes	The number of reports to return on each page.	10
SceneId	string	No	The ID of the scenario.	1PDAL8H
ReportId	string	No	The report ID.	7RLPM3Y2
BeginTime	integer	No	The start timestamp of the report, in milliseconds.	1637115303000
EndTime	integer	No	The end timestamp of the report, in milliseconds.	1637115306000
Keyword	string	No	The report keyword.	test

Response parameters

Parameter	Type	Description	Example
	object	The sample response.
Code	string	The system status code.	200
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message. This parameter is an empty string if the request is successful.	空
PageNumber	integer	The returned page number. The value starts from 1.	1
PageSize	integer	The number of reports returned on each page.	10
Reports	array<object>	The report information.
	object	The report details.
ActualStartTime	integer	The timestamp when the stress test started, in milliseconds.	1637157073000
Duration	string	The duration of the stress test.	10分钟
ReportId	string	The report ID.	7RLPM3Y2
ReportName	string	The report name.	test
Vum	integer	The number of VUMs consumed.	1000
RequestId	string	The request ID.	A8E4LR80-15P1-555A-9ZZF-B736AZO5E5ID
Success	boolean	Indicates whether the request was successful. A value of `true` indicates success. A value of `false` indicates failure.	true
TotalCount	integer	The total number of reports that match the query conditions.	100

Examples

Success response

JSON format

{
  "Code": "200",
  "HttpStatusCode": 200,
  "Message": "空",
  "PageNumber": 1,
  "PageSize": 10,
  "Reports": [
    {
      "ActualStartTime": 1637157073000,
      "Duration": "10分钟",
      "ReportId": "7RLPM3Y2",
      "ReportName": "test",
      "Vum": 1000
    }
  ],
  "RequestId": "A8E4LR80-15P1-555A-9ZZF-B736AZO5E5ID",
  "Success": true,
  "TotalCount": 100
}

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.