调用GetPtsReportDetails接口查询一个报告的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetPtsReportDetails

系统规定参数。取值:GetPtsReportDetails

SceneId String G5HCVS

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

PlanId String OH5HA3VB

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

返回数据

名称 类型 示例值 描述
Message String

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

RequestId String DC4E3177-6745-4925-B423-4E89VV34221A

请求ID。

ReportOverView Object

报告概要信息。

ReportName String 下单场景

报告名。

EndTime String 1988203944

压测结束时间。

StartTime String 1988202944

开始时间。

AgentCount Integer 1

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

ReportId String GHB56VD

报告ID。

Vum Long 100

消耗的VUM。

SceneMetrics Object

场景维度的指标信息。

FailCountBiz Long 35

全场景业务失败数。

AllCount Long 100000

全场景总请求数。

SuccessRateBiz Float 0.97

全场景业务成功率。

AvgRt Float 23

全场景平均RT。

FailCountReq Long 34

全场景请求失败数。

AvgTps Float 78

全场景平均TPS。

Seg99Rt Float 56

99分位RT。

SuccessRateReq Float 0.99

全场景请求成功率

Seg90Rt Float 35

90分位RT。

ApiMetricsList Array of ApiMetrics

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

FailCountBiz Long 30

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

Seg75Rt Float 26

75分位RT。

AllCount Long 1000

总请求个数。

AvgTps Float 55

平均TPS。

MinRt Float 10

最小RT,单位ms。

Seg99Rt Float 35

99分位RT。

Seg50Rt Float 39

50分位RT。

MaxRt Float 50

最大RT,单位ms。

Seg90Rt Float 23

90分位RT。

SuccessRateBiz Float 0.98

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

AvgRt Float 34.5

平均RT,单位ms。

FailCountReq Long 40

请求失败数。

SuccessRateReq Float 0.99

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

ApiName String 下单

API名

HttpStatusCode Integer 200

HTTP状态码。

Code String 200

系统状态码。

SceneSnapShot Object

场景快照信息。

Status String STOPPED

场景状态。

LoadConfig Object

施压配置信息。

ApiLoadConfigList Array of ApiLoadConfig

API的RPS起始信息。

RpsBegin Integer 10

起始RPS。

RpsLimit Integer 10

最大RPS。

MaxRunningTime Integer 2

运行时长,单位分钟。

RelationLoadConfigList Array of RelationLoadConfig

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

ConcurrencyBegin Integer 10

起始并发。

ConcurrencyLimit Integer 20

最大并发。

Configuration Object

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

AllRpsBegin Integer 80

全场景起始RPS。

AllConcurrencyBegin Integer 10

全场景起始并发。

AllConcurrencyLimit Integer 10

全场景最大并发。

AllRpsLimit Integer 160

全场景最大RPS。

AgentCount Integer 1

施压使用的机器数。

TestMode String tps_mode

施压模式。

FileParameterList Array of FileParameter

场景使用的文件信息。

FileOssAddress String https://www.sss.ccv

文件的OSS地址。

FileName String city.csv

文件名。

ModifiedTime String 2020-10-10 10:10:10

修改时间。

AdvanceSetting Object

场景高级设置。

LogRate Integer 1

日志采样率。

DomainBindingList Array of DomainBinding

域名和IP的绑定关系。

Domain String www.xxx.com

域名。

Ips Array of String [1.1.1.1]

域名绑定的IP。

ConnectionTimeoutInSecond Integer 5

全场景超时时间。

SuccessCode String 429,404

自定义成功状态码。

CreateTime String 12684449000

创建时间。

RelationList Array of Relation

链路信息。

RelationName String 下单链路

链路名。

FileParameterExplainList Array of FileParameterExplain

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

CycleOnce Boolean true

是否只循环一次。

FileParamName String address,name

文件中的参数名。

FileName String city.csv

文件名。

BaseFile Boolean true

是否作为基准列。

ApiList Array of Api

API信息。

ApiId String MNB45

API ID。

CheckPointList Array of CheckPoint

API的所有检查点。

CheckType String EXPORTED_PARAM

检查类型。

Operator String ctn

比较符号。

ExpectValue String 111

期望值。

CheckPoint String userId

检查点。

HeaderList Array of Header

压测URL的Header信息。

HeaderValue String 1111

参数值。

HeaderName String userName

参数名。

TimeoutInSecond Integer 5

超时时间。

ExportList Array of Export

导出参数列表。

ExportType String BODY_JSON

导出参数来源。

ExportValue String data.userId

导出参数解析表达式。

ExportName String userId

导出参数名。

Count String 1

导出参数匹配项。

Url String https://www.xxx.com

压测的URL。

Method String GET

请求方法。

Body Object

请求的Body信息。

BodyValue String {key:value}

body值。

ContentType String application/x-www-form-urlencoded

body类型。

RedirectCountLimit Integer 5

重定向次数。

ApiName String 测试API

API名称。

RelationId String HGBN4D

链路ID。

SceneName String 下单场景

场景名。

SceneId String 7HBNS3

场景ID。

GlobalParameterList Array of GlobalParameter

全局变量。

ParamName String userName

参数名。

ParamValue String lisi

参数值。

Success Boolean true

是否成功。

  • true:成功
  • false:失败

示例

请求示例

public static void main(String[] args) {

        //账号的AccessKey ID和AccessKey Secret。
        String accessKeyId = "xxx";
        String accessKeySecret = "xxx";
        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessSecret);
        IAcsClient client = new DefaultAcsClient(profile);

        String sceneId = "sceneId";
        String planId = "planId";
        GetPtsReportDetailsResponse response = getPtsReportDetails(sceneId, planId, client);
        if (response.getSuccess()) {
            System.out.println("查询报告数据成功");
        } else {
            System.out.println("删除失败,失败原因:" + response.getMessage());
        }
    }

    /**
     * 查询报告详情。
     */
    public static GetPtsReportDetailsResponse getPtsReportDetails(String sceneId, String planId, IAcsClient client) {
        GetPtsReportDetailsResponse response = new GetPtsReportDetailsResponse();
        if (null == sceneId || null == planId || null == client) {
            response.setMessage("查询报告详情,入参不能为空");
            return response;
        }
        GetPtsReportDetailsRequest request = new GetPtsReportDetailsRequest();
        request.setSceneId(sceneId);
        request.setPlanId(planId);
        try {
            response = client.getAcsResponse(request);
        } catch (ServerException e) {
            response.setMessage(e.getErrMsg());
            response.setCode(e.getErrCode());
            response.setRequestId(e.getRequestId());
        } catch (ClientException e) {
            response.setMessage(e.getErrMsg());
            response.setCode(e.getErrCode());
            response.setRequestId(e.getRequestId());
        }
        return response;
    }

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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