使用SavePtsScene API保存或修改性能测试场景-性能测试-阿里云

保存或修改场景。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

pts:SavePtsScene

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Scene	object	是	场景详细信息。
SceneId	string	否	场景 ID。没有传场景 ID 表示新建场景，传场景 ID 表示更新场景。	IUYAHGJ
SceneName	string	是	场景名。	test
RelationList	array	是	链路配置。
	array<object>	否
RelationName	string	是	链路名。	链路1
RelationId	string	否	链路 ID。	1
ApiList	array	是	链路下的 API 信息。
	array<object>	否
ApiName	string	是	API 名称。	api
Url	string	是	压测 URL。	http://www.example.com
Method	string	是	请求方法。	GET
ApiId	string	否	API 的 ID。	1
ExportList	array	否	出参。
	object	否
ExportType	string	否	出参来源。包括：请求体（BODY_TEXT）请求体（BODY_JSON）请求头（HEADER）响应状态码（STATUS_CODE）	BODY_JSON
ExportName	string	否	出参名。	test
Count	string	否	第几个匹配项。可以是数字或 Random，当出参来源为请求体（BODY_TEXT）时需要填写该项。	0
ExportValue	string	否	出参的解析表达式。	data.itemlist[0]
HeaderList	array	否	Header 请求头。
	object	否
HeaderName	string	否	Header 参数名。	Accept-Encoding
HeaderValue	string	否	参数对应的值。	gzip, deflate, br
CheckPointList	array	否	检查点。
	object	否
Operator	string	否	检查点条件。	ctn
ExpectValue	string	否	检查内容，即期望值。	111
CheckType	string	否	检查点类型。包括：响应 Body（BODY_TEXT）响应 Header（HEADER）响应状态码（STATUS_CODE）出参（EXPORTED_PARAM）	EXPORTED_PARAM
CheckPoint	string	否	检查对象。当`type=HEADER`时，表示 Header 中的字段；当`type=EXPORTED_PARAM` 时，表示出参名。	userId
TimeoutInSecond	integer	否	API 超时时间。单位秒，默认 5s，取值范围[1-60]。	5
Body	object	否	请求 Body。
ContentType	string	否	Body 类型，默认`application/x-www-form-urlencoded`。	application/x-www-form-urlencoded
BodyValue	string	否	body 的实际内容。例如， {"key1":"value2","key2":"value2"}。	{\"global\":\"${global}\",\"name\":\"${name}\"}
RedirectCountLimit	integer	是	重定向次数。只能是 0（允许重定向）或者 10（不允许重定向），用户根据自己的情况配置。	0
FileParameterExplainList	array	否	链路中的文件参数配置信息。
	object	否
FileName	string	是	文件名。	fileName.csv
FileParamName	string	是	文件使用的参数列名。	name,uid,age
BaseFile	boolean	否	是否作为基准文件。	true
CycleOnce	boolean	否	文件是否轮询一次。	true
LoadConfig	object	是	施压配置。
TestMode	string	是	施压模式。包括：并发模式（concurrency_mode） RPS 模式（tps_mode）	concurrency_mode
Configuration	object	是	场景施压量级配置信息。
AllRpsBegin	integer	否	所有 API 的起始 RPS 总值。均分给每个 API，在 RPS 模式下使用，若不设置该值，则 apiLoadConfig 必须填写。	100
AllRpsLimit	integer	否	所有 API 的最大 RPS 总值。均分给每个 API，在 RPS 模式下使用，若不设置该值，则 apiLoadConfig 必须填写。	100
AllConcurrencyBegin	integer	否	所有链路的起始并发总值。均分给每个链路，在并发模式下使用，若不设置该值，则 relationLoadConfig 必须填写。	100
AllConcurrencyLimit	integer	否	所有链路的最大并发总值。均分给每个链路，在并发模式下使用，若不设置该值，则 relationLoadConfig 必须填写。	100
MaxRunningTime	integer	是	施压时长。单位分钟，取值范围[1-1440]。	10
AutoStep	boolean	否	是否自动递增。只有在并发模式下有效，即`testMode=concurrency_mode`时有效。	true
AgentCount	integer	否	指定机器数。并发需要＞250（RPS＞2000）时使用，最大扩展机器数不能超过最大并发数/250（最大 RPS/2000）。	1
Increment	integer	否	递增百分比。取值范围[10,100]，取值需是 10 的倍数。只在并发模式且同时是自动递增模式下有效，即`testMode=concurrency_mode`且`autoStep=true`时有效。	30
KeepTime	integer	否	单量级持续时长。单位分钟，该时长需小于施压时长 maxRunningTime。	3
ApiLoadConfigList	array	否	API 的起始、最大 RPS 值设置，在 RPS 模式下使用。
	object	否
ApiId	string	是	API ID。	1
RpsLimit	integer	是	最大 RPS 值。	100
RpsBegin	integer	是	起始 RPS 值。	100
VpcLoadConfig	object	否	VPC 配置。
VpcId	string	是	VPC ID。	vpc-akjhsdajgjsfggahjkga
VSwitchId	string	是	交换机 ID。	vsw-skjfhlahsljkhsfalkjdoiw
SecurityGroupId	string	是	安全组 ID。	sg-jkasgfieiajidsjakjscb
RegionId	string	是	地域 ID。	cn-beijing
RelationLoadConfigList	array	否	链路的起始、最大并发值设置，在并发模式下使用。
	object	否
RelationId	string	否	链路 ID。	1
ConcurrencyLimit	integer	是	最大并发数。	100
ConcurrencyBegin	integer	是	起始并发。	100
AdvanceSetting	object	否	高级设置。
LogRate	integer	否	日志采样率。取值范围[1,50]，大于 2 时取值需要是 10 的倍数，即[1,10,20,30,40,50]。	1
DomainBindingList	array	否	域名绑定 IP 关系。
	object	否
Domain	string	否	域名。	www.example.com
Ips	array	否	对应的 IP。
	string	否		["192.168.1.1","192.168.1.2"]
ConnectionTimeoutInSecond	integer	否	超时时间，单位秒。	5
SuccessCode	string	否	新增成功状态码，多个需用半角逗号（,）隔开。	205
GlobalParameterList	array	否	全局自定义参数。
	object	否
ParamName	string	否	参数名。	global
ParamValue	string	否	全局参数值，不可参数化。	11111
FileParameterList	array	否	文件参数。
	object	否
FileName	string	否	文件名。	test.csv
FileOssAddress	string	否	您自己的 OSS 文件地址，要求公网可访问。	https://jmeter-pts-testing-version.oss-cn-shanghai.aliyuncs.com/param-file.csv

返回参数

名称	类型	描述	示例值
	object
Message	string	错误信息提示，若成功则为空。	空
RequestId	string	请求 ID。	A8E16480-15C1-555A-922F-B736A005E52D
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	系统状态码。	200
Success	boolean	是否成功。 true：成功 false：失败	true
SceneId	string	场景 ID	IUYAHGJ

示例

正常返回示例

JSON格式

{
  "Message": "空",
  "RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
  "HttpStatusCode": 200,
  "Code": "200",
  "Success": true,
  "SceneId": "IUYAHGJ"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ModifyPtsSceneFail	The scene does not exit

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

变更历史

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