调用GetPtsScene查询场景_性能测试 PTS-阿里云帮助中心

查询场景的结构、施压等信息。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
SceneId	string	是	场景ID。更多信息，请参见OpenAPI创建接口参数说明。	NKJBSH

返回参数

名称	类型	描述	示例值
	object
Message	string	错误提示信息，若成功则为空。	空
RequestId	string	请求ID。	DC4E3177-6745-4925-B423-4E89VV34221A
HttpStatusCode	integer	HTTP状态码。	200
Scene	object	场景结构。
Status	string	场景状态。	Running
LoadConfig	object	施压配置信息。
ApiLoadConfigList	array	API施压配置信息。
	object
RpsBegin	integer	起始RPS。	10
RpsLimit	integer	最大RPS。	20
ApiId	string	API ID。可以根据此ID在Relation中找到对应的API信息。	GBFDCV8
MaxRunningTime	integer	运行时长，单位分钟。	2
RelationLoadConfigList	array	链路施压配置信息。
	object
ConcurrencyBegin	integer	起始并发。	10
ConcurrencyLimit	integer	最大并发。	20
RelationId	string	链路ID。	HNBGS7M
Configuration	object	全场景并发或RPS配置信息。
AllRpsBegin	integer	起始RPS。	100
AllConcurrencyBegin	integer	起始并发。	100
AllConcurrencyLimit	integer	最大并发。	200
AllRpsLimit	integer	最大RPS。	200
AgentCount	integer	施压机器。	1
TestMode	string	施压模式。TPS表示施压模式为RPS模式。说明该返回结果为CONCURRENCY/TPS。	TPS
AutoStep	boolean	是否为自动递增模式。	false
Increment	integer	递增百分比，取值范围[10,100]，且是整十倍。只有在并发模式且是自动递增模式下有效，即 testMode=concurrency_mode 且 autoStep=true 时。	10
KeepTime	integer	单量级持续时长，单位分钟，一定是小于施压时长 maxRunningTime。	2
VpcLoadConfig	object	VPC配置，VPC压测模式下生效。
VpcId	string	专有网络ID。	vpc-akjhsdajgjsfggahjkga
VSwitchId	string	虚拟交换机ID。	vsw-skjfhlahsljkhsfalkjdoiw
SecurityGroupId	string	安全组 ID。	sg-jkasgfieiajidsjakjscb
RegionId	string	地域ID。	cn-beijing
FileParameterList	array	文件参数。
	object
FileOssAddress	string	您自己的OSS文件地址，要求公网可访问。	https://test.oss-cn-shanghai.aliyuncs.com/json.jar
FileName	string	文件名。	city.csv
ModifiedTime	string	最新修改时间。	2021-03-26 15:30:30
AdvanceSetting	object	高级设置。
LogRate	integer	日志采样率。	1
DomainBindingList	array	域名和IP绑定关系。
	object
Domain	string	域名。	www.aliyundoc.com
Ips	array	绑定IP。
	string	绑定IP。	[1.1.1.1]
ConnectionTimeoutInSecond	integer	场景超时时间，单位s。	5
SuccessCode	string	自定义成功状态码。	429,304
CreateTime	string	创建时间。	2021-02-26 15:30:30
RelationList	array	链路信息。
	object
RelationName	string	链路名。	下单链路
FileParameterExplainList	array	文件参数说明。
	object
CycleOnce	boolean	是否循环一次。	true
FileParamName	string	文件中的参数名。	userName,age
FileName	string	文件名。	city.csv
BaseFile	boolean	是否作为基准列。	true
ApiList	array	API信息。
	object
ApiId	string	API ID。可以根据此ID在Relation中找到对应的API信息。	GBFDCV8
CheckPointList	array	所有检查点。
	object
CheckType	string	检查类型。	EXPORTED_PARAM
Operator	string	比较符号。	ctn
ExpectValue	string	期望值。	111
CheckPoint	string	检查点。	userId
HeaderList	array	Header信息。
	object
HeaderValue	string	参数值。	1111
HeaderName	string	参数名。	userId
TimeoutInSecond	integer	超时时间，单位秒。	5
ExportList	array	所有导出参数。
	object
ExportType	string	导出参数来源。	BODY_JSON
ExportValue	string	解释表达式。	username
ExportName	string	导出参数名。	data.username
Count	string	导出参数匹配项。	0
Url	string	请求URL。	https://www.aliyundoc.com
Method	string	请求方法。	GET
Body	object	Body内容。
BodyValue	string	Body值。	{\"key1\":\"111\",\"key2\":\"222\"}
ContentType	string	Body类型。	application/x-www-form-urlencoded
RedirectCountLimit	integer	重定向次数。	5
ApiName	string	API名称。	下单
RelationId	string	链路ID。	HNBGS7M
SceneName	string	场景名。	下单场景
SceneId	string	场景ID。	BGFJ7GV
GlobalParameterList	array	全局参数。
	object
ParamName	string	参数名。	userName
ParamValue	string	参数值。	lisi
Headers	array	场景所设置的全局Header
	object
Name	string	Header的名称	key1
Value	string	Header的值	value1
Code	string	系统状态码。	200
Success	boolean	是否成功。 `true`：成功 `false`：失败	true

示例

正常返回示例

JSON格式

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

示例

正常返回示例

JSON格式

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

XML格式

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

错误码

HTTP status code	错误码	错误信息
400	GetPtsSceneFail	The scene does not exit

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

变更历史

变更时间

变更内容概要

操作

2023-03-27

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400
出参	OpenAPI 返回结构发生变更

2021-12-27

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400
出参	OpenAPI 返回结构发生变更