GetJMeterSamplingLogs - Performance Testing - Alibaba Cloud Documentation Center

Retrieves the sampling logs for a JMeter sampler based on specified conditions.

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

*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 sampling log entries to return on each page.	10
BeginTime	integer	No	The start time. This is a UNIX timestamp in milliseconds.	1637157073000
EndTime	integer	No	The end time. This is a UNIX timestamp in milliseconds.	1637157076000
ReportId	string	Yes	The report ID.	7R4RE352
AgentId	integer	No	The ID of the stress testing engine. This parameter is not yet available.	14238000
SamplerId	integer	No	The serial number of the sampler. The value starts from 0.	0
Success	boolean	No	Indicates whether the sampling is successful.	true
Thread	string	No	The thread name. Fuzzy search is supported. The value is tokenized by spaces.	mian
Keyword	string	No	The keyword. Use this parameter to perform a fuzzy search by SceneName or an exact search by SceneId.	test
MinRT	integer	No	The minimum response time (RT). Unit: ms.	0
MaxRT	integer	No	The maximum response time (RT). Unit: ms.	1000
ResponseCode	string	No	The response code.	200

Response parameters

Parameter	Type	Description	Example
	object	The response.
Code	string	The system status code. This parameter is not returned if the request is successful.
HttpStatusCode	integer	The HTTP status code. This parameter is not returned if the request is successful.
Message	string	The error message. This parameter is not returned if the request is successful.
PageNumber	integer	The returned page number.	1
PageSize	integer	The number of log entries returned.	10
RequestId	string	The request ID.	A8E16480-15C1-555A-922F-B736A005E52D
SampleResults	array	The sampling results of the sampler.
	string	The sampling result of the sampler.	{ "assertionResults":[], "endTimeTS":1650280351514, "dataEncoding":"utf-8", "latency":11, "samplerData":"GET http://testdomain/\n\nGET data:\n\n\n[no cookies]\n", "httpMethod":"GET", "subResults":[], "idleTime":0, "cookies":"", "responseCode":"200", "responseDataAsString":"response data", "startTimeTS":1650280351503, "requestByteCount":136, "instanceId":0, "samplerId":0, "connectTime":0, "sceneId":276685, "startTime":"2022-04-18T19:12Z", "planId":1736797, "requestData":"", "contentType":"text/html", "responseDataTruncated":false, "dataType":"text", "mediaType":"text/html", "requestDataTruncated":false, "responseByteCount":2497, "threadName":"线程组 1-1", "url":"http:/testdomain", "requestHeaders":"Connection: keep-alive\nx-pts-test: 1\nHost: testdomain\nUser-Agent: Apache-HttpClient/4.5.6 (Java/11.0.7.7-AJDK)\n", "responseHeaders":"HTTP/1.1 200 OK\nContent-Length: 2381\nContent-Type: text/html\nServer: bfe\nDate: Mon, 18 Apr 2022 11:12:31 GMT\n", "success":true, "headersSize":116, "bodySize":2381, "endTime":"2022-04-18T19:12Z", "responseMessage":"OK", "taskId":17367970000, "elapsedTime":11 }
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

{
  "Code": "",
  "HttpStatusCode": 0,
  "Message": "",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "SampleResults": [
    "{         \"assertionResults\":[],         \"endTimeTS\":1650280351514,         \"dataEncoding\":\"utf-8\",         \"latency\":11,         \"samplerData\":\"GET http://testdomain/\\n\\nGET data:\\n\\n\\n[no cookies]\\n\",         \"httpMethod\":\"GET\",         \"subResults\":[],         \"idleTime\":0,         \"cookies\":\"\",         \"responseCode\":\"200\",         \"responseDataAsString\":\"response data\",         \"startTimeTS\":1650280351503,         \"requestByteCount\":136,         \"instanceId\":0,         \"samplerId\":0,         \"connectTime\":0,         \"sceneId\":276685,         \"startTime\":\"2022-04-18T19:12Z\",         \"planId\":1736797,         \"requestData\":\"\",         \"contentType\":\"text/html\",         \"responseDataTruncated\":false,         \"dataType\":\"text\",         \"mediaType\":\"text/html\",         \"requestDataTruncated\":false,         \"responseByteCount\":2497,         \"threadName\":\"线程组 1-1\",         \"url\":\"http:/testdomain\",         \"requestHeaders\":\"Connection: keep-alive\\nx-pts-test: 1\\nHost: testdomain\\nUser-Agent: Apache-HttpClient/4.5.6 (Java/11.0.7.7-AJDK)\\n\",         \"responseHeaders\":\"HTTP/1.1 200 OK\\nContent-Length: 2381\\nContent-Type: text/html\\nServer: bfe\\nDate: Mon, 18 Apr 2022 11:12:31 GMT\\n\",         \"success\":true,         \"headersSize\":116,         \"bodySize\":2381,         \"endTime\":\"2022-04-18T19:12Z\",         \"responseMessage\":\"OK\",         \"taskId\":17367970000,         \"elapsedTime\":11       }"
  ],
  "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.