保存或修改场景。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Scene | object | 是 | 场景详细信息。 | |
SceneId | string | 否 | 场景ID。没有传场景ID表示新建场景,传场景ID表示更新场景。 | IUYAHGJ |
SceneName | string | 是 | 场景名。 | test |
RelationList | array | 是 | 链路配置。 | |
object | 否 | |||
RelationName | string | 是 | 链路名。 | 链路1 |
RelationId | string | 否 | 链路ID。 | 1 |
ApiList | array | 是 | 链路下的API信息。 | |
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_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 | 否 | 检查点类型。包括:
| EXPORTED_PARAM |
CheckPoint | string | 否 | 检查对象。 当 | userId |
TimeoutInSecond | integer | 否 | API超时时间。单位秒,默认5s,取值范围[1-60]。 | 5 |
Body | object | 否 | 请求Body。 | |
ContentType | string | 否 | Body类型,默认 | 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 |
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 | 否 | 是否自动递增。只有在并发模式下有效,即 | true |
AgentCount | integer | 否 | 指定机器数。并发需要>250(RPS>2000)时使用,最大扩展机器数不能超过最大并发数/250(最大RPS/2000)。 | 1 |
Increment | integer | 否 | 递增百分比。取值范围[10,100],取值需是10的倍数。 只在并发模式且同时是自动递增模式下有效,即 | 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 |
返回参数
示例
正常返回示例
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 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-03-25 | 新增 OpenAPI |