GetOpenJMeterScene - Performance Testing - Alibaba Cloud Documentation Center

Retrieves the details of a JMeter scenario.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SceneId	string	Yes	The scenario ID.	DYYPZIH

Response parameters

Parameter	Type	Description	Example
	object	The response that is returned.
Code	string	The system status code.	200
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message. This parameter is empty if the request is successful.	空
RequestId	string	The request ID.	A8E16480-15C1-555A-922F-B736A005E52D
Scene	object	The details of the scenario.
AgentCount	integer	The number of stress testing agents. Each agent supports a maximum of 500 concurrent users.	2
BaseInfo	object	The basic information.
CreateName	string	The name of the user who created the scenario.	张三
ModifyName	string	The name of the user who last modified the scenario.	里斯
OperateType	string	The operation type.	保存去压测
Principal	string	The owner of the stress testing scenario.	test-person
Remark	string	The remarks.	小心压测
Resource	string	The source of the scenario.	create
Concurrency	integer	The maximum number of concurrent users.	1000
ConstantThroughputTimerType	string	The type of the constant throughput timer.	STAND_ALONE
DnsCacheConfig	object	The DNS configuration.
ClearCacheEachIteration	boolean	Indicates whether to clear the cache in each iteration.	false
DnsServers	array	The DNS servers.
	string	A DNS server.	["8.8.8.8"]
HostTable	object	The domain name bindings.	{"server.com":"6.6.6.6"}
Duration	integer	The duration of the stress test, in seconds.	600
EnvironmentId	string	The environment ID.	EEDT7
FileList	array<object>	The list of files.
	object	The file details.
FileName	string	The file name.	json.jar
FileOssAddress	string	The Object Storage Service (OSS) URL of the file.	https://test.oss-cn-shanghai.aliyuncs.com/json.jar
FileSize	integer	The file size, in bytes.	700
FileType	string	The file type.	jar
Id	integer	The file ID.	61660
Md5	string	The MD5 hash of the JAR package.	43B584026CE5E570F3DE638FA7EEF9E0
SplitCsv	boolean	Indicates whether to chunk the CSV file.	false
IsVpcTest	boolean	Indicates whether to perform stress testing in a VPC.	false
MaxRps	integer	The maximum number of records per second (RPS). This parameter is valid only in RPS mode.	true
Mode	string	The stress testing mode. `concurrency_mode` indicates concurrent mode, and `tps_mode` indicates RPS mode.	concurrency_mode
Pool	string	The source of the stress testing traffic. An empty string specifies that traffic originates from the internet. `intranet-vpc` specifies that traffic originates from a VPC.	VPC
RampUp	integer	The ramp-up period, in seconds.	100
RegionId	string	The region ID. Configure this parameter for stress testing in a VPC.	cn-beijing
RegionalCondition	array<object>	The custom regional configuration for stress testing agents.
	object	The number of stress testing agents in a single region.
Amount	integer	The number of stress testing agents.	1
Region	string	The region ID.	cn-hangzhou
SceneId	string	The scenario ID.	DYYPZIH
SceneName	string	The scenario name.	test
SecurityGroupId	string	The security group ID. Configure this parameter for stress testing in a VPC.	sg-2zeid0dd7bhahsgdahspaly
StartConcurrency	integer	The initial number of concurrent users. This parameter is valid only in concurrent mode.	true
StartRps	integer	The initial RPS. This parameter is valid only in RPS mode.	true
Steps	integer	The number of ramp-up steps. The pressure is applied based on the following rules:	3
SyncTimerType	string	The type of the synchronization timer.	GLOBAL
TestFile	string	The test file.	baidu.jmx
VSwitchId	string	The vSwitch ID. Configure this parameter for stress testing in a VPC.	vsw-2zehsgdhsahw1r
VpcId	string	The VPC ID. Configure this parameter for stress testing in a VPC.	vpc-2ze2sahjdgahsebjkqhf4pyj
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "HttpStatusCode": 200,
  "Message": "空",
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "Scene": {
    "AgentCount": 2,
    "BaseInfo": {
      "CreateName": "张三",
      "ModifyName": "里斯",
      "OperateType": "保存去压测",
      "Principal": "test-person",
      "Remark": "小心压测",
      "Resource": "create"
    },
    "Concurrency": 1000,
    "ConstantThroughputTimerType": "STAND_ALONE",
    "DnsCacheConfig": {
      "ClearCacheEachIteration": false,
      "DnsServers": [
        "[\"8.8.8.8\"]"
      ],
      "HostTable": {
        "server.com": "6.6.6.6"
      }
    },
    "Duration": 600,
    "EnvironmentId": "EEDT7",
    "FileList": [
      {
        "FileName": "json.jar",
        "FileOssAddress": "https://test.oss-cn-shanghai.aliyuncs.com/json.jar",
        "FileSize": 700,
        "FileType": "jar",
        "Id": 61660,
        "Md5": "43B584026CE5E570F3DE638FA7EEF9E0",
        "SplitCsv": false
      }
    ],
    "IsVpcTest": false,
    "MaxRps": 0,
    "Mode": "concurrency_mode",
    "Pool": "VPC",
    "RampUp": 100,
    "RegionId": "cn-beijing",
    "RegionalCondition": [
      {
        "Amount": 1,
        "Region": "cn-hangzhou"
      }
    ],
    "SceneId": "DYYPZIH",
    "SceneName": "test",
    "SecurityGroupId": "sg-2zeid0dd7bhahsgdahspaly",
    "StartConcurrency": 0,
    "StartRps": 0,
    "Steps": 3,
    "SyncTimerType": "GLOBAL",
    "TestFile": "baidu.jmx",
    "VSwitchId": "vsw-2zehsgdhsahw1r",
    "VpcId": "vpc-2ze2sahjdgahsebjkqhf4pyj"
  },
  "Success": true
}

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.