调用GetPtsScene接口查询场景信息。

调试

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

请求参数

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

系统规定参数。取值:GetPtsScene

SceneId String NKJBSH

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

返回数据

名称 类型 示例值 描述
Message String

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

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

请求ID。

HttpStatusCode Integer 200

HTTP状态码。

Scene Object

场景结构。

Status String Running

场景状态。

LoadConfig Object

施压配置信息。

ApiLoadConfigList Array of ApiLoadConfig

API施压配置信息。

RpsBegin Integer 10

起始RPS。

RpsLimit Integer 20

最大RPS。

MaxRunningTime Integer 2

运行时长,单位分钟。

RelationLoadConfigList Array of RelationLoadConfig

链路施压配置信息。

ConcurrencyBegin Integer 10

起始并发。

ConcurrencyLimit Integer 20

最大并发。

Configuration Object

全场景并发或RPS配置信息。

AllRpsBegin Integer 100

起始RPS

AllConcurrencyBegin Integer 100

起始并发

AllConcurrencyLimit Integer 200

最大并发

AllRpsLimit Integer 200

最大RPS

AgentCount Integer 1

施压机器。

TestMode String tps_mode

施压模式。tps_mode表示施压模式为RPS模式。

FileParameterList Array of FileParameter

文件参数。

FileOssAddress String https://oss.ccccc

文件OSS地址。

FileName String city.csv

文件名。

ModifiedTime String 2021-03-26 15:30:30

最新修改时间。

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,304

自定义成功状态码。

CreateTime String 2021-02-26 15:30:30

创建时间。

RelationList Array of Relation

链路信息。

RelationName String 下单链路

链路名。

FileParameterExplainList Array of FileParameterExplain

文件参数说明。

CycleOnce Boolean true

是否循环一次。

FileParamName String userName,age

文件中的参数名。

FileName String city.csv

文件名。

BaseFile Boolean true

是否作为基准列。

ApiList Array of Api

API信息。

ApiId String GBFDCV8

API ID。

CheckPointList Array of CheckPoint

所有检查点。

CheckType String EXPORTED_PARAM

检查类型。

Operator String ctn

比较符号。

ExpectValue String 111

期望值。

CheckPoint String userId

检查点。

HeaderList Array of Header

Header信息。

HeaderValue String 1111

参数值。

HeaderName String userId

参数名。

TimeoutInSecond Integer 5

超时时间,单位秒。

ExportList Array of Export

所有导出参数。

ExportType String BODY_JSON

导出参数来源。

ExportValue String username

解释表达式。

ExportName String data.username

导出参数名。

Count String 0

导出参数匹配项。

Url String https://www.xxx.com

请求URL。

Method String GET

请求方法。

Body Object

Body内容。

