All Products
Search
Document Center

Performance Testing:ListOpenJMeterScenes

Last Updated:Oct 31, 2024

Queries JMeter scenarios based on a specified condition.

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of scenarios to return.

10
SceneIdstringNo

The scenario ID.

DYYPZIH
SceneNamestringNo

The scenario name.

test

Response parameters

ParameterTypeDescriptionExample
object

The sample response.

Codestring

The system status code. If the request was successful, this parameter is not returned.

200
HttpStatusCodeinteger

The HTTP status code. If the request was successful, this parameter is not returned.

200
JMeterScenearray<object>

The scenarios.

jMeterSceneobject

The details of the scenario.

DurationStrstring

The stress testing duration.

SceneIdstring

The scenario ID.

DYYPZIH
SceneNamestring

The scenario name.

test
Statusstring

The status of the scenario. Valid values:

  • PREPARING: The scenario is being prepared.
  • PREPARED: The scenario has been prepared.
  • STARTING: The scenario is starting.
  • RUNNING: The scenario is running.
  • STOPPING: The scenario is being stopped.
  • STOPPED: The scenario waits for startup
STOPPED
Messagestring

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

PageNumberinteger

The number of the returned page.

1
PageSizeinteger

The number of returned scenarios.

10
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 returned scenarios.

100

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "HttpStatusCode": 200,
  "JMeterScene": [
    {
      "DurationStr": "",
      "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 codeError codeError message
403SceneNotExistThe scene does not exist.

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

Change history

Change timeSummary of changesOperation
2024-01-23The Error code has changed. The response structure of the API has changedView Change Details
2021-11-23The Error code has changedView Change Details
2021-11-19Add OperationView Change Details