ListEnvs - Performance Testing - Alibaba Cloud Documentation Center

Lists JMeter environments 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:ListEnvs

*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 environments to return on each page.	10
EnvId	string	No	The ID of the environment to query. This is a term query.	10YPA8H
EnvName	string	No	The keyword in the name of the environment to query. This is a fuzzy query.	test-create

Response parameters

Parameter	Type	Description	Example
	object	The sample response.
Code	string	The system status code. This parameter is not returned if the request is successful.
Envs	array<object>	The list of environments.
	object	The environment details.
CreateTime	integer	The time when the environment was created.	1637053715165
EnvId	string	The environment ID.	86S1LH
EnvName	string	The environment name.	test-create
EnvVersion	string	The JMeter version that the environment uses.	5.0
Files	array<object>	The included JAR packages.
	object	The file details.
FileId	integer	The file ID.	61660
FileName	string	The file name.	json.jar
FileOssAddress	string	The OSS address of the file.	https://test.oss-cn-shanghai.aliyuncs.com/json.jar
FileSize	integer	The file size, in bytes.	788
Md5	string	The MD5 hash of the JAR package.	43B584026CE5E570F3DE638FA7EEF9E0
ModifiedTime	integer	The time when the environment was last modified.	1637053719165
Properties	array<object>	The JMeter properties.
	object	The property details.
Description	string	The description.	远程主机
Name	string	The property name.	remote_hosts
Value	string	The property value.	127.0.0.1
RelatedScenes	array	The associated scenarios.
	string	The details of the associated scenarios.	[10YPA8H, 0PYP8WH]
RunningScenes	array	The IDs of running scenarios.
	string	The scenario ID details.	[10YPA8H, 0PYP8WH]
UsedCapacity	integer	The total size of the environment files.	26668
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 number of the returned page.	1
PageSize	integer	The number of returned environments.	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 environments that were found.	100

Examples

Success response

JSON format

{
  "Code": "",
  "Envs": [
    {
      "CreateTime": 1637053715165,
      "EnvId": "86S1LH",
      "EnvName": "test-create",
      "EnvVersion": "5.0",
      "Files": [
        {
          "FileId": 61660,
          "FileName": "json.jar",
          "FileOssAddress": "https://test.oss-cn-shanghai.aliyuncs.com/json.jar",
          "FileSize": 788,
          "Md5": "43B584026CE5E570F3DE638FA7EEF9E0"
        }
      ],
      "ModifiedTime": 1637053719165,
      "Properties": [
        {
          "Description": "远程主机",
          "Name": "remote_hosts",
          "Value": "127.0.0.1"
        }
      ],
      "RelatedScenes": [
        "[10YPA8H, 0PYP8WH]"
      ],
      "RunningScenes": [
        "[10YPA8H, 0PYP8WH]"
      ],
      "UsedCapacity": 26668
    }
  ],
  "HttpStatusCode": 0,
  "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
503	EnvNotExist	The env does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.