文档

SavePtsScene - 保存或修改场景

更新时间:

保存或修改场景。

调试

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

授权信息

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

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

请求参数

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

场景详细信息。

SceneIdstring

场景 ID。没有传场景 ID 表示新建场景,传场景 ID 表示更新场景。

IUYAHGJ
SceneNamestring

场景名。

test
RelationListobject []

链路配置。

RelationNamestring

链路名。

链路1
RelationIdstring

链路 ID。

1
ApiListobject []

链路下的 API 信息。

ApiNamestring

API 名称。

api
Urlstring

压测 URL。

http://www.example.com
Methodstring

请求方法。

GET
ApiIdstring

API 的 ID。

1
ExportListobject []

出参。

ExportTypestring

出参来源。包括:

  • 请求体(BODY_TEXT)
  • 请求体(BODY_JSON)
  • 请求头(HEADER)
  • 响应状态码(STATUS_CODE)
BODY_JSON
ExportNamestring

出参名。

test
Countstring

第几个匹配项。可以是数字或 Random,当出参来源为请求体(BODY_TEXT)时需要填写该项。

0
ExportValuestring

出参的解析表达式。

data.itemlist[0]
HeaderListobject []

Header 请求头。

HeaderNamestring

Header 参数名。

Accept-Encoding
HeaderValuestring

参数对应的值。

gzip, deflate, br
CheckPointListobject []

检查点。

Operatorstring

检查点条件。

ctn
ExpectValuestring

检查内容,即期望值。

111
CheckTypestring

检查点类型。包括:

  • 响应 Body(BODY_TEXT)
  • 响应 Header(HEADER)
  • 响应状态码(STATUS_CODE)
  • 出参(EXPORTED_PARAM)
EXPORTED_PARAM
CheckPointstring

检查对象。

type=HEADER时,表示 Header 中的字段;当type=EXPORTED_PARAM 时,表示出参名。

userId
TimeoutInSecondinteger

API 超时时间。单位秒,默认 5s,取值范围[1-60]。

5
Bodyobject

请求 Body。

ContentTypestring

Body 类型,默认application/x-www-form-urlencoded

application/x-www-form-urlencoded
BodyValuestring

body 的实际内容。例如, {"key1":"value2","key2":"value2"}。

{\"global\":\"${global}\",\"name\":\"${name}\"}
RedirectCountLimitinteger

重定向次数。只能是 0(允许重定向)或者 10(不允许重定向),用户根据自己的情况配置。

0
FileParameterExplainListobject []

链路中的文件参数配置信息。

FileNamestring

文件名。

fileName.csv
FileParamNamestring

文件使用的参数列名。

name,uid,age
BaseFileboolean

是否作为基准文件。

true
CycleOnceboolean

文件是否轮询一次。

true
LoadConfigobject

施压配置。

TestModestring

施压模式。包括:

  • 并发模式(concurrency_mode)
  • RPS 模式(tps_mode)
concurrency_mode
Configurationobject

场景施压量级配置信息。

AllRpsBegininteger

所有 API 的起始 RPS 总值。

均分给每个 API,在 RPS 模式下使用,若不设置该值,则 apiLoadConfig 必须填写。

100
AllRpsLimitinteger

所有 API 的最大 RPS 总值。

均分给每个 API,在 RPS 模式下使用,若不设置该值,则 apiLoadConfig 必须填写。

100
AllConcurrencyBegininteger

所有链路的起始并发总值。

均分给每个链路,在并发模式下使用,若不设置该值,则 relationLoadConfig 必须填写。

100
AllConcurrencyLimitinteger

所有链路的最大并发总值。

均分给每个链路,在并发模式下使用,若不设置该值,则 relationLoadConfig 必须填写。

100
MaxRunningTimeinteger

施压时长。单位分钟,取值范围[1-1440]。

10
AutoStepboolean

是否自动递增。只有在并发模式下有效,即testMode=concurrency_mode时有效。

true
AgentCountinteger

指定机器数。并发需要>250(RPS>2000)时使用,最大扩展机器数不能超过最大并发数/250(最大 RPS/2000)。

1
Incrementinteger

递增百分比。取值范围[10,100],取值需是 10 的倍数。

只在并发模式且同时是自动递增模式下有效,即testMode=concurrency_modeautoStep=true时有效。

30
KeepTimeinteger

单量级持续时长。单位分钟,该时长需小于施压时长 maxRunningTime

3
ApiLoadConfigListobject []

API 的起始、最大 RPS 值设置,在 RPS 模式下使用。

ApiIdstring

API ID。

1
RpsLimitinteger

最大 RPS 值。

100
RpsBegininteger

起始 RPS 值。

100
VpcLoadConfigobject

VPC 配置。

VpcIdstring

VPC ID。

vpc-akjhsdajgjsfggahjkga
VSwitchIdstring

交换机 ID。

vsw-skjfhlahsljkhsfalkjdoiw
SecurityGroupIdstring

安全组 ID。

sg-jkasgfieiajidsjakjscb
RegionIdstring

地域 ID。

cn-beijing
RelationLoadConfigListobject []

链路的起始、最大并发值设置,在并发模式下使用。

RelationIdstring

链路 ID。

1
ConcurrencyLimitinteger

最大并发数。

100
ConcurrencyBegininteger

起始并发。

100
AdvanceSettingobject

高级设置。

LogRateinteger

日志采样率。取值范围[1,50],大于 2 时取值需要是 10 的倍数,即[1,10,20,30,40,50]。

1
DomainBindingListobject []

域名绑定 IP 关系。

Domainstring

域名。

www.example.com
Ipsarray

对应的 IP。

string
["192.168.1.1","192.168.1.2"]
ConnectionTimeoutInSecondinteger

超时时间,单位秒。

5
SuccessCodestring

新增成功状态码,多个需用半角逗号(,)隔开。

205
GlobalParameterListobject []

全局自定义参数。

ParamNamestring

参数名。

global
ParamValuestring

全局参数值,不可参数化。

11111
FileParameterListobject []

文件参数。

FileNamestring

文件名。

test.csv
FileOssAddressstring

您自己的 OSS 文件地址,要求公网可访问。

https://jmeter-pts-testing-version.oss-cn-shanghai.aliyuncs.com/param-file.csv

返回参数

名称类型描述示例值
object
Messagestring

错误信息提示,若成功则为空。

RequestIdstring

请求 ID。

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

HTTP 状态码。

200
Codestring

系统状态码。

200
Successboolean

是否成功。

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

场景 ID

IUYAHGJ

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400ModifyPtsSceneFailThe scene does not exit

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

变更历史

变更时间变更内容概要操作
2022-03-25新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