文档

GetPtsReportDetails - 查询报告

更新时间:

获取场景压测后的报告详情。

调试

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

授权信息

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

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

请求参数

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

场景 ID。更多信息,请参见参数说明

G5HCVS
PlanIdstring

每次启动场景生成的任务 ID。更多信息,请参见参数说明

OH5HA3VB

返回参数

名称类型描述示例值
object
Messagestring

错误提示信息,若成功则不返回该字段。

RequestIdstring

请求 ID

DC4E3177-6745-4925-B423-4E89VV34221A
ReportOverViewobject

报告概要信息

ReportNamestring

报告名

PTS-TEST
EndTimestring

压测结束时间

2024-09-20 10:41:33
StartTimestring

开始时间

2024-09-20 10:39:33
AgentCountinteger

施压机数量

1
ReportIdstring

报告 ID

GHB56VD
Vumlong

消耗的 VUM

1012
SceneMetricsobject

场景维度的指标信息

FailCountBizlong

全场景业务失败数

0
AllCountlong

全场景总请求数

11872
SuccessRateBizfloat

全场景业务成功率

0
AvgRtfloat

全场景平均 RT

170.49
FailCountReqlong

全场景请求失败数

0
AvgTpsfloat

全场景平均 TPS

100.61
Seg99Rtfloat

99 分位 RT

284
SuccessRateReqfloat

全场景请求成功率

1
Seg90Rtfloat

90 分位 RT

170
ApiMetricsListarray<object>

API 维度指标信息

ApiMetricsobject
FailCountBizlong

业务失败数。定义了检查点时,不符合条件为失败。

0
Seg75Rtfloat

75 分位 RT

169
AllCountlong

总请求个数

11872
AvgTpsfloat

平均 TPS

100.61
MinRtfloat

最小 RT,单位 ms。

162
Seg99Rtfloat

99 分位 RT

284
Seg50Rtfloat

50 分位 RT

168
MaxRtfloat

最大 RT,单位 ms。

600
Seg90Rtfloat

90 分位 RT

170
SuccessRateBizfloat

业务成功率。等于业务成功数/总请求数。

0
AvgRtfloat

平均 RT,单位 ms。

170.49
FailCountReqlong

请求失败数

0
SuccessRateReqfloat

请求成功率。等于请求成功数/总请求数。

1
ApiNamestring

API 名称

Test-API
HttpStatusCodeinteger

HTTP 状态码,若成功则不返回该字段。

Codestring

系统状态码,若成功则不返回该字段。

SceneSnapShotobject

场景快照信息

Statusstring

场景状态

STOPPED
LoadConfigobject

施压配置信息

ApiLoadConfigListarray<object>

API 的 RPS 起始信息

ApiLoadConfigobject
RpsBegininteger

起始 RPS

10
RpsLimitinteger

最大 RPS

10
MaxRunningTimeinteger

运行时长,单位分钟。

2
RelationLoadConfigListarray<object>

链路起始和最大并发配置

RelationLoadConfigobject
ConcurrencyBegininteger

起始并发

10
ConcurrencyLimitinteger

最大并发

20
Configurationobject

全场景的并发或 RPS 限制信息

AllRpsBegininteger

全场景起始 RPS

100
AllConcurrencyBegininteger

全场景起始并发

0
AllConcurrencyLimitinteger

全场景最大并发

500
AllRpsLimitinteger

全场景最大 RPS

1000
AgentCountinteger

施压机数量

1
TestModestring

施压模式

TPS
FileParameterListarray<object>

场景使用的文件信息

FileParameterobject
FileOssAddressstring

文件的 OSS 地址

https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.csv
FileNamestring

文件名

test.csv
ModifiedTimestring

修改时间

2020-10-10 10:10:10
AdvanceSettingobject

场景高级设置

LogRateinteger

日志采样率

1
DomainBindingListarray<object>

域名和 IP 的绑定关系

DomainBindingobject
Domainstring

域名

www.example.com
Ipsarray

域名绑定的 IP

Stringstring

域名绑定的 IP

[192.168.0.1]
ConnectionTimeoutInSecondinteger

全场景超时时间

5
SuccessCodestring

自定义成功状态码

CreateTimestring

创建时间

2024-09-20 09:28:10
RelationListarray<object>

链路信息

Relationobject
RelationNamestring

链路名

Test-session-1
FileParameterExplainListarray<object>

链路中使用到的文件参数说明

FileParameterExplainobject
CycleOnceboolean

是否只循环一次

false
FileParamNamestring

文件中的参数名

username
FileNamestring

文件名

test.csv
BaseFileboolean

是否作为基准列

true
ApiListarray<object>

API 信息

Apiobject
ApiIdstring

API ID

MNB45
CheckPointListarray<object>

API 的所有检查点

CheckPointobject
CheckTypestring

检查类型

EXPORTED_PARAM
Operatorstring

比较符号

ctn
ExpectValuestring

期望值

111
CheckPointstring

检查点

userId
HeaderListarray<object>

压测 URL 的 Header 信息

Headerobject
HeaderValuestring

参数值

PTS
HeaderNamestring

参数名

User-Agent
TimeoutInSecondinteger

