GetPtsReportDetails - 查询报告

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

调试

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

授权信息

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

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

请求参数

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

场景 ID,创建场景后系统生成的唯一表示。

G5HCVS
PlanIdstring

每次启动场景生成的任务 ID。

OH5HA3VB

返回参数

名称类型描述示例值
object
ApiMetricsListarray<object>

API 维度指标信息

ApiMetricsobject
AllCountlong

总请求个数

11872
ApiNamestring

API 名称

Test-API
AvgRtfloat

平均 RT,单位 ms。

170.49
AvgTpsfloat

平均 TPS

100.61
FailCountBizlong

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

0
FailCountReqlong

请求失败数

0
MaxRtfloat

最大 RT,单位 ms。

600
MinRtfloat

最小 RT,单位 ms。

162
Seg50Rtfloat

50 分位 RT

168
Seg75Rtfloat

75 分位 RT

169
Seg90Rtfloat

90 分位 RT

170
Seg99Rtfloat

99 分位 RT

284
SuccessRateBizfloat

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

0
SuccessRateReqfloat

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

1
Codestring

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

HttpStatusCodeinteger

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

Messagestring

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

ReportOverViewobject

报告概要信息

AgentCountinteger

施压机数量

1
EndTimestring

压测结束时间

2024-09-20 10:41:33
ReportIdstring

报告 ID

GHB56VD
ReportNamestring

报告名

PTS-TEST
StartTimestring

开始时间

2024-09-20 10:39:33
Vumlong

消耗的 VUM

1012
RequestIdstring

请求 ID

DC4E3177-6745-4925-B423-4E89VV34221A
SceneMetricsobject

场景维度的指标信息

AllCountlong

全场景总请求数

11872
AvgRtfloat

全场景平均 RT

170.49
AvgTpsfloat

全场景平均 TPS

100.61
FailCountBizlong

全场景业务失败数

0
FailCountReqlong

全场景请求失败数

0
Seg90Rtfloat

90 分位 RT

170
Seg99Rtfloat

99 分位 RT

284
SuccessRateBizfloat

全场景业务成功率

0
SuccessRateReqfloat

全场景请求成功率

1
SceneSnapShotobject

场景快照信息

AdvanceSettingobject

场景高级设置

ConnectionTimeoutInSecondinteger

全场景超时时间

5
DomainBindingListarray<object>

域名和 IP 的绑定关系

DomainBindingobject
Domainstring

域名

www.example.com
Ipsarray

域名绑定的 IP

Stringstring

域名绑定的 IP

[192.168.0.1]
LogRateinteger

日志采样率

1
SuccessCodestring

自定义成功状态码

CreateTimestring

创建时间

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

场景使用的文件信息

FileParameterobject
FileNamestring

文件名

test.csv
FileOssAddressstring

文件的 OSS 地址

https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.csv
GlobalParameterListarray<object>

全局变量

GlobalParameterobject
ParamNamestring

参数名

username
ParamValuestring

参数值

user01
LoadConfigobject

施压配置信息

AgentCountinteger

施压机数量

1
ApiLoadConfigListarray<object>

API 的 RPS 起始信息

ApiLoadConfigobject
RpsBegininteger

起始 RPS

10
RpsLimitinteger

最大 RPS

10
Configurationobject

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

AllConcurrencyBegininteger

全场景起始并发

0
AllConcurrencyLimitinteger

全场景最大并发

500
AllRpsBegininteger

全场景起始 RPS

100
AllRpsLimitinteger

全场景最大 RPS

1000
MaxRunningTimeinteger

运行时长,单位分钟。

2
RelationLoadConfigListarray<object>

链路起始和最大并发配置

RelationLoadConfigobject
ConcurrencyBegininteger

起始并发

10
ConcurrencyLimitinteger

最大并发

20
TestModestring

施压模式

TPS
ModifiedTimestring

修改时间

2020-10-10 10:10:10
RelationListarray<object>

链路信息

Relationobject
ApiListarray<object>

API 信息

Apiobject
ApiIdstring

API ID

MNB45
ApiNamestring

API 名称

Test-API
Bodyobject

请求的 Body 信息

BodyValuestring

body 值

{key:value}
ContentTypestring

body 类型

application/x-www-form-urlencoded
CheckPointListarray<object>

API 的所有检查点

CheckPointobject
CheckPointstring

检查点

userId
CheckTypestring

检查类型

EXPORTED_PARAM
ExpectValuestring

期望值

111
Operatorstring

比较符号

ctn
ExportListarray<object>

导出参数列表

Exportobject
Countstring

导出参数匹配项

1
ExportNamestring

导出参数名

userId
ExportTypestring

导出参数来源

BODY_JSON
ExportValuestring

导出参数解析表达式

data.userId
HeaderListarray<object>

压测 URL 的 Header 信息

Headerobject
HeaderNamestring

参数名

User-Agent
HeaderValuestring

参数值

PTS
Methodstring

请求方法

GET
RedirectCountLimitinteger

重定向次数

5
TimeoutInSecondinteger

超时时间

5
Urlstring

压测的 URL

http://www.example.com/
FileParameterExplainListarray<object>

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

FileParameterExplainobject
BaseFileboolean

是否作为基准列

true
CycleOnceboolean

是否只循环一次

false
FileNamestring

文件名

test.csv
FileParamNamestring

文件中的参数名

username
RelationIdstring

链路 ID

HGBN4D
RelationNamestring

链路名

Test-session-1
SceneIdstring

场景 ID

7HBNS3
SceneNamestring

场景名

PTS-TEST
Statusstring

场景状态

STOPPED
Successboolean

是否成功

  • true:成功
  • false:失败
true

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

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