GetJMeterLogs - Performance Testing - Alibaba Cloud Documentation Center

Retrieves the run logs for a JMeter test. By default, this operation queries the logs from machine 0 and returns the total number of machines.

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:GetJMeterLogs

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	10
ReportId	string	Yes	The report ID.	KS2YE3J2
BeginTime	integer	No	The start time. This value is a UNIX timestamp in milliseconds.	1637115306000
EndTime	integer	No	The end time. This value is a UNIX timestamp in milliseconds.	1637115309000
AgentIndex	integer	No	If you specify an invalid index, the logs of engine 0 are returned.	0
Level	string	No	The log level. Valid values: ERROR WARN INFO: The default value. DEBUG TRACE	info
Thread	string	No	The thread name.	main
Keyword	string	No	The keyword to search for in the logs.	test

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
AgentCount	integer	The number of engines. You can use this value to specify the engine from which you want to retrieve logs.	3
Code	string	The status code. If the request is successful, this parameter is empty.
Logs	array<object>	The log entries.	{ "timeTS":1637114804326, "instanceId":0, "level":"INFO", "logger":"org.apache.jmeter.util.JMeterUtils", "sceneId":251546, "planId":1501546, "thread":"main", "time":"2021-11-17T10:06Z", "taskId":15015460000, "logText":"Setting Locale to en_EN\n" }
	object	The log record.	{ "timeTS": 1720492300643, "level": "INFO", "logger": "org.apache.jmeter.JMeter", "thread": "main", "logText": "os.version=4.18.0-348.2.1.el8_5.x86_64\n", "instanceId": 0, "time": "2024-07-09T10:31Z" }
Message	string	The error message. If the request is successful, this parameter is empty.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	A8E16480-15C1-555A-922F-B736A005E52D
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
TotalCount	integer	The total number of log entries.	100

Examples

Success response

JSON format

{
  "AgentCount": 3,
  "Code": "",
  "Logs": [
    {
      "timeTS": 1720492300643,
      "level": "INFO",
      "logger": "org.apache.jmeter.JMeter",
      "thread": "main",
      "logText": "os.version=4.18.0-348.2.1.el8_5.x86_64\n",
      "instanceId": 0,
      "time": "2024-07-09T10:31Z"
    }
  ],
  "Message": "",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "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.