调用GetPtsReportDetails查询报告_性能测试 PTS-阿里云帮助中心

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SceneId	string	是	场景ID。更多信息，请参见参数说明。	G5HCVS
PlanId	string	是	每次启动场景生成的任务ID。更多信息，请参见参数说明。	OH5HA3VB

返回参数

名称	类型	描述	示例值
	object
Message	string	错误提示信息，若成功则为空。	空
RequestId	string	请求ID。	DC4E3177-6745-4925-B423-4E89VV34221A
ReportOverView	object	报告概要信息。
ReportName	string	报告名。	下单场景
EndTime	string	压测结束时间。	1988203944
StartTime	string	开始时间。	1988202944
AgentCount	integer	引擎数。施压需要的机器数，一个机器一个IP。	1
ReportId	string	报告ID。	GHB56VD
Vum	long	消耗的VUM。	100
SceneMetrics	object	场景维度的指标信息。
FailCountBiz	long	全场景业务失败数。	35
AllCount	long	全场景总请求数。	100000
SuccessRateBiz	float	全场景业务成功率。	0.97
AvgRt	float	全场景平均RT。	23
FailCountReq	long	全场景请求失败数。	34
AvgTps	float	全场景平均TPS。	78
Seg99Rt	float	99分位RT。	56
SuccessRateReq	float	全场景请求成功率	0.99
Seg90Rt	float	90分位RT。	35
ApiMetricsList	array	压测场景中每个API的指标信息。
	object
FailCountBiz	long	业务失败数。定义了检查点时，不符合条件为失败。	30
Seg75Rt	float	75分位RT。	26
AllCount	long	总请求个数。	1000
AvgTps	float	平均TPS。	55
MinRt	float	最小RT，单位ms。	10
Seg99Rt	float	99分位RT。	35
Seg50Rt	float	50分位RT。	39
MaxRt	float	最大RT，单位ms。	50
Seg90Rt	float	90分位RT。	23
SuccessRateBiz	float	业务成功率。等于业务成功数/总请求数。	0.98
AvgRt	float	平均RT，单位ms。	34.5
FailCountReq	long	请求失败数。	40
SuccessRateReq	float	请求成功率。等于请求成功数/总请求数。	0.99
ApiName	string	API名	下单
HttpStatusCode	integer	HTTP状态码。	200
Code	string	系统状态码。	200
SceneSnapShot	object	场景快照信息。
Status	string	场景状态。	STOPPED
LoadConfig	object	施压配置信息。
ApiLoadConfigList	array	API的RPS起始信息。
	object
RpsBegin	integer	起始RPS。	10
RpsLimit	integer	最大RPS。	10
MaxRunningTime	integer	运行时长，单位分钟。	2
RelationLoadConfigList	array	链路起始和最大并发配置。
	object
ConcurrencyBegin	integer	起始并发。	10
ConcurrencyLimit	integer	最大并发。	20
Configuration	object	全场景的并发或RPS限制信息。
AllRpsBegin	integer	全场景起始RPS。	80
AllConcurrencyBegin	integer	全场景起始并发。	10
AllConcurrencyLimit	integer	全场景最大并发。	10
AllRpsLimit	integer	全场景最大RPS。	160
AgentCount	integer	施压使用的机器数。	1
TestMode	string	施压模式。	tps_mode
FileParameterList	array	场景使用的文件信息。
	object
FileOssAddress	string	文件的OSS地址。	https://www.sss.ccv
FileName	string	文件名。	city.csv
ModifiedTime	string	修改时间。	2020-10-10 10:10:10
AdvanceSetting	object	场景高级设置。
LogRate	integer	日志采样率。	1
DomainBindingList	array	域名和IP的绑定关系。
	object
Domain	string	域名。	www.xxx.com
Ips	array	域名绑定的IP。
	string	域名绑定的IP。	[1.1.1.1]
ConnectionTimeoutInSecond	integer	全场景超时时间。	5
SuccessCode	string	自定义成功状态码。	429,404
CreateTime	string	创建时间。	12684449000
RelationList	array	链路信息。
	object
RelationName	string	链路名。	下单链路
FileParameterExplainList	array	链路中使用到的文件参数说明。
	object
CycleOnce	boolean	是否只循环一次。	true
FileParamName	string	文件中的参数名。	address,name
FileName	string	文件名。	city.csv
BaseFile	boolean	是否作为基准列。	true
ApiList	array	API信息。
	object
ApiId	string	API ID。	MNB45
CheckPointList	array	API的所有检查点。
	object
CheckType	string	检查类型。	EXPORTED_PARAM
Operator	string	比较符号。	ctn
ExpectValue	string	期望值。	111
CheckPoint	string	检查点。	userId
HeaderList	array	压测URL的Header信息。
	object
HeaderValue	string	参数值。	1111
HeaderName	string	参数名。	userName
TimeoutInSecond	integer	超时时间。	5
ExportList	array	导出参数列表。
	object
