调用ListEnvs获取环境列表_性能测试(PTS)-阿里云帮助中心

根据条件列出JMeter环境。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pts:ListEnvs

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	是	请求第 N 页的环境信息。	1
PageSize	integer	是	当前页的请求环境数，即一页所包含的环境数量。	10
EnvId	string	否	需查询的环境 ID（为精确查询）。	10YPA8H
EnvName	string	否	需查询的环境名称关键字（模糊查询）。	test-create

返回参数

名称	类型	描述	示例值
	object	返回示例。
TotalCount	integer	查询到的环境总数。	100
RequestId	string	请求 ID。	A8E16480-15C1-555A-922F-B736A005E52D
Message	string	错误提示信息，若成功则不返回该字段。
PageSize	integer	返回环境数。	10
PageNumber	integer	返回第 N 页环境信息。	1
Envs	array<object>	环境列表
	object	环境列表。
CreateTime	integer	创建时间。	1637053715165
RunningScenes	array	运行中的场景 ID。
	string	场景 ID 详情。	[10YPA8H, 0PYP8WH]
EnvVersion	string	所依赖的 JMeter 版本。	5.0
ModifiedTime	integer	修改时间。	1637053719165
Files	array<object>	包含的 JAR 包。
	object	文件详情。
FileSize	integer	文件大小，单位为 Byte。	788
Md5	string	JAR 包的 MD5 值。	43B584026CE5E570F3DE638FA7EEF9E0
FileName	string	文件名。	json.jar
FileOssAddress	string	文件的 OSS 地址。	https://test.oss-cn-shanghai.aliyuncs.com/json.jar
FileId	integer	文件 ID。	61660
RelatedScenes	array	关联的场景。
	string	关联的场景详情。	[10YPA8H, 0PYP8WH]
UsedCapacity	integer	环境文件的总大小。	26668
EnvName	string	环境名。	test-create
EnvId	string	环境 ID。	86S1LH
Properties	array<object>	JMeter 属性。
	object	属性详情。
Name	string	属性名。	remote_hosts
Value	string	属性值。	127.0.0.1
Description	string	描述。	远程主机
HttpStatusCode	integer	HTTP 状态码，若成功则不返回该字段。
Code	string	系统状态码，若成功则不返回该字段。
Success	boolean	是否成功。 true：成功 false：失败	true

示例

正常返回示例

JSON格式

{
  "TotalCount": 100,
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "Message": "",
  "PageSize": 10,
  "PageNumber": 1,
  "Envs": [
    {
      "CreateTime": 1637053715165,
      "RunningScenes": [
        "[10YPA8H, 0PYP8WH]"
      ],
      "EnvVersion": "5.0",
      "ModifiedTime": 1637053719165,
      "Files": [
        {
          "FileSize": 788,
          "Md5": "43B584026CE5E570F3DE638FA7EEF9E0",
          "FileName": "json.jar",
          "FileOssAddress": "https://test.oss-cn-shanghai.aliyuncs.com/json.jar",
          "FileId": 61660
        }
      ],
      "RelatedScenes": [
        "[10YPA8H, 0PYP8WH]"
      ],
      "UsedCapacity": 26668,
      "EnvName": "test-create",
      "EnvId": "86S1LH",
      "Properties": [
        {
          "Name": "remote_hosts",
          "Value": "127.0.0.1",
          "Description": "远程主机"
        }
      ]
    }
  ],
  "HttpStatusCode": 0,
  "Code": "",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
503	EnvNotExist	The env does not exist.	环境不存在

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。