ListEnvs - 环境列表

根据条件列出JMeter环境。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pts:ListEnvs
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageNumberinteger

请求第 N 页的环境信息。

1
PageSizeinteger

当前页的请求环境数,即一页所包含的环境数量。

10
EnvIdstring

需查询的环境 ID(为精确查询)。

10YPA8H
EnvNamestring

需查询的环境名称关键字(模糊查询)。

test-create

返回参数

名称类型描述示例值
object

返回示例。

Codestring

系统状态码,若成功则不返回该字段。

Envsarray<object>

环境列表

Envobject

环境列表。

CreateTimelong

创建时间。

1637053715165
EnvIdstring

环境 ID。

86S1LH
EnvNamestring

环境名。

test-create
EnvVersionstring

所依赖的 JMeter 版本。

5.0
Filesarray<object>

包含的 JAR 包。

Fileobject

文件详情。

FileIdlong

文件 ID。

61660
FileNamestring

文件名。

json.jar
FileOssAddressstring

文件的 OSS 地址。

https://test.oss-cn-shanghai.aliyuncs.com/json.jar
FileSizelong

文件大小,单位为 Byte。

788
Md5string

JAR 包的 MD5 值。

43B584026CE5E570F3DE638FA7EEF9E0
ModifiedTimelong

修改时间。

1637053719165
Propertiesarray<object>

JMeter 属性。

propertiesobject

属性详情。

Descriptionstring

描述。

远程主机
Namestring

属性名。

remote_hosts
Valuestring

属性值。

127.0.0.1
RelatedScenesarray

关联的场景。

RelatedScenestring

关联的场景详情。

[10YPA8H, 0PYP8WH]
RunningScenesarray

运行中的场景 ID。

RunningScenestring

场景 ID 详情。

[10YPA8H, 0PYP8WH]
UsedCapacitylong

环境文件的总大小。

26668
HttpStatusCodeinteger

HTTP 状态码,若成功则不返回该字段。

Messagestring

错误提示信息,若成功则不返回该字段。

PageNumberinteger

返回第 N 页环境信息。

1
PageSizeinteger

返回环境数。

10
RequestIdstring

请求 ID。

A8E16480-15C1-555A-922F-B736A005E52D
Successboolean

是否成功。

  • true:成功
  • false:失败
true
TotalCountlong

查询到的环境总数。

100

示例

正常返回示例

JSON格式

{
  "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
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2021-11-23OpenAPI 错误码发生变更查看变更详情
2021-11-19新增 OpenAPI查看变更详情