GetPtsSceneRunningData - Performance Testing - Alibaba Cloud Documentation Center

Retrieves the runtime data for a scenario during stress testing or debugging.

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:GetPtsSceneRunningData

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SceneId	string	Yes	The ID of the scenario.	NKKI6GB
PlanId	string	Yes	The ID of the task. You can obtain this ID from the response of the StartPtsScene operation.	NHBGVF8

Response parameters

Parameter	Type	Description	Example
	object
AgentLocation	array<object>	The location of the stress testing agents.
	object
Count	integer	The number of stress testing agents.	10
Isp	string	The provider.	阿里巴巴
Province	string	The province.	山东省
Region	string	The region.	华东地区
AliveAgents	integer	The number of healthy DPI engines.	10
AverageRt	integer	The average response time (RT).	45
BeginTime	integer	The start time of the stress test. This is a UNIX timestamp in milliseconds.	1651895518339
ChainMonitorDataList	array<object>	The stress testing information for the API.
	object
ApiId	string	The ID of the API.	ANBDC8B
ApiName	string	The name of the API.	第一个API
AverageRt	integer	The average RT.	46
CheckPointResult	object	The checkpoint result.
FailedBusinessCount	integer	The number of failed business transactions.	1000
FailedBusinessQps	number	The number of failed business records per second (RPS).	78
SucceedBusinessCount	integer	The number of successful business transactions.	908
SucceedBusinessQps	number	The number of successful business RPS.	89
Concurrency	number	The number of concurrent requests.	100
ConfigQps	integer	The configured RPS.	78
Count2XX	integer	The number of successful requests (HTTP 2xx).	7890
FailedCount	integer	The total number of failed requests.	456
FailedQps	number	The RPS of failed requests.	15
MaxRt	integer	The maximum RT.	56
MinRt	integer	The minimum RT.	16
NodeId	integer	The ID of the API.	78509
Qps2XX	number	The RPS of successful requests.	78
RealQps	number	The actual RPS.	23
TimePoint	integer	The time point of the data record. This is a UNIX timestamp.	1278908899
Code	string	The system status code. This parameter is not returned if the request is successful.	4001
Concurrency	integer	The number of concurrent requests.	10
ConcurrencyLimit	integer	The concurrency limit.	20
FailedBusinessCount	integer	The number of failed business transactions.	78
FailedRequestCount	integer	The number of failed requests.	90
HasReport	boolean	Indicates whether a report is generated.	false
HttpStatusCode	integer	The HTTP status code. This parameter is not returned if the request is successful.	400
Message	string	The error message. This parameter is not returned if the request is successful.	no message
RequestBps	string	The size of the request body.	89kb
RequestId	string	The request ID.	DC4E3177-6745-4925-B423-4E89VV34221A
ResponseBps	string	The size of the response body.	8kb
Seg90Rt	integer	The 90th percentile RT.	45
Status	integer	The status of the scenario. The default value is 7.	6
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
TotalAgents	integer	The total number of agents.	10
TotalRealQps	integer	The total queries per second (QPS).	10
TotalRequestCount	integer	The total number of requests.	8900
TpsLimit	integer	The configured Transaction Per Second (TPS) limit.	80
Vum	integer	The number of VUMs consumed.	100

Examples

Success response

JSON format

{
  "AgentLocation": [
    {
      "Count": 10,
      "Isp": "阿里巴巴",
      "Province": "山东省",
      "Region": "华东地区"
    }
  ],
  "AliveAgents": 10,
  "AverageRt": 45,
  "BeginTime": 1651895518339,
  "ChainMonitorDataList": [
    {
      "ApiId": "ANBDC8B",
      "ApiName": "第一个API",
      "AverageRt": 46,
      "CheckPointResult": {
        "FailedBusinessCount": 1000,
        "FailedBusinessQps": 78,
        "SucceedBusinessCount": 908,
        "SucceedBusinessQps": 89
      },
      "Concurrency": 100,
      "ConfigQps": 78,
      "Count2XX": 7890,
      "FailedCount": 456,
      "FailedQps": 15,
      "MaxRt": 56,
      "MinRt": 16,
      "NodeId": 78509,
      "Qps2XX": 78,
      "RealQps": 23,
      "TimePoint": 1278908899
    }
  ],
  "Code": "4001",
  "Concurrency": 10,
  "ConcurrencyLimit": 20,
  "FailedBusinessCount": 78,
  "FailedRequestCount": 90,
  "HasReport": false,
  "HttpStatusCode": 400,
  "Message": "no message",
  "RequestBps": "89kb",
  "RequestId": "DC4E3177-6745-4925-B423-4E89VV34221A",
  "ResponseBps": "8kb",
  "Seg90Rt": 45,
  "Status": 6,
  "Success": true,
  "TotalAgents": 10,
  "TotalRealQps": 10,
  "TotalRequestCount": 8900,
  "TpsLimit": 80,
  "Vum": 100
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.