AggregationLegend
聚合函数
被如下接口引用：DescribeAvailableMetrics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Aggregation | String | 指标支持的聚合函数 示例值：Rate |
| Legend | String | 聚合函数作用于指标后对应的描述 示例值：请求RPS |
| Unit | String | 聚合之后的指标单位 示例值：reqs/s |
AlertChannel
告警通知渠道
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NoticeId | String | 否 | 通知模板ID 示例值：notice-xx |
| AMPConsumerId | String | 否 | AMP consumer ID 示例值：consumer-xx |
AlertChannelRecord
告警通知接收组
被如下接口引用：DescribeAlertChannels。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NoticeId | String | 否 | Notice ID 示例值：notice-xx |
| AMPConsumerId | String | 否 | Consumer ID 示例值：consumer-xx |
| ProjectId | String | 否 | 项目 ID 示例值：project-xx |
| Status | Integer | 否 | 状态 示例值：1 |
| CreatedAt | String | 否 | 创建时间 示例值：2021-09-02T03:18:35+08:00 |
| UpdatedAt | String | 否 | 更新时间 示例值：2021-09-02T03:18:35+08:00 |
| AppId | Integer | 否 | App ID 示例值：251200000 |
| Uin | String | 否 | 主账号 示例值：700000400000 |
| SubAccountUin | String | 否 | 子账号 示例值：700000400000 |
AlertRecord
告警历史记录项
被如下接口引用：DescribeAlertRecords。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AlertRecordId | String | 否 | 告警历史记录项 ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：alert-xxx |
| ProjectId | String | 否 | 项目 ID 示例值：project-xx |
| ScenarioId | String | 否 | 场景 ID 示例值：scenario-xx |
| Status | AlertRecordStatus | 否 | 状态 |
| CreatedAt | String | 否 | 创建时间 示例值：2021-09-02T03:18:35+08:00 |
| UpdatedAt | String | 否 | 修改时间 示例值：2021-09-02T03:18:35+08:00 |
| JobId | String | 否 | 任务 ID 示例值：job-xx |
| AppId | Integer | 否 | App ID 示例值：251200000 |
| Uin | String | 否 | 主账号 示例值：700000400000 |
| SubAccountUin | String | 否 | 子账号 示例值：700000400000 |
| ScenarioName | String | 否 | 场景名称 示例值：scenario-name |
| Target | String | 否 | 告警对象 示例值：target-value |
| JobSLAId | String | 否 | 告警规则 ID 示例值：sla-xx |
| JobSLADescription | String | 否 | 告警规则描述 示例值：SLA规则: 请求的错误百分比 > 5.00 % | 当前值: 7.61 % |
AlertRecordStatus
告警历史项的状态
被如下接口引用：DescribeAlertRecords。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AbortJob | Integer | 否 | 停止压测任务成功与否 示例值：1 |
| SendNotice | Integer | 否 | 发送告警通知成功与否 示例值：1 |
Attributes
采样日志附带属性
被如下接口引用：DescribeSampleLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 采用请求返回码 示例值：200 |
| Result | String | 采样请求结果码 示例值：ok |
| Service | String | 采样请求API 示例值：http://www.baidu.com |
| Method | String | 采样请求调用方法 示例值：get |
| Duration | String | 采样请求延时时间 示例值：20 |
CheckSummary
检查点汇总结果
被如下接口引用：DescribeCheckSummary。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 检查点名字 示例值：status is ok |
| Step | String | 检查点所在步骤名字 示例值：buy dog |
| SuccessCount | Integer | 检查点成功次数 示例值：99 |
| FailCount | Integer | 检查失败次数 示例值：1 |
| ErrorRate | Float | 错误比例 示例值：0.01 |
Concurrency
并发模式的施压配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Stages | Array of Stage | 否 | 多阶段配置数组 注意：此字段可能返回 null，表示取不到有效值。 |
| IterationCount | Integer | 否 | 运行次数 示例值：10 |
| MaxRequestsPerSecond | Integer | 否 | 最大RPS 示例值：1000 |
| GracefulStopSeconds | Integer | 否 | 优雅终止任务的等待时间 示例值：3 |
| Resources | Integer | 否 | 资源数 示例值：6 |
Credentials
COS临时凭证
被如下接口引用：GenerateTmpKey。
| 名称 | 类型 | 描述 |
|---|---|---|
| TmpSecretId | String | 临时secret ID 示例值：tmp-secret-id-value |
| TmpSecretKey | String | 临时secret key 示例值：tmp-secret-key-value |
| Token | String | 临时token 示例值：tmp-token-value |
CronJob
定时任务
被如下接口引用：DescribeCronJobs。
| 名称 | 类型 | 描述 |
|---|---|---|
| CronJobId | String | 定时任务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cron-xx |
| Name | String | 定时任务名字 示例值：cron-name |
| ProjectId | String | 项目ID 示例值：project-xx |
| ScenarioId | String | 场景ID 示例值：scenario-xx |
| ScenarioName | String | 场景名称 示例值：scenario-name |
| CronExpression | String | cron 表达式 示例值：*/1 * * * * |
| EndTime | Timestamp ISO8601 | 结束时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2014-08-03T12:00:00+08:00 |
| AbortReason | Integer | 中止原因 示例值：1 |
| Status | Integer | 定时任务状态 示例值：1 |
| NoticeId | String | Notice ID 示例值：notice-xx |
| CreatedAt | Timestamp ISO8601 | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2014-08-03T12:00:00+08:00 |
| UpdatedAt | Timestamp ISO8601 | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2014-08-03T12:00:00+08:00 |
| FrequencyType | Integer | 执行频率类型 示例值：1 |
| Note | String | 备注 示例值：备注 |
| JobOwner | String | tom 示例值：任务发起人 |
| AppId | Integer | App ID 示例值：251000000 |
| Uin | String | 主账号 示例值：3510500000 |
| SubAccountUin | String | 子账号 示例值：3510500000 |
CustomSample
sample附带原始查询语句中的metric, aggregation
被如下接口引用：DescribeSampleBatchQuery, DescribeSampleQuery。
| 名称 | 类型 | 描述 |
|---|---|---|
| Metric | String | 指标名 示例值：pts_engine_req_total |
| Aggregation | String | 聚合条件 示例值：Rate |
| Labels | Array of Label | 过滤条件 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"LabelName":"Method", "LabelValue":"GET"}] |
| Value | Float | 查询值 示例值：123.34 |
| Timestamp | Integer | Time is the number of milliseconds since the epoch // (1970-01-01 00:00 UTC) excluding leap seconds. 示例值：12345433 |
| Unit | String | 指标对应的单位，当前单位有：s,bytes,bytes/s,reqs,reqs/s,checks,checks/s,iters,iters/s,VUs, % 示例值：ms |
| Name | String | 指标序列名字 示例值：请求RPS |
CustomSampleMatrix
指标矩阵，可包含多条指标序列
被如下接口引用：DescribeSampleMatrixBatchQuery, DescribeSampleMatrixQuery。
| 名称 | 类型 | 描述 |
|---|---|---|
| Metric | String | 指标名字 示例值：pts_engine_req_total |
| Aggregation | String | 聚合函数 示例值：Rate |
| Unit | String | 指标单位 示例值：reqs/s |
| Streams | Array of SampleStream | 指标序列数组 注意：此字段可能返回 null，表示取不到有效值。 |
| Step | Integer | 两个时间点的时间间隔，单位纳秒 示例值：100 |
DNSConfig
施压机 DNS 配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Nameservers | Array of String | 否 | DNS IP 列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["0.0.0.0"] |
DomainNameConfig
施压机的域名解析相关配置
被如下接口引用：CreateScenario, DescribeFiles, DescribeJobs, DescribeScenarios, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| HostAliases | Array of HostAlias | 否 | 域名绑定配置 注意：此字段可能返回 null，表示取不到有效值。 |
| DNSConfig | DNSConfig | 否 | DNS 配置 注意：此字段可能返回 null，表示取不到有效值。 |
ErrorSummary
错误信息汇总
被如下接口引用：DescribeErrorSummary。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 状态码 示例值：200 |
| Result | String | 结果码 示例值：200 ok |
| Count | Integer | 错误出现次数 示例值：1000 |
| Rate | Float | 错误率 示例值：0.11 |
| Message | String | 错误信息 示例值：成功 |
| Proto | String | 请求协议类型 示例值：HTTP/1.1 |
File
文件列表
被如下接口引用：DescribeFiles。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileId | String | 文件 ID 示例值：file-xx |
| Kind | Integer | 文件种类，参数文件-1，协议文件-2，请求文件-3 示例值：1 |
| Name | String | 文件名 示例值：uin.csv |
| Size | Integer | 文件字节数 示例值：3896 |
| Type | String | 文件类型 示例值：csv |
| UpdatedAt | Timestamp ISO8601 | 更新时间 示例值：2006-01-02 15:04:05 |
| LineCount | Integer | 文件行数 示例值：1001 |
| HeadLines | Array of String | 头部数据行 注意：此字段可能返回 null，表示取不到有效值。 示例值：["uin","1","2"] |
| TailLines | Array of String | 尾部数据行 注意：此字段可能返回 null，表示取不到有效值。 示例值：["998","999","1000"] |
| HeaderInFile | Boolean | 首行是否为参数名 示例值：true |
| HeaderColumns | Array of String | 参数名数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：["uin"] |
| FileInfos | Array of FileInfo | 文件夹中的文件 注意：此字段可能返回 null，表示取不到有效值。 |
| ScenarioSet | Array of Scenario | 关联场景 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 文件状态 示例值：1 |
| CreatedAt | Timestamp ISO8601 | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2006-01-02 15:04:05 |
| ProjectId | String | 项目 ID 示例值：project-xx |
| AppID | Integer | 此字段不再使用 示例值：251000000 |
| Uin | String | 用户主账号 示例值：3510500000 |
| SubAccountUin | String | 用户子账号 示例值：3510500000 |
| AppId | Integer | 用户账号的 App ID 示例值：251000000 |
FileInfo
文件基本信息
被如下接口引用：CreateFile, CreateScenario, DescribeFiles, DescribeJobs, DescribeScenarios, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 文件名 示例值：a.log |
| Size | Integer | 否 | 文件大小 示例值：100 |
| Type | String | 否 | 文件类型 示例值：csv |
| UpdatedAt | Timestamp ISO8601 | 否 | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-09-02T03:18:35+08:00 |
| FileId | String | 否 | 文件 ID 示例值：file-xx |
Filter
指标查询过滤
被如下接口引用：DescribeErrorSummary, DescribeSampleBatchQuery, DescribeSampleMatrixBatchQuery, DescribeSampleMatrixQuery。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Operator | Integer | 是 | 等于：0，不等于：1 示例值：0 |
| LabelName | String | 是 | 标签名，可选值包括： 1. method，请求方法名； 2. proto：协议名； 3. service：服务名； 4. status：响应状态码； 5. result：响应详情； 6. check：检查名。 示例值：service |
| LabelValue | String | 是 | 标签值： 1. method：请求方法名，以 http 协议为例，method 为 GET、POST、PUT 等； 2. proto：协议名，以 http 协议为例，proto 为 HTTP/1.1、HTTP/2 等； 3. service：服务名，以 http 协议为例，service 为请求 url，如 http://httpbin.org/get 等； 4. status：响应状态码，以 http 协议为例，状态码包括 200、404、500 等； 5. result：响应详情，通过 result 判断请求成功或失败；请求正常，result 标签值为 ok；请求失败，result 标签携带错误码和描述； 6. check：检查名，标签值为用户设置的检查点名称。 示例值：www.baidu.com |
GeoRegionsLoadItem
压力分布配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RegionId | Integer | 是 | 地域ID 示例值：1 |
| Region | String | 否 | 地域 示例值：ap-guangzhou |
| Percentage | Integer | 否 | 百分比 示例值：50 |
HostAlias
施压机域名绑定配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| HostNames | Array of String | 否 | 需绑定的域名列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["example.com"] |
| IP | String | 否 | 需绑定的 IP 地址 示例值：0.0.0.0 |
InternalMetricQuery
查询结构封装
被如下接口引用：DescribeSampleBatchQuery, DescribeSampleMatrixBatchQuery。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Metric | String | 是 | 指标名 示例值：pts_engine_req_total |
| Aggregation | String | 是 | 聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge 示例值：Rate |
| Labels | Array of Label | 否 | deprecated, 请使用Filters 示例值：[{"LabelName":"Method", "LabelValue":"GET"}] |
| Filters | Array of Filter | 否 | 用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等） 示例值：[{"LabelName":"Method","Operator":0, "LabelValue":"GET"}] |
| GroupBy | Array of String | 否 | 指标分组 示例值：["status"] |
Job
任务
被如下接口引用：DescribeJobs, DescribeScenarioWithJobs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| JobId | String | 否 | 任务的JobID 注意：此字段可能返回 null，表示取不到有效值。 示例值：job-xx |
| ScenarioId | String | 否 | 任务的场景ID 示例值：scenario-xx |
| Load | Load | 否 | 任务的施压配置 |
| Configs | Array of String | 否 | 此字段不再使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：["a.prop", "b.prop"] |
| Datasets | Array of TestData | 否 | 任务的数据集文件 注意：此字段可能返回 null，表示取不到有效值。 |
| Extensions | Array of String | 否 | 此字段不再使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：["a.jar", "b.jar"] |
| Status | Integer | 否 | 任务的运行状态, JobUnknown: 0,JobCreated:1,JobPending:2, JobPreparing:3,JobSelectClustering:4,JobCreateTasking:5,JobSyncTasking:6 JobRunning:11,JobFinished:12,JobPrepareException:13,JobFinishException:14,JobAborting:15,JobAborted:16,JobAbortException:17,JobDeleted:18, JobSelectClusterException:19,JobCreateTaskException:20,JobSyncTaskException:21 示例值：1 |
| StartTime | Timestamp ISO8601 | 否 | 任务的开始时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-09-08T16:08:50+08:00 |
| EndTime | Timestamp ISO8601 | 否 | 任务的结束时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-09-08T16:08:50+08:00 |
| MaxVirtualUserCount | Integer | 否 | 任务的最大VU数 示例值：10 |
| Note | String | 否 | 任务的备注信息 示例值：this is a test |
| ErrorRate | Float | 否 | 错误率百分比 示例值：10.5 |
| JobOwner | String | 否 | 任务发起人 示例值：tom |
| LoadSources | LoadSource | 否 | 此字段不再使用 注意：此字段可能返回 null，表示取不到有效值。 |
| Duration | Integer | 否 | 任务时长 示例值：10 |
| MaxRequestsPerSecond | Integer | 否 | 最大每秒请求数 示例值：1000 |
| RequestTotal | Float | 否 | 总请求数 示例值：1000 |
| RequestsPerSecond | Float | 否 | 平均每秒请求数 示例值：1000 |
| ResponseTimeAverage | Float | 否 | 平均响应时间 示例值：1 |
| ResponseTimeP99 | Float | 否 | 响应时间第99百分位 示例值：1 |
| ResponseTimeP95 | Float | 否 | 响应时间第95百分位 示例值：1 |
| ResponseTimeP90 | Float | 否 | 响应时间第90百分位 示例值：1 |
| Scripts | Array of String | 否 | 此字段不再使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：["a.js", "b.js"] |
| ResponseTimeMax | Float | 否 | 最大响应时间 示例值：1 |
| ResponseTimeMin | Float | 否 | 最小响应时间 示例值：1 |
| LoadSourceInfos | Array of LoadSource | 否 | 发压host信息 注意：此字段可能返回 null，表示取不到有效值。 |
| TestScripts | Array of ScriptInfo | 否 | 测试脚本信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Protocols | Array of ProtocolInfo | 否 | 协议脚本信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestFiles | Array of FileInfo | 否 | 请求文件信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Plugins | Array of FileInfo | 否 | 拓展包文件信息 注意：此字段可能返回 null，表示取不到有效值。 |
| CronId | String | 否 | 定时任务ID 示例值：cron-xx |
| Type | String | 否 | 场景类型 示例值：js |
| DomainNameConfig | DomainNameConfig | 否 | 域名绑定配置 |
| Debug | Boolean | 否 | false 示例值：是否为调试型的压测任务 |
| AbortReason | Integer | 否 | 中断原因 示例值：1 |
| CreatedAt | Timestamp ISO8601 | 否 | 任务的创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-08-09T10:27:22+08:00 |
| ProjectId | String | 否 | 项目ID 示例值：project-xx |
| NotificationHooks | Array of NotificationHook | 否 | 通知事件回调 注意：此字段可能返回 null，表示取不到有效值。 |
| NetworkReceiveRate | Float | 否 | 每秒接收字节数 示例值：123.456 |
| NetworkSendRate | Float | 否 | 每秒发送字节数 示例值：123.456 |
| Message | String | 否 | 任务状态描述 示例值：已完成 |
| ProjectName | String | 否 | test-project 示例值：project-name |
| ScenarioName | String | 否 | test-scenario 示例值：scenario-name |
| PayMode | Integer | 否 | 付费类型 示例值：1 预付费，２后付费，３免费调试任务 |
| Usage | Integer | 否 | job VUM用量 示例值：1000 |
Label
包含labelName 和labelValue
被如下接口引用：DescribeSampleBatchQuery, DescribeSampleMatrixBatchQuery, DescribeSampleMatrixQuery, DescribeSampleQuery。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LabelName | String | 是 | 标签名 示例值：service |
| LabelValue | String | 是 | 标签值 示例值：http://mockhttpbin.pts.svc.cluster.local/get |
LabelWithValues
标签及对应的值
被如下接口引用：DescribeMetricLabelWithValues。
| 名称 | 类型 | 描述 |
|---|---|---|
| LabelName | String | 标签名称 示例值：service |
| LabelValues | Array of String | 标签值 示例值：["500"，"200"] |
Load
施压配置
被如下接口引用：CreateScenario, DescribeFiles, DescribeJobs, DescribeScenarios, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LoadSpec | LoadSpec | 否 | 施压配置 |
| VpcLoadDistribution | VpcLoadDistribution | 否 | 压力来源 注意：此字段可能返回 null，表示取不到有效值。 |
| GeoRegionsLoadDistribution | Array of GeoRegionsLoadItem | 否 | 多地域压力分布 注意：此字段可能返回 null，表示取不到有效值。 |
LoadSource
发压host来源
被如下接口引用：DescribeJobs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IP | String | 否 | 发压host的IP 示例值：1.1.1.1 |
| PodName | String | 否 | 发压host所在的pod 示例值：pod-name-value |
| Region | String | 否 | 所属地域 示例值：ap-guangzhou |
LoadSpec
施压配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Concurrency | Concurrency | 否 | 并发施压模式的配置 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestsPerSecond | RequestsPerSecond | 否 | RPS施压模式的配置 注意：此字段可能返回 null，表示取不到有效值。 |
| ScriptOrigin | ScriptOrigin | 否 | 脚本内置压力模式 注意：此字段可能返回 null，表示取不到有效值。 |
MetricInfo
指标结构
被如下接口引用：DescribeAvailableMetrics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Metric | String | 后台指标 示例值：pts_engine_reqs_total |
| Alias | String | 前台展示指标名称 示例值：RequestCount |
| Description | String | 指标描述 示例值：请求数量 |
| MetricType | String | 指标类型 示例值：Counter |
| Unit | String | 默认指标单位 示例值：s |
| Aggregations | Array of AggregationLegend | 指标支持的聚合函数 |
| InnerMetric | Boolean | 是否内部指标，内部指标不可在前台提供用户自由选择 示例值：true |
MetricLabelWithValues
PTS提供的指标名，指标对应的labels及values
被如下接口引用：DescribeMetricLabelWithValues。
| 名称 | 类型 | 描述 |
|---|---|---|
| MetricName | String | metric 名字 示例值：RequestCount |
| LabelValuesSet | Array of LabelWithValues | label及values 数组 |
NormalLog
通用日志
被如下接口引用：DescribeNormalLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | String | 毫秒时间戳 示例值：23423423 |
| SeverityText | String | 日志级别 示例值：debug/info/error |
| Body | String | 日志输出内容 示例值：this is log body |
Notification
测试启动前后的消息通知
被如下接口引用：UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Events | Array of String | 否 | 发生事件 示例值：["name", "age"] |
| URL | String | 否 | webhook的网址 示例值："http://abc.com" |
NotificationHook
事件通知回调
被如下接口引用：DescribeFiles, DescribeJobs, DescribeScenarios。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Events | Array of String | 否 | 通知事件 注意：此字段可能返回 null，表示取不到有效值。 示例值：["BeforeRunning", "AfterFinished", "AfterAborted"] |
| URL | String | 否 | 回调 URL 示例值：http://xxx.com/notify |
Project
项目
被如下接口引用：DescribeProjects。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProjectId | String | 项目ID 示例值：project-xx |
| Name | String | 项目名 示例值：project-name |
| Description | String | 项目描述 示例值：this is a test project |
| Tags | Array of TagSpec | 标签数组 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 项目状态 示例值：1 |
| CreatedAt | Timestamp ISO8601 | 创建时间 示例值：2021-08-23T20:59:07+08:00 |
| UpdatedAt | Timestamp ISO8601 | 修改时间 示例值：2021-08-23T20:59:07+08:00 |
| AppId | Integer | App ID 示例值：251000000 |
| Uin | String | 用户ID 示例值：3510500000 |
| SubAccountUin | String | 子用户ID 示例值：3510500000 |
ProtocolInfo
协议文件详情
被如下接口引用：CreateScenario, DescribeFiles, DescribeJobs, DescribeScenarios, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 协议详情 示例值：hello.proto |
| Size | Integer | 否 | 文件大小 示例值：100 |
| Type | String | 否 | 文件类型 示例值：proto |
| UpdatedAt | Timestamp ISO8601 | 否 | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-09-02T03:18:35+08:00 |
| FileId | String | 否 | 文件 ID 示例值：file-xx |
ReactionTimeRange
采用日志响应时间RT范围
被如下接口引用：DescribeSampleLogs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Min | String | 否 | 最小响应时间，单位ms 示例值：10 |
| Max | String | 否 | 最大响应时间，单位ms 示例值：100 |
RegionDetail
地域
被如下接口引用：DescribeRegions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Region | String | 是 | 地域代码 示例值：ap-guangzhou |
| RegionId | Integer | 是 | 地域ID 示例值：1 |
| Area | String | 否 | 地域所在的地区 示例值：华南地区 |
| RegionName | String | 否 | 地域名称 示例值：广州 |
| RegionState | Integer | 否 | 地域状态 示例值：1 |
| RegionShortName | String | 否 | 地域简称 示例值：gz |
| CreatedAt | Timestamp ISO8601 | 否 | 创建时间 示例值：2021-08-20T16:33:00+08:00 |
| UpdatedAt | Timestamp ISO8601 | 否 | 更新时间 示例值：2021-08-20T16:33:00+08:00 |
RequestSummary
压测请求明细
被如下接口引用：DescribeRequestSummary。
| 名称 | 类型 | 描述 |
|---|---|---|
| Service | String | 请求URL 示例值：http://www.baidu.com |
| Method | String | 请求方法 示例值：GET |
| Count | Integer | 请求次数 示例值：100 |
| Average | Float | 请求响应平均耗时，单位秒 示例值：0.50 |
| P90 | Float | 请求p90耗时，单位秒 示例值：0.90 |
| P95 | Float | 请求p95耗时，单位秒 示例值：0.95 |
| Min | Float | 请求最小耗时，单位秒 示例值：0.10 |
| Max | Float | 请求最大耗时，单位秒 示例值：0.99 |
| ErrorPercentage | Float | 请求错误率 示例值：1，代表错误率1% |
| P99 | Float | 请求p99耗时，单位秒 示例值：0.55 |
| Status | String | 响应状态码 示例值：200 |
| Result | String | 响应详情 示例值：ok |
| RPS | Float | 平均rps, 单位req/s 示例值：100 |
RequestsPerSecond
RPS模式的施压配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MaxRequestsPerSecond | Integer | 否 | 最大RPS 示例值：1000 |
| DurationSeconds | Integer | 否 | 施压时间 示例值：60 |
| TargetVirtualUsers | Integer | 否 | deprecated 示例值：30 |
| Resources | Integer | 否 | 资源数 示例值：6 |
| StartRequestsPerSecond | Integer | 否 | 起始RPS 示例值：500 |
| TargetRequestsPerSecond | Integer | 否 | 目标RPS，入参无效 示例值：500 |
| GracefulStopSeconds | Integer | 否 | 优雅关停的等待时间 示例值：3 |
SLALabel
SLA 标签
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LabelName | String | 否 | 标签名 示例值：service |
| LabelValue | String | 否 | 标签值 示例值：http://httpbin.org/get |
SLAPolicy
SLA 策略
被如下接口引用：CreateScenario, DescribeFiles, DescribeScenarios, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SLARules | Array of SLARule | 否 | SLA 规则 注意：此字段可能返回 null，表示取不到有效值。 |
| AlertChannel | AlertChannel | 否 | 告警通知渠道 注意：此字段可能返回 null，表示取不到有效值。 |
SLARule
SLA 规则
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Metric | String | 否 | 压测指标 示例值：pts_engine_req_total |
| Aggregation | String | 否 | 压测指标聚合方法 示例值：avg |
| Condition | String | 否 | 压测指标条件判断符号 示例值：> |
| Value | Float | 否 | 阈值 示例值：1.00 |
| LabelFilter | Array of SLALabel | 否 | 标签 注意：此字段可能返回 null，表示取不到有效值。 |
| AbortFlag | Boolean | 否 | 是否停止压测任务 示例值：true |
| For | String | 否 | 持续时长 示例值：1m |
SampleLog
采样日志
被如下接口引用：DescribeSampleLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | String | 日志毫秒时间戳 示例值：3242342332432 |
| Attributes | Attributes | 采样日志属性 |
| Body | String | har格式的采样请求 示例值：{"log":{"version":"","creator":{"name":"PTS-har","version":""},"entries":[]}} |
SamplePair
sample采样值
被如下接口引用：DescribeSampleMatrixBatchQuery, DescribeSampleMatrixQuery。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | Integer | is the number of milliseconds since the epoch (1970-01-01 00:00 UTC) excluding leap seconds. 示例值：2342342 |
| Value | Float | is a representation of a value for a given sample at a given time. 示例值：3242.23 |
SampleStream
连续指标采样内容
被如下接口引用：DescribeSampleMatrixBatchQuery, DescribeSampleMatrixQuery。
| 名称 | 类型 | 描述 |
|---|---|---|
| Labels | Array of Label | labels描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"LabelName":"Method", "LabelValue":"GET"}] |
| Values | Array of SamplePair | 指标采样数组 示例值：[{"Timestamp":24355, "Value":3243.45}] |
| Name | String | 指标序列名字 示例值：请求RPS |
Scenario
场景列表
被如下接口引用：DescribeFiles, DescribeScenarioWithJobs, DescribeScenarios。
| 名称 | 类型 | 描述 |
|---|---|---|
| ScenarioId | String | 场景ID 示例值：scenario-xx |
| Name | String | 场景名 示例值：scenario-test |
| Description | String | 场景描述 示例值：this is a test scenario |
| Type | String | 场景类型，如pts-http, pts-js, pts-trpc, pts-jmeter 示例值：pts-http |
| Status | Integer | 场景状态 示例值：1 |
| Load | Load | 施压配置 |
| EncodedScripts | String | deprecated 示例值：WyJhYmMiLCAiZGVmZyJdCg== |
| Configs | Array of String | deprecated 注意：此字段可能返回 null，表示取不到有效值。 示例值：["a.prop","b.prop"] |
| Extensions | Array of String | deprecated 注意：此字段可能返回 null，表示取不到有效值。 示例值：["a.jar","b.jar"] |
| Datasets | Array of TestData | 测试数据集 注意：此字段可能返回 null，表示取不到有效值。 |
| SLAId | String | SLA规则的ID 示例值：sla-xx |
| CronId | String | Cron Job规则的ID 示例值：cron-xx |
| CreatedAt | String | 场景创建时间 示例值：2021-08-16 15:09:56 |
| UpdatedAt | String | 场景修改时间 示例值：2021-08-16 15:09:56 |
| ProjectId | String | 项目ID 示例值：project-xx |
| AppId | Integer | App ID 示例值：251000000 |
| Uin | String | 用户ID 示例值：3510500000 |
| SubAccountUin | String | 子用户ID 示例值：3510500000 |
| TestScripts | Array of ScriptInfo | 测试脚本信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Protocols | Array of ProtocolInfo | 协议文件信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestFiles | Array of FileInfo | 请求文件信息 注意：此字段可能返回 null，表示取不到有效值。 |
| SLAPolicy | SLAPolicy | SLA 策略 |
| Plugins | Array of FileInfo | 扩展包信息 注意：此字段可能返回 null，表示取不到有效值。 |
| DomainNameConfig | DomainNameConfig | 域名解析配置 |
| NotificationHooks | Array of NotificationHook | 通知事件回调 注意：此字段可能返回 null，表示取不到有效值。 |
| Owner | String | 创建人员 示例值：owner-name |
| ProjectName | String | 场景所在的项目的名字 示例值：project-name |
ScenarioRelatedJobsParams
查询与特定scenario关联的job的参数
被如下接口引用：DescribeScenarioWithJobs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Offset | Integer | 否 | job偏移量 示例值：0 |
| Limit | Integer | 否 | 限制最多查询的job数 示例值：10 |
| OrderBy | String | 否 | 排序字段 示例值：start_time |
| Ascend | Boolean | 否 | 是否升序 示例值：true/false |
ScenarioWithJobs
带已执行任务的scenario
被如下接口引用：DescribeScenarioWithJobs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Scenario | Scenario | scecario结果 |
| Jobs | Array of Job | job结果 注意：此字段可能返回 null，表示取不到有效值。 |
ScriptInfo
脚本信息
被如下接口引用：CreateScenario, DescribeFiles, DescribeJobs, DescribeScenarios, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 文件名 示例值：hello.js |
| Size | Integer | 否 | 文件大小 示例值：100 |
| Type | String | 否 | 文件类型 示例值：js |
| UpdatedAt | Timestamp ISO8601 | 否 | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-09-02T03:18:35+08:00 |
| EncodedContent | String | 否 | base64编码后的文件内容 示例值：sfadsfdsfdfdfsfdsgerdf |
| EncodedHttpArchive | String | 否 | base64编码后的har结构体 示例值：sfadsfdsfdfdfsfdsgerdf |
| LoadWeight | Integer | 否 | 脚本权重，范围 1-100 示例值：100 |
| FileId | String | 否 | 文件 ID 示例值：file-xxx |
| Uploaded | Boolean | 否 | 文件是否已上传，如果已上传，则可以不必填写 EncodedContent,EncodedHar 等内容。 主要用于较大长度脚本上传。 示例值：true/false |
ScriptOrigin
脚本内置压力模型
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MachineNumber | Integer | 是 | 机器数量 示例值：10 |
| MachineSpecification | String | 是 | 机器规格 示例值：1c2g, 2c4g, 4g8g |
| DurationSeconds | Integer | 是 | 压测时长 示例值：1200 |
Stage
分阶段施压时，对单个阶段的配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DurationSeconds | Integer | 否 | 施压时间 示例值：30 |
| TargetVirtualUsers | Integer | 否 | 虚拟用户数 示例值：30 |
TagSpec
标签
被如下接口引用：CreateProject, DescribeProjects, UpdateProject。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 标签键 示例值：owner |
| TagValue | String | 否 | 标签值 示例值：tom |
TestData
测试数据集
被如下接口引用：CreateScenario, DescribeFiles, DescribeJobs, DescribeScenarios, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 测试数据集所在的文件名 示例值：info.csv |
| Split | Boolean | 是 | 测试数据集是否分片 示例值：true |
| HeaderInFile | Boolean | 是 | 首行是否为参数名 示例值：true |
| HeaderColumns | Array of String | 否 | 参数名数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：["name", "age"] |
| LineCount | Integer | 否 | 文件行数 示例值：10 |
| UpdatedAt | Timestamp ISO8601 | 否 | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-09-02T03:18:35+08:00 |
| Size | Integer | 否 | 文件字节数 示例值：10 |
| HeadLines | Array of String | 否 | 头部数据行 注意：此字段可能返回 null，表示取不到有效值。 示例值：["head-line-value"] |
| TailLines | Array of String | 否 | 尾部数据行 注意：此字段可能返回 null，表示取不到有效值。 示例值：["tail-line-value"] |
| Type | String | 否 | 文件类型 示例值：CSV |
| FileId | String | 否 | 文件 ID 示例值：file-xx |
VpcLoadDistribution
压力来源配置
被如下接口引用：CreateScenario, UpdateScenario。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RegionId | Integer | 是 | 地域ID 示例值：1 |
| Region | String | 否 | 地域 示例值：ap-guangzhou |
| VpcId | String | 否 | VPC ID 示例值：vpc-xx |
| SubnetIds | Array of String | 否 | 子网ID列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["subnet-xxx"] |