ExportType	string	导出参数来源。	BODY_JSON
ExportValue	string	导出参数解析表达式。	data.userId
ExportName	string	导出参数名。	userId
Count	string	导出参数匹配项。	1
Url	string	压测的URL。	https://www.xxx.com
Method	string	请求方法。	GET
Body	object	请求的Body信息。
BodyValue	string	body值。	{key:value}
ContentType	string	body类型。	application/x-www-form-urlencoded
RedirectCountLimit	integer	重定向次数。	5
ApiName	string	API名称。	测试API
RelationId	string	链路ID。	HGBN4D
SceneName	string	场景名。	下单场景
SceneId	string	场景ID。	7HBNS3
GlobalParameterList	array	全局变量。
	object
ParamName	string	参数名。	userName
ParamValue	string	参数值。	lisi
Success	boolean	是否成功。 true：成功 false：失败	true

示例

正常返回示例

JSON格式

{
  "Message": "空",
  "RequestId": "DC4E3177-6745-4925-B423-4E89VV34221A",
  "ReportOverView": {
    "ReportName": "下单场景",
    "EndTime": "1988203944",
    "StartTime": "1988202944",
    "AgentCount": 1,
    "ReportId": "GHB56VD",
    "Vum": 100
  },
  "SceneMetrics": {
    "FailCountBiz": 35,
    "AllCount": 100000,
    "SuccessRateBiz": 0.97,
    "AvgRt": 23,
    "FailCountReq": 34,
    "AvgTps": 78,
    "Seg99Rt": 56,
    "SuccessRateReq": 0.99,
    "Seg90Rt": 35
  },
  "ApiMetricsList": [
    {
      "FailCountBiz": 30,
      "Seg75Rt": 26,
      "AllCount": 1000,
      "AvgTps": 55,
      "MinRt": 10,
      "Seg99Rt": 35,
      "Seg50Rt": 39,
      "MaxRt": 50,
      "Seg90Rt": 23,
      "SuccessRateBiz": 0.98,
      "AvgRt": 34.5,
      "FailCountReq": 40,
      "SuccessRateReq": 0.99,
      "ApiName": "下单"
    }
  ],
  "HttpStatusCode": 200,
  "Code": "200",
  "SceneSnapShot": {
    "Status": "STOPPED",
    "LoadConfig": {
      "ApiLoadConfigList": [
        {
          "RpsBegin": 10,
          "RpsLimit": 10
        }
      ],
      "MaxRunningTime": 2,
      "RelationLoadConfigList": [
        {
          "ConcurrencyBegin": 10,
          "ConcurrencyLimit": 20
        }
      ],
      "Configuration": {
        "AllRpsBegin": 80,
        "AllConcurrencyBegin": 10,
        "AllConcurrencyLimit": 10,
        "AllRpsLimit": 160
      },
      "AgentCount": 1,
      "TestMode": "tps_mode"
    },
    "FileParameterList": [
      {
        "FileOssAddress": "https://www.sss.ccv",
        "FileName": "city.csv"
      }
    ],
    "ModifiedTime": "2020-10-10 10:10:10",
    "AdvanceSetting": {
      "LogRate": 1,
      "DomainBindingList": [
        {
          "Domain": "www.xxx.com",
          "Ips": [
            "[1.1.1.1]"
          ]
        }
      ],
      "ConnectionTimeoutInSecond": 5,
      "SuccessCode": "429,404"
    },
    "CreateTime": "12684449000",
    "RelationList": [
      {
        "RelationName": "下单链路",
        "FileParameterExplainList": [
          {
            "CycleOnce": true,
            "FileParamName": "address,name",
            "FileName": "city.csv",
            "BaseFile": true
          }
        ],
        "ApiList": [
          {
            "ApiId": "MNB45",
            "CheckPointList": [
              {
                "CheckType": "EXPORTED_PARAM",
                "Operator": "ctn",
                "ExpectValue": "111",
                "CheckPoint": "userId"
              }
            ],
            "HeaderList": [
              {
                "HeaderValue": "1111",
                "HeaderName": "userName"
              }
            ],
            "TimeoutInSecond": 5,
            "ExportList": [
              {
                "ExportType": "BODY_JSON",
                "ExportValue": "data.userId",
                "ExportName": "userId",
                "Count": "1"
              }
            ],
            "Url": "https://www.xxx.com",
            "Method": "GET",
            "Body": {
              "BodyValue": "{key:value}",
              "ContentType": "application/x-www-form-urlencoded"
            },
            "RedirectCountLimit": 5,
            "ApiName": "测试API"
          }
        ],
        "RelationId": "HGBN4D"
      }
    ],
    "SceneName": "下单场景",
    "SceneId": "7HBNS3",
    "GlobalParameterList": [
      {
        "ParamName": "userName",
        "ParamValue": "lisi"
      }
    ]
  },
  "Success": true
}

错误码

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

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