文档

GetPtsReportDetails - 查询报告

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

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

G5HCVS
PlanIdstring

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

OH5HA3VB

返回参数

名称类型描述示例值
object
Messagestring

错误提示信息,若成功则为空。

RequestIdstring

请求 ID。

DC4E3177-6745-4925-B423-4E89VV34221A
ReportOverViewobject

报告概要信息。

ReportNamestring

报告名。

下单场景
EndTimestring

压测结束时间。

1988203944
StartTimestring

开始时间。

1988202944
AgentCountinteger

引擎数。施压需要的机器数,一个机器一个 IP。

1
ReportIdstring

报告 ID。

GHB56VD
Vumlong

消耗的 VUM。

100
SceneMetricsobject

场景维度的指标信息。

FailCountBizlong

全场景业务失败数。

35
AllCountlong

全场景总请求数。

100000
SuccessRateBizfloat

全场景业务成功率。

0.97
AvgRtfloat

全场景平均 RT。

23
FailCountReqlong

全场景请求失败数。

34
AvgTpsfloat

全场景平均 TPS。

78
Seg99Rtfloat

99 分位 RT。

56
SuccessRateReqfloat

全场景请求成功率

0.99
Seg90Rtfloat

90 分位 RT。

35
ApiMetricsListobject []

压测场景中每个 API 的指标信息。

FailCountBizlong

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

30
Seg75Rtfloat

75 分位 RT。

26
AllCountlong

总请求个数。

1000
AvgTpsfloat

平均 TPS。

55
MinRtfloat

最小 RT,单位 ms。

10
Seg99Rtfloat

99 分位 RT。

35
Seg50Rtfloat

50 分位 RT。

39
MaxRtfloat

最大 RT,单位 ms。

50
Seg90Rtfloat

90 分位 RT。

23
SuccessRateBizfloat

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

0.98
AvgRtfloat

平均 RT,单位 ms。

34.5
FailCountReqlong

请求失败数。

40
SuccessRateReqfloat

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

0.99
ApiNamestring

API 名

下单
HttpStatusCodeinteger

HTTP 状态码。

200
Codestring

系统状态码。

200
SceneSnapShotobject

场景快照信息。

Statusstring

场景状态。

STOPPED
LoadConfigobject

施压配置信息。

ApiLoadConfigListobject []

API 的 RPS 起始信息。

RpsBegininteger

起始 RPS。

10
RpsLimitinteger

最大 RPS。

10
MaxRunningTimeinteger

运行时长,单位分钟。

2
RelationLoadConfigListobject []

链路起始和最大并发配置。

ConcurrencyBegininteger

起始并发。

10
ConcurrencyLimitinteger

最大并发。

20
Configurationobject

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

AllRpsBegininteger

全场景起始 RPS。

80
AllConcurrencyBegininteger

全场景起始并发。

10
AllConcurrencyLimitinteger

全场景最大并发。

10
AllRpsLimitinteger

全场景最大 RPS。

160
AgentCountinteger

施压使用的机器数。

1
TestModestring

施压模式。

tps_mode
FileParameterListobject []

场景使用的文件信息。

FileOssAddressstring

文件的 OSS 地址。

https://www.sss.ccv
FileNamestring

文件名。

city.csv
ModifiedTimestring

修改时间。

2020-10-10 10:10:10
AdvanceSettingobject

场景高级设置。

LogRateinteger

日志采样率。

1
DomainBindingListobject []

域名和 IP 的绑定关系。

Domainstring

域名。

www.xxx.com
Ipsarray

域名绑定的 IP。

string

域名绑定的 IP。

[1.1.1.1]
ConnectionTimeoutInSecondinteger

全场景超时时间。

5
SuccessCodestring

自定义成功状态码。

429,404
CreateTimestring

创建时间。

2023-11-28 16:11:20
RelationListobject []

链路信息。

RelationNamestring

链路名。

下单链路
FileParameterExplainListobject []

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

CycleOnceboolean

是否只循环一次。

true
FileParamNamestring

文件中的参数名。

address,name
FileNamestring

文件名。

city.csv
BaseFileboolean

是否作为基准列。

true
ApiListobject []

API 信息。

ApiIdstring

API ID。

MNB45
CheckPointListobject []

API 的所有检查点。

CheckTypestring

检查类型。

EXPORTED_PARAM
Operatorstring

比较符号。

ctn
ExpectValuestring

期望值。

111
CheckPointstring

检查点。

userId
HeaderListobject []

压测 URL 的 Header 信息。

HeaderValuestring

参数值。

1111
HeaderNamestring

参数名。

userName
TimeoutInSecondinteger

超时时间。

5
ExportListobject []

导出参数列表。

ExportTypestring

导出参数来源。

BODY_JSON
ExportValuestring

导出参数解析表达式。

data.userId
ExportNamestring

导出参数名。

userId
Countstring

导出参数匹配项。

1
Urlstring

压测的 URL。

https://www.xxx.com
Methodstring

请求方法。

GET
Bodyobject

请求的 Body 信息。

BodyValuestring

body 值。

{key:value}
ContentTypestring

body 类型。

application/x-www-form-urlencoded
RedirectCountLimitinteger

重定向次数。

5
ApiNamestring

API 名称。

测试API
RelationIdstring

链路 ID。

HGBN4D
SceneNamestring

场景名。

下单场景
SceneIdstring

场景 ID。

7HBNS3
GlobalParameterListobject []

全局变量。

ParamNamestring

参数名。

userName
ParamValuestring

参数值。

lisi
Successboolean

是否成功。

  • 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": "2023-11-28 16:11:20",
    "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错误码错误信息
400GetPtsReportDetailsFailReport does not exist

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)