BodyValue String {\"key1\":\"111\",\"key2\":\"222\"}

Body值。

ContentType String application/x-www-form-urlencoded

Body类型。

RedirectCountLimit Integer 5

重定向次数。

ApiName String 下单

API名称。

RelationId String HNBGS7M

链路ID。

SceneName String 下单场景

场景名。

SceneId String BGFJ7GV

场景ID。

GlobalParameterList Array of GlobalParameter

全局参数。

ParamName String userName

参数名。

ParamValue String lisi

参数值。

Code String 200

系统状态码。

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";
        GetPtsSceneResponse response = getPtsScene(sceneId, client);
        if (response.getSuccess()) {
            System.out.println("查询成功");
        } else {
            System.out.println("查询失败,失败原因:" + response.getMessage());
        }
    }

    /**
     * 查询场景结构。
     */
    public static GetPtsSceneResponse getPtsScene(String sceneId, IAcsClient client) {
        GetPtsSceneResponse response = new GetPtsSceneResponse();
        if (null == sceneId || null == client) {
            response.setMessage("查询场景结构,入参不能为空");
            return response;
        }
        GetPtsSceneRequest request = new GetPtsSceneRequest();
        request.setSceneId(sceneId);
        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

<GetPtsSceneResponse>
    <Message/>
    <RequestId>DC4E3177-6745-4925-B423-4E89VV34221A</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Scene>
        <Status>Running</Status>
        <SceneId>BGFJ7GV</SceneId>
        <ModifiedTime>2021-03-26 15:30:30</ModifiedTime>
        <SceneName>下单场景</SceneName>
        <CreateTime>2021-02-26 15:30:30</CreateTime>
        <RelationList>
            <RelationId>HNBGS7M</RelationId>
            <RelationName>下单链路</RelationName>
            <ApiList>
                <ApiName>下单</ApiName>
                <RedirectCountLimit>5</RedirectCountLimit>
                <Method>GET</Method>
                <TimeoutInSecond>5</TimeoutInSecond>
                <ApiId>GBFDCV8</ApiId>
                <Url>https://www.xxx.com</Url>
                <ExportList>
                    <ExportType>BODY_JSON</ExportType>
                    <ExportName>data.username</ExportName>
                    <Count>0</Count>
                    <ExportValue>username</ExportValue>
                </ExportList>
                <CheckPointList>
                    <Operator>ctn</Operator>
                    <ExpectValue>111</ExpectValue>
                    <CheckType>EXPORTED_PARAM</CheckType>
                    <CheckPoint>userId</CheckPoint>
                </CheckPointList>
                <HeaderList>
                    <HeaderValue>1111</HeaderValue>
                    <HeaderName>userId</HeaderName>
                </HeaderList>
                <Body>
                    <ContentType>application/x-www-form-urlencoded</ContentType>
                    <BodyValue>{\"key1\":\"111\",\"key2\":\"222\"}</BodyValue>
                </Body>
            </ApiList>
            <FileParameterExplainList>
                <BaseFile>true</BaseFile>
                <CycleOnce>true</CycleOnce>
                <FileParamName>userName,age</FileParamName>
                <FileName>city.csv</FileName>
            </FileParameterExplainList>
        </RelationList>
        <FileParameterList>
            <FileName>city.csv</FileName>
            <FileOssAddress>https://oss.ccccc</FileOssAddress>
        </FileParameterList>
        <GlobalParameterList>
            <ParamValue>lisi</ParamValue>
            <ParamName>userName</ParamName>
        </GlobalParameterList>
        <LoadConfig>
            <AgentCount>1</AgentCount>
            <TestMode>tps_mode</TestMode>
            <MaxRunningTime>2</MaxRunningTime>
            <ApiLoadConfigList>
                <RpsLimit>20</RpsLimit>
                <RpsBegin>10</RpsBegin>
            </ApiLoadConfigList>
            <RelationLoadConfigList>
                <ConcurrencyLimit>20</ConcurrencyLimit>
                <ConcurrencyBegin>10</ConcurrencyBegin>
            </RelationLoadConfigList>
            <Configuration>
                <AllRpsBegin>100</AllRpsBegin>
                <AllRpsLimit>200</AllRpsLimit>
                <AllConcurrencyBegin>100</AllConcurrencyBegin>
                <AllConcurrencyLimit>200</AllConcurrencyLimit>
            </Configuration>
        </LoadConfig>
        <AdvanceSetting>
            <LogRate>1</LogRate>
            <ConnectionTimeoutInSecond>5</ConnectionTimeoutInSecond>
            <SuccessCode>429,304</SuccessCode>
            <DomainBindingList>
                <Domain>www.xxx.com</Domain>
                <Ips>[1.1.1.1]</Ips>
            </DomainBindingList>
        </AdvanceSetting>
    </Scene>
    <Code>200</Code>
    <Success>true</Success>
</GetPtsSceneResponse>

JSON格式

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

{
  "Message" : "",
  "RequestId" : "DC4E3177-6745-4925-B423-4E89VV34221A",
  "HttpStatusCode" : "200",
  "Scene" : {
    "Status" : "Running",
    "SceneId" : "BGFJ7GV",
    "ModifiedTime" : "2021-03-26 15:30:30",
    "SceneName" : "下单场景",
    "CreateTime" : "2021-02-26 15:30:30",
    "RelationList" : [ {
      "RelationId" : "HNBGS7M",
      "RelationName" : "下单链路",
      "ApiList" : [ {
        "ApiName" : "下单",
        "RedirectCountLimit" : "5",
        "Method" : "GET",
        "TimeoutInSecond" : "5",
        "ApiId" : "GBFDCV8",
        "Url" : "https://www.xxx.com",
        "ExportList" : [ {
          "ExportType" : "BODY_JSON",
          "ExportName" : "data.username",
          "Count" : "0",
          "ExportValue" : "username"
        } ],
        "CheckPointList" : [ {
          "Operator" : "ctn",
          "ExpectValue" : "111",
          "CheckType" : "EXPORTED_PARAM",
          "CheckPoint" : "userId"
        } ],
        "HeaderList" : [ {
          "HeaderValue" : "1111",
          "HeaderName" : "userId"
        } ],
        "Body" : {
          "ContentType" : "application/x-www-form-urlencoded",
          "BodyValue" : "{\\\"key1\\\":\\\"111\\\",\\\"key2\\\":\\\"222\\\"}"
        }
      } ],
      "FileParameterExplainList" : [ {
        "BaseFile" : "true",
        "CycleOnce" : "true",
        "FileParamName" : "userName,age",
        "FileName" : "city.csv"
      } ]
    } ],
    "FileParameterList" : [ {
      "FileName" : "city.csv",
      "FileOssAddress" : "https://oss.ccccc"
    } ],
    "GlobalParameterList" : [ {
      "ParamValue" : "lisi",
      "ParamName" : "userName"
    } ],
    "LoadConfig" : {
      "AgentCount" : "1",
      "TestMode" : "tps_mode",
      "MaxRunningTime" : "2",
      "ApiLoadConfigList" : [ {
        "RpsLimit" : "20",
        "RpsBegin" : "10"
      } ],
      "RelationLoadConfigList" : [ {
        "ConcurrencyLimit" : "20",
        "ConcurrencyBegin" : "10"
      } ],
      "Configuration" : {
        "AllRpsBegin" : "100",
        "AllRpsLimit" : "200",
        "AllConcurrencyBegin" : "100",
        "AllConcurrencyLimit" : "200"
      }
    },
    "AdvanceSetting" : {
      "LogRate" : "1",
      "ConnectionTimeoutInSecond" : "5",
      "SuccessCode" : "429,304",
      "DomainBindingList" : [ {
        "Domain" : "www.xxx.com",
        "Ips" : "[1.1.1.1]"
      } ]
    }
  },
  "Code" : "200",
  "Success" : "true"
}

错误码

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