超时时间

5
ExportListarray<object>

导出参数列表

Exportobject
ExportTypestring

导出参数来源

BODY_JSON
ExportValuestring

导出参数解析表达式

data.userId
ExportNamestring

导出参数名

userId
Countstring

导出参数匹配项

1
Urlstring

压测的 URL

http://www.example.com/
Methodstring

请求方法

GET
Bodyobject

请求的 Body 信息

BodyValuestring

body 值

{key:value}
ContentTypestring

body 类型

application/x-www-form-urlencoded
RedirectCountLimitinteger

重定向次数

5
ApiNamestring

API 名称

Test-API
RelationIdstring

链路 ID

HGBN4D
SceneNamestring

场景名

PTS-TEST
SceneIdstring

场景 ID

7HBNS3
GlobalParameterListarray<object>

全局变量

GlobalParameterobject
ParamNamestring

参数名

username
ParamValuestring

参数值

user01
Successboolean

是否成功

  • true:成功
  • false:失败
true

示例

正常返回示例

JSON格式

{
  "Message": "",
  "RequestId": "DC4E3177-6745-4925-B423-4E89VV34221A",
  "ReportOverView": {
    "ReportName": "PTS-TEST",
    "EndTime": "2024-09-20 10:41:33",
    "StartTime": "2024-09-20 10:39:33",
    "AgentCount": 1,
    "ReportId": "GHB56VD",
    "Vum": 1012
  },
  "SceneMetrics": {
    "FailCountBiz": 0,
    "AllCount": 11872,
    "SuccessRateBiz": 0,
    "AvgRt": 170.49,
    "FailCountReq": 0,
    "AvgTps": 100.61,
    "Seg99Rt": 284,
    "SuccessRateReq": 1,
    "Seg90Rt": 170
  },
  "ApiMetricsList": [
    {
      "FailCountBiz": 0,
      "Seg75Rt": 169,
      "AllCount": 11872,
      "AvgTps": 100.61,
      "MinRt": 162,
      "Seg99Rt": 284,
      "Seg50Rt": 168,
      "MaxRt": 600,
      "Seg90Rt": 170,
      "SuccessRateBiz": 0,
      "AvgRt": 170.49,
      "FailCountReq": 0,
      "SuccessRateReq": 1,
      "ApiName": "Test-API"
    }
  ],
  "HttpStatusCode": 0,
  "Code": "",
  "SceneSnapShot": {
    "Status": "STOPPED",
    "LoadConfig": {
      "ApiLoadConfigList": [
        {
          "RpsBegin": 10,
          "RpsLimit": 10
        }
      ],
      "MaxRunningTime": 2,
      "RelationLoadConfigList": [
        {
          "ConcurrencyBegin": 10,
          "ConcurrencyLimit": 20
        }
      ],
      "Configuration": {
        "AllRpsBegin": 100,
        "AllConcurrencyBegin": 0,
        "AllConcurrencyLimit": 500,
        "AllRpsLimit": 1000
      },
      "AgentCount": 1,
      "TestMode": "TPS"
    },
    "FileParameterList": [
      {
        "FileOssAddress": "https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.csv",
        "FileName": "test.csv"
      }
    ],
    "ModifiedTime": "2020-10-10 10:10:10",
    "AdvanceSetting": {
      "LogRate": 1,
      "DomainBindingList": [
        {
          "Domain": "www.example.com",
          "Ips": [
            "[192.168.0.1]"
          ]
        }
      ],
      "ConnectionTimeoutInSecond": 5,
      "SuccessCode": ""
    },
    "CreateTime": "2024-09-20 09:28:10",
    "RelationList": [
      {
        "RelationName": "Test-session-1",
        "FileParameterExplainList": [
          {
            "CycleOnce": false,
            "FileParamName": "username",
            "FileName": "test.csv",
            "BaseFile": true
          }
        ],
        "ApiList": [
          {
            "ApiId": "MNB45",
            "CheckPointList": [
              {
                "CheckType": "EXPORTED_PARAM",
                "Operator": "ctn",
                "ExpectValue": "111",
                "CheckPoint": "userId"
              }
            ],
            "HeaderList": [
              {
                "HeaderValue": "PTS",
                "HeaderName": "User-Agent"
              }
            ],
            "TimeoutInSecond": 5,
            "ExportList": [
              {
                "ExportType": "BODY_JSON",
                "ExportValue": "data.userId",
                "ExportName": "userId",
                "Count": "1"
              }
            ],
            "Url": "http://www.example.com/",
            "Method": "GET",
            "Body": {
              "BodyValue": "{key:value}",
              "ContentType": "application/x-www-form-urlencoded"
            },
            "RedirectCountLimit": 5,
            "ApiName": "Test-API"
          }
        ],
        "RelationId": "HGBN4D"
      }
    ],
    "SceneName": "PTS-TEST",
    "SceneId": "7HBNS3",
    "GlobalParameterList": [
      {
        "ParamName": "username",
        "ParamValue": "user01"
      }
    ]
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息
400GetPtsReportDetailsFailReport does not exist

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

变更历史

变更时间变更内容概要操作
暂无变更历史