ListOpenJMeterScenes - Performance Testing - Alibaba Cloud Documentation Center

Retrieves a list of JMeter scenarios.

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

*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 scenarios to return on each page.	10
SceneId	string	No	The scenario ID.	DYYPZIH
SceneName	string	No	The scenario name.	test

Response parameters

Parameter	Type	Description	Example
	object	The sample response.
Code	string	The status code of the request. 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.
JMeterScene	array<object>	The information about the scenarios.
	object	The details of a scenario.
DurationStr	string	The duration of the stress test.	10分钟
SceneId	string	The scenario ID.	DYYPZIH
SceneName	string	The scenario name.	test
Status	string	The status of the scenario. Valid values include the following: PREPARING: The scenario is being prepared. PREPARED: The scenario is prepared. STARTING: The scenario is starting. RUNNING: The scenario is running. STOPPING: The scenario is stopping. STOPPED: The scenario is stopped.	STOPPED
Message	string	The error message. This parameter is left empty if the request is successful.
PageNumber	integer	The returned page number.	1
PageSize	integer	The number of scenarios returned on the current 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 scenarios.	100

Examples

Success response

JSON format

{
  "Code": "",
  "HttpStatusCode": 0,
  "JMeterScene": [
    {
      "DurationStr": "10分钟",
      "SceneId": "DYYPZIH",
      "SceneName": "test",
      "Status": "STOPPED"
    }
  ],
  "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	SceneNotExist	The scene does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.