新建或更新JMeter场景。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
pts:SaveOpenJMeterScene | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
OpenJMeterScene | object | 是 | 场景详情。 | |
AgentCount | integer | 是 | 施压机数量。 | 2 |
Concurrency | integer | 否 | 最大并发,并发上限由用户的资源包决定,在 mode= CONCURRENCY 时必须设置。 | 1000 |
ConstantThroughputTimerType | string | 否 | JMeter 中的固定吞吐量定时器类型。 | GLOBAL |
DnsCacheConfig | object | 否 | DNS 配置。 | |
ClearCacheEachIteration | boolean | 否 | 每次循环是否清空缓存。 | true |
DnsServers | array | 否 | DNS 服务器。 | |
string | 否 | DNS 服务器详情。 | [8.8.8.8] | |
HostTable | object | 否 | 域名绑定。 | |
string | 否 | 域名绑定详情。 | "ns.server.om":"8.8.8.8" | |
Duration | integer | 是 | 压测持续时间,最长压测时间不超过一天,单位秒,取值范围为 60~86400。 | 600 |
EnvironmentId | string | 否 | 关联的环境 ID。 | I8PZIH |
FileList | array<object> | 是 | 文件列表。 | |
object | 否 | 文件详情。 | ||
FileId | long | 否 | 文件 ID。 | 61232 |
FileName | string | 是 | 文件名。 | test.jmx |
FileOssAddress | string | 是 | 文件在公网可访问的 OSS 地址。 说明
目前仅支持上海地域。
| https://test.cn-shanghai.aliyuncs.com/test.jmx |
FileSize | long | 否 | 文件大小,文件总大小不超过 500 M,单位 Byte。 | 28880 |
Md5 | string | 否 | 文件的 MD5。 | DA70F97A74D76B6A3BEF9CC8AE0D89EB |
SplitCsv | boolean | 否 | 是否切分,仅针对 CSV 有效。 | false |
Tags | string | 否 | 文件标签。 | 空 |
IsVpcTest | boolean | 否 | 是否为 VPC 测试。默认为 false,表示公网测试。当此值为 true 时,VPC 相关配置才会生效。 | true |
JMeterProperties | array<object> | 否 | JMeter 属性。 | |
object | 否 | 属性详情。 | ||
Name | string | 否 | 属性名。 | https.sessioncontext.shared |
Value | string | 否 | 属性值。 | false |
JmeterPluginLabel | string | 否 | jmeter 插件标签。 | test |
MaxRps | integer | 否 | 最大 RPS,RPS 模式下生效。 | 100 |
Mode | string | 是 | 施压模型。 | CONCURRENCY |
RampUp | integer | 否 | 预热时间,单位秒。 | 600 |
RegionId | string | 否 | 地域 ID,在 VPC 压测时配置。 | cn-beijing |
RegionalCondition | array<object> | 否 | 施压机地域定制 | |
object | 否 | 单地域施压机数量 | ||
Amount | integer | 否 | 施压机数量,所有地域施压机数量之和需要等于场景的 AgentCount 值。 | 1 |
Region | string | 否 | 地域 id | cn-hangzhou |
SceneId | string | 否 | 场景 ID。没有传场景 ID 表示新建场景,传场景 ID 表示更新场景。 | DYYPZIH |
SceneName | string | 是 | 场景名。 | test |
SecurityGroupId | string | 否 | 安全组 ID,在 VPC 压测时配置。 | sg-2zeid0dd7bhahsgdahspaly |
StartConcurrency | integer | 否 | 起始并发,并发模式下生效,在 mode= CONCURRENCY 时必须设置。 | 10 |
StartRps | integer | 否 | 起始的 RPS,RPS 模式下生效。 | 10 |
Steps | integer | 否 | 预热阶段。 | 3 |
SyncTimerType | string | 否 | JMeter 中的同步定时器类型。 | GLOBAL |
TestFile | string | 是 | 测试文件。 | test.jmx |
VSwitchId | string | 否 | 交换机 ID,在 VPC 压测时配置。 | vsw-2zehsgdhsahw1r |
VpcId | string | 否 | VPC 的 ID,在 VPC 压测时配置。 | vpc-2ze2sahjdgahsebjkqhf4pyj |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"HttpStatusCode": 200,
"Message": "空",
"RequestId": "A8E16480-15C1-555A-922F-B736A005E52D",
"SceneId": "DYYPZIH",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | SaveOpenJMeterSceneFail | The scene cannot be empty. | 场景内容不能为空 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-01-23 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-12-20 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-12-07 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-12-01 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-11-23 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-11-19 | 新增 OpenAPI | 查看变更详情 |