GetPtsScene - Performance Testing - Alibaba Cloud Documentation Center

Queries the structure, stress testing configuration, and other information for a scenario.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pts:GetPtsScene

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SceneId	string	Yes	The scenario ID.	NKJBSH

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The system status code.	200
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message. This parameter is empty if the request is successful.	空
RequestId	string	The request ID.	DC4E3177-6745-4925-B423-4E89VV34221A
Scene	object	The structure of the scenario.
AdvanceSetting	object	The advanced settings.
ConnectionTimeoutInSecond	integer	The timeout period of the scenario. Unit: seconds.	5
DomainBindingList	array<object>	The mappings between domain names and IP addresses.
	object
Domain	string	The domain name.	www.aliyundoc.com
Ips	array	The bound IP addresses.
	string	A bound IP address.	[1.1.1.1]
LogRate	integer	The log sampling rate.	1
SuccessCode	string	The custom success status codes.	429,304
CreateTime	string	The time when the scenario was created.	2021-02-26 15:30:30
FileParameterList	array<object>	The file parameters.
	object
FileName	string	The name of the file.	city.csv
FileOssAddress	string	The URL of your Object Storage Service (OSS) file. The file must be accessible over the Internet.	https://test.oss-cn-shanghai.aliyuncs.com/json.jar
GlobalParameterList	array<object>	The global parameters.
	object
ParamName	string	The parameter name.	userName
ParamValue	string	The parameter value.	lisi
Headers	array<object>	The global headers that are set for the scenario.
	object
Name	string	The name of the header.	key1
Value	string	The value of the header.	value1
LoadConfig	object	The stress testing configuration.
AgentCount	integer	The number of stress testing agents.	1
ApiLoadConfigList	array<object>	The stress testing configurations for APIs.
	object
ApiId	string	The API ID. You can use this ID to find the corresponding API information in Relation.	GBFDCV8
RpsBegin	integer	The initial records per second (RPS).	10
RpsLimit	integer	The maximum RPS.	20
AutoStep	boolean	Indicates whether the auto-increment mode is enabled.	false
Configuration	object	The configuration of concurrent requests or RPS for the entire scenario.
AllConcurrencyBegin	integer	The initial number of concurrent requests.	100
AllConcurrencyLimit	integer	The maximum number of concurrent requests.	200
AllRpsBegin	integer	The initial RPS.	100
AllRpsLimit	integer	The maximum RPS.	200
Increment	integer	The increment percentage. Valid values: 10 to 100. The value must be a multiple of 10. This parameter is valid only when testMode is set to concurrency_mode and autoStep is set to true.	10
KeepTime	integer	The duration of a single stress level. Unit: minutes. The value must be smaller than the value of maxRunningTime.	2
MaxRunningTime	integer	The runtime duration. Unit: minutes.	2
RelationLoadConfigList	array<object>	The stress testing configurations for transaction links.
	object
ConcurrencyBegin	integer	The initial number of concurrent requests.	10
ConcurrencyLimit	integer	The maximum number of concurrent requests.	20
RelationId	string	The link ID.	HNBGS7M
TestMode	string	The stress testing mode. TPS indicates the RPS mode. Note The returned value is CONCURRENCY or TPS.	TPS
VpcLoadConfig	object	The virtual private cloud (VPC) configuration. This parameter is valid only in VPC stress testing mode.
RegionId	string	The region ID.	cn-beijing
SecurityGroupId	string	The security group ID.	sg-jkasgfieiajidsjakjscb
VSwitchId	string	The virtual switch ID.	vsw-skjfhlahsljkhsfalkjdoiw
VpcId	string	The VPC ID.	vpc-akjhsdajgjsfggahjkga
ModifiedTime	string	The time when the scenario was last modified.	2021-03-26 15:30:30
RelationList	array<object>	The information about the transaction links.
	object
ApiList	array<object>	The API information.
	object
ApiId	string	The API ID. You can use this ID to find the corresponding API information in Relation.	GBFDCV8
ApiName	string	The API name.	下单
Body	object	The content of the body.
BodyValue	string	The value of the body.	{\"key1\":\"111\",\"key2\":\"222\"}
ContentType	string	The type of the body.	application/x-www-form-urlencoded
CheckPointList	array<object>	All checkpoints.
	object
CheckPoint	string	The checkpoint.	userId
CheckType	string	The check type.	EXPORTED_PARAM
ExpectValue	string	The expected value.	111
Operator	string	The comparison operator.	ctn
ExportList	array<object>	All exported parameters.
	object
Count	string	The number of matched items for the exported parameter.	0
ExportName	string	The name of the exported parameter.	data.username
ExportType	string	The source of the exported parameter.	BODY_JSON
ExportValue	string	The expression.	username
HeaderList	array<object>	The header information.
	object
HeaderName	string	The parameter name.	userId
HeaderValue	string	The parameter value.	1111
Method	string	The request method.	GET
RedirectCountLimit	integer	The number of redirections.	5
TimeoutInSecond	integer	The timeout period. Unit: seconds.	5
Url	string	The request URL.	https://www.aliyundoc.com
FileParameterExplainList	array<object>	The description of the file parameters.
	object
BaseFile	boolean	Indicates whether the file is used as the baseline.	true
CycleOnce	boolean	Indicates whether to loop once.	true
FileName	string	The file name.	city.csv
FileParamName	string	The parameter names in the file.	userName,age
RelationId	string	The link ID.	HNBGS7M
RelationName	string	The link name.	下单链路
SceneId	string	The scenario ID.	BGFJ7GV
SceneName	string	The scenario name.	下单场景
Status	string	The status of the scenario.	Running
Success	boolean	Indicates whether the request was successful. `true`: The request was successful. `false`: The request failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	GetPtsSceneFail	The scene does not exit

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.