GetPtsReportDetails - 查询报告

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
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
SuccessRateBiznumber

全场景业务成功率。

0.97
AvgRtnumber

全场景平均RT。

23
FailCountReqLong

全场景请求失败数。

34
AvgTpsnumber

全场景平均TPS。

78
Seg99Rtnumber

99分位RT。

56
SuccessRateReqnumber

全场景请求成功率

0.99
Seg90Rtnumber

90分位RT。

35
ApiMetricsListarray

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

object
FailCountBizLong

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

30
Seg75Rtnumber

75分位RT。

26
AllCountLong

总请求个数。

1000
AvgTpsnumber

平均TPS。

55
MinRtnumber

最小RT,单位ms。

10
Seg99Rtnumber

99分位RT。

35
Seg50Rtnumber

50分位RT。

39
MaxRtnumber

最大RT,单位ms。

50
Seg90Rtnumber

90分位RT。

23
SuccessRateBiznumber

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

0.98
AvgRtnumber

平均RT,单位ms。

34.5
FailCountReqLong

请求失败数。

40
SuccessRateReqnumber

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

0.99
ApiNamestring

API名

下单
HttpStatusCodeinteger

HTTP状态码。

200
Codestring

系统状态码。

200
SceneSnapShotobject

场景快照信息。

Statusstring

场景状态。

STOPPED
LoadConfigobject

施压配置信息。

ApiLoadConfigListarray

API的RPS起始信息。

object
RpsBegininteger

起始RPS。

10
RpsLimitinteger

最大RPS。

10
MaxRunningTimeinteger

运行时长,单位分钟。

2
RelationLoadConfigListarray

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

object
ConcurrencyBegininteger

起始并发。

10
ConcurrencyLimitinteger

最大并发。

20
Configurationobject

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

AllRpsBegininteger

全场景起始RPS。

80
AllConcurrencyBegininteger

全场景起始并发。

10
AllConcurrencyLimitinteger

全场景最大并发。

10
AllRpsLimitinteger

全场景最大RPS。

160
AgentCountinteger

施压使用的机器数。

1
TestModestring

施压模式。

tps_mode
FileParameterListarray

场景使用的文件信息。

object
FileOssAddressstring

文件的OSS地址。

https://www.sss.ccv
FileNamestring

文件名。

city.csv
ModifiedTimestring

修改时间。

2020-10-10 10:10:10
AdvanceSettingobject

场景高级设置。

LogRateinteger

日志采样率。

1
DomainBindingListarray

域名和IP的绑定关系。

object
Domainstring

域名。

www.xxx.com
Ipsarray

域名绑定的IP。

string

域名绑定的IP。

[1.1.1.1]
ConnectionTimeoutInSecondinteger

全场景超时时间。

5
SuccessCodestring

自定义成功状态码。

429,404
CreateTimestring

创建时间。

12684449000
RelationListarray

链路信息。

object
RelationNamestring

链路名。

下单链路
FileParameterExplainListarray

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

object
CycleOnceboolean

是否只循环一次。

true
FileParamNamestring

文件中的参数名。

address,name
FileNamestring

文件名。

city.csv
BaseFileboolean

是否作为基准列。

true
ApiListarray

API信息。

object
ApiIdstring

API ID。

MNB45
CheckPointListarray

API的所有检查点。

object
CheckTypestring

检查类型。

EXPORTED_PARAM
Operatorstring

比较符号。

ctn
ExpectValuestring

期望值。

111
CheckPointstring

检查点。

userId
HeaderListarray

压测URL的Header信息。

object
HeaderValuestring

参数值。

1111
HeaderNamestring

参数名。

userName
TimeoutInSecondinteger

超时时间。

5
ExportListarray

导出参数列表。

object
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
GlobalParameterListarray

全局变量。

object
ParamNamestring

参数名。

userName
ParamValuestring

参数值。

lisi
Successboolean

是否成功。

  • true:成功
  • false:失败
true

示例

请求示例

   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;
    }

正常返回示例

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.aliyundoc.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.aliyundoc.com",
                    "Ips":"[1.1.1.1]"
                }]
            }
        },
        "Success":"true"
    }

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</AvgTps>
        <AvgRt>34.5</AvgRt>
    </ApiMetricsList>
    <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>https://www.aliyundoc.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.aliyundoc.com</Domain>
                <Ips>[1.1.1.1]</Ips>
            </DomainBindingList>
        </AdvanceSetting>
    </SceneSnapShot>
    <Success>true</Success>
</GetPtsReportDetailsResponse>

错误码

Http code错误码错误信息
400GetPtsReportDetailsFailReport does not exist

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

阿里云首页 性能测试 PTS 相关技术圈