调用GetOpenJMeterScene获取场景详情_性能测试(PTS)-阿里云帮助中心

获得JMeter场景详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
pts:GetOpenJMeterScene		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
SceneId	string	是	场景 ID。	DYYPZIH

返回参数

名称	类型	描述	示例值
	object	返回示例。
Code	string	系统状态码。	200
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	错误提示信息，若成功则为空。	空
RequestId	string	请求 ID。	A8E16480-15C1-555A-922F-B736A005E52D
Scene	object	场景详情。
AgentCount	integer	施压机数量。一台施压机最多支持 500 并发。	2
BaseInfo	object	基本信息。
CreateName	string	创建人名。	张三
ModifyName	string	修改人名。	里斯
OperateType	string	操作类型。	保存去压测
Principal	string	场景压测负责人。	test-person
Remark	string	备注。	小心压测
Resource	string	场景来源。	create
Concurrency	integer	最大并发。	1000
ConstantThroughputTimerType	string	固定吞吐量定时器类型。	STAND_ALONE
DnsCacheConfig	object	DNS 配置。
ClearCacheEachIteration	boolean	是否清除缓存。	false
DnsServers	array	DNS 服务器
dnsServers	string	DNS 服务器。	["8.8.8.8"]
HostTable	object	域名绑定。	{"server.com":"6.6.6.6"}
Duration	integer	压测持续时间，单位为 s。	600
EnvironmentId	string	环境 ID。	EEDT7
FileList	array<object>	文件列表。
fileList	object	文件详情。
FileName	string	文件名。	json.jar
FileOssAddress	string	文件的 OSS 地址。	https://test.oss-cn-shanghai.aliyuncs.com/json.jar
FileSize	long	文件大小，单位为 Byte。	700
FileType	string	文件类型。	jar
Id	long	文件 ID。	61660
Md5	string	JAR 包的 MD5 值。	43B584026CE5E570F3DE638FA7EEF9E0
SplitCsv	boolean	是否切分。	false
IsVpcTest	boolean	是否为 VPC 压测。	false
MaxRps	integer	最大 RPS，RPS 模式下生效。	true
Mode	string	施压模式，concurrency_mode 表示并发压测,tps_mode 表示 RPS 压测	concurrency_mode
Pool	string	压力来源。“”表示公网，intranet-vpc 表示 VPC	VPC
RampUp	integer	递增时间，单位为 s。	100
RegionId	string	地域 ID，在 VPC 压测时配置。	cn-beijing
RegionalCondition	array<object>	施压机地域定制
regionalCondition	object	单地域施压机数量
Amount	integer	施压机数量	1
Region	string	地域 id	cn-hangzhou
SceneId	string	场景 ID。	DYYPZIH
SceneName	string	场景名。	test
SecurityGroupId	string	安全组 ID，在 VPC 压测时配置。	sg-2zeid0dd7bhahsgdahspaly
StartConcurrency	integer	起始并发，并发模式下生效。	true
StartRps	integer	起始的 RPS，RPS 模式下生效。	true
Steps	integer	递增阶梯数。预热时间和预热阶段数都不进行配置时，使用固定压力值；只配置预热时间，不配置阶段数时，使用均匀递增；预热时间和阶段数都进行配置时，且 Steps<rampUp，使用阶梯递增。不可只配置 Steps，而不配置 rampUp。如果使用此配置，则默认使用固定压力值。	3
SyncTimerType	string	同步定时器类型。	GLOBAL
TestFile	string	测试文件。	baidu.jmx
VSwitchId	string	交换机 ID，在 VPC 压测时配置。	vsw-2zehsgdhsahw1r
VpcId	string	VPC 的 ID，在 VPC 压测时配置。	vpc-2ze2sahjdgahsebjkqhf4pyj
Success	boolean	是否成功。 true：成功 false：失败	true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
403	SceneNotExist	The scene does not exist.	场景不存在

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

变更历史

变更时间	变更内容概要	操作
2024-01-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-12-01	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-11-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-11-19	新增 OpenAPI	查看变更详情