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

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pts:GetPtsReportDetails

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SceneId	string	是	场景 ID，创建场景后系统生成的唯一表示。	G5HCVS
PlanId	string	是	每次启动场景生成的任务 ID。	OH5HA3VB

返回参数

名称	类型	描述	示例值
	object
Message	string	错误提示信息，若成功则不返回该字段。
RequestId	string	请求 ID	DC4E3177-6745-4925-B423-4E89VV34221A
ReportOverView	object	报告概要信息
ReportName	string	报告名	PTS-TEST
EndTime	string	压测结束时间	2024-09-20 10:41:33
StartTime	string	开始时间	2024-09-20 10:39:33
AgentCount	integer	施压机数量	1
ReportId	string	报告 ID	GHB56VD
Vum	integer	消耗的 VUM	1012
SceneMetrics	object	场景维度的指标信息
FailCountBiz	integer	全场景业务失败数	0
AllCount	integer	全场景总请求数	11872
SuccessRateBiz	number	全场景业务成功率	0
AvgRt	number	全场景平均 RT	170.49
FailCountReq	integer	全场景请求失败数	0
AvgTps	number	全场景平均 TPS	100.61
Seg99Rt	number	99 分位 RT	284
SuccessRateReq	number	全场景请求成功率	1
Seg90Rt	number	90 分位 RT	170
ApiMetricsList	array<object>	API 维度指标信息
	object
FailCountBiz	integer	业务失败数。定义了检查点时，不符合条件为失败。	0
Seg75Rt	number	75 分位 RT	169
AllCount	integer	总请求个数	11872
AvgTps	number	平均 TPS	100.61
MinRt	number	最小 RT，单位 ms。	162
Seg99Rt	number	99 分位 RT	284
Seg50Rt	number	50 分位 RT	168
MaxRt	number	最大 RT，单位 ms。	600
Seg90Rt	number	90 分位 RT	170
SuccessRateBiz	number	业务成功率。等于业务成功数/总请求数。	0
AvgRt	number	平均 RT，单位 ms。	170.49
FailCountReq	integer	请求失败数	0
SuccessRateReq	number	请求成功率。等于请求成功数/总请求数。	1
ApiName	string	API 名称	Test-API
HttpStatusCode	integer	HTTP 状态码,若成功则不返回该字段。
Code	string	系统状态码，若成功则不返回该字段。
SceneSnapShot	object	场景快照信息
Status	string	场景状态	STOPPED
LoadConfig	object	施压配置信息
ApiLoadConfigList	array<object>	API 的 RPS 起始信息
	object
RpsBegin	integer	起始 RPS	10
RpsLimit	integer	最大 RPS	10
MaxRunningTime	integer	运行时长，单位分钟。	2
RelationLoadConfigList	array<object>	链路起始和最大并发配置
	object
ConcurrencyBegin	integer	起始并发	10
ConcurrencyLimit	integer	最大并发	20
Configuration	object	全场景的并发或 RPS 限制信息
AllRpsBegin	integer	全场景起始 RPS	100
AllConcurrencyBegin	integer	全场景起始并发	0
AllConcurrencyLimit	integer	全场景最大并发	500
AllRpsLimit	integer	全场景最大 RPS	1000
AgentCount	integer	施压机数量	1
TestMode	string	施压模式	TPS
FileParameterList	array<object>	场景使用的文件信息
	object
FileOssAddress	string	文件的 OSS 地址	https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.csv
FileName	string	文件名	test.csv
ModifiedTime	string	修改时间	2020-10-10 10:10:10
AdvanceSetting	object	场景高级设置
LogRate	integer	日志采样率	1
DomainBindingList	array<object>	域名和 IP 的绑定关系
	object
Domain	string	域名	www.example.com
Ips	array	域名绑定的 IP
	string	域名绑定的 IP	[192.168.0.1]
ConnectionTimeoutInSecond	integer	全场景超时时间	5
SuccessCode	string	自定义成功状态码
CreateTime	string	创建时间	2024-09-20 09:28:10
RelationList	array<object>	链路信息
	object
RelationName	string	链路名	Test-session-1
FileParameterExplainList	array<object>	链路中使用到的文件参数说明
	object
CycleOnce	boolean	是否只循环一次	false
FileParamName	string	文件中的参数名	username
FileName	string	文件名	test.csv
BaseFile	boolean	是否作为基准列	true
ApiList	array<object>	API 信息
	object
ApiId	string	API ID	MNB45
CheckPointList	array<object>	API 的所有检查点
	object
CheckType	string	检查类型	EXPORTED_PARAM
Operator	string	比较符号	ctn
ExpectValue	string	期望值	111
CheckPoint	string	检查点	userId
HeaderList	array<object>	压测 URL 的 Header 信息
	object
HeaderValue	string	参数值	PTS
HeaderName	string	参数名	User-Agent
TimeoutInSecond	integer	超时时间	5
ExportList	array<object>	导出参数列表
	object
ExportType	string	导出参数来源	BODY_JSON
ExportValue	string	导出参数解析表达式	data.userId
ExportName	string	导出参数名	userId
Count	string	导出参数匹配项	1
Url	string	压测的 URL	http://www.example.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 名称	Test-API
RelationId	string	链路 ID	HGBN4D
SceneName	string	场景名	PTS-TEST
SceneId	string	场景 ID	7HBNS3
GlobalParameterList	array<object>	全局变量
	object
ParamName	string	参数名	username
ParamValue	string	参数值	user01
Success	boolean	是否成功 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	错误码	错误信息	描述
400	GetPtsReportDetailsFail	Report does not exist

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

变更历史

更多信息，参考变更详情。