# Alibaba Cloud Performance Testing API

> Alibaba Cloud Performance Testing API on Apizie: 45 endpoints (Adjusting the JMeter load size, Adjusts the load of a PTS scenario, Creates a stress testing scenario, Sets a report as the baseline for a scenario, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-pts/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-pts`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/pts
- Page: https://zieapi.vercel.app/api/cloud/aliyun-pts
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-pts/openapi.json

Alibaba Cloud OpenAPI for Performance Testing (pts, version 2020-10-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adjusting the JMeter load size
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/adjust-jmeter-scene-speed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| ReportId | string | yes | The report ID |
| Speed | integer | yes | The target load value |

### Adjusts the load of a PTS scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/adjust-pts-scene-speed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID |
| ApiSpeedList | string | no | The speed adjustment configuration (JSON-encoded) |

### Creates a stress testing scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/create-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| Scene | string | yes | The information about the scenario |

### Sets a report as the baseline for a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/create-pts-scene-base-line-from-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID. For more information, see https://help.aliyun.com/document_detail/201321.html |
| ReportId | string | yes | The report ID. For more information, see https://help.aliyun.com/document_detail/201321.html |

### This operation deletes a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/delete-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The unique ID of the scenario. The system generates this ID after the scenario is created |

### Deletes a scenario baseline
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/delete-pts-scene-base-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID. For more information, see https://help.aliyun.com/document_detail/201321.html |

### Deletes multiple scenarios in a batch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/delete-pts-scenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneIds | string | yes | A list of IDs of the scenarios to delete (JSON-encoded) |

### Retrieves all regions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-all-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |

### Retrieves the run logs for a JMeter test. By default, this operation queries the logs from machine 0 and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-jmeter-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The number of the page to return |
| PageSize | integer | yes | The number of entries to return on each page |
| ReportId | string | yes | The report ID |
| BeginTime | integer | no | The start time. This value is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time. This value is a UNIX timestamp in milliseconds |
| AgentIndex | integer | no | If you specify an invalid index, the logs of engine 0 are returned |
| Level | string | no | The log level. Valid values: ERROR WARN INFO: The default value. DEBUG TRACE |
| Thread | string | no | The thread name |
| Keyword | string | no | The keyword to search for in the logs |

### Obtains the details of a JMeter report
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-jmeter-report-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| ReportId | string | yes | The report ID |

### Retrieves the aggregate data for JMeter samplers based on specified conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-jmeter-sample-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| ReportId | string | yes | The report ID |
| BeginTime | integer | no | The start time |
| EndTime | integer | no | The end time |
| SamplerId | integer | no | The sampler index. The index starts from 0. If you set this parameter to -1, data for the entire scenario is returned |

### Retrieves the sampling logs for a JMeter sampler based on specified conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-jmeter-sampling-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The number of the page to return |
| PageSize | integer | yes | The number of sampling log entries to return on each page |
| BeginTime | integer | no | The start time. This is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time. This is a UNIX timestamp in milliseconds |
| ReportId | string | yes | The report ID |
| AgentId | integer | no | The ID of the stress testing engine. This parameter is not yet available |
| SamplerId | integer | no | The serial number of the sampler. The value starts from 0 |
| Success | string | no | Indicates whether the sampling is successful |
| Thread | string | no | The thread name. Fuzzy search is supported. The value is tokenized by spaces |
| Keyword | string | no | The keyword. Use this parameter to perform a fuzzy search by SceneName or an exact search by SceneId |
| MinRT | integer | no | The minimum response time (RT). Unit: ms |
| MaxRT | integer | no | The maximum response time (RT). Unit: ms |
| ResponseCode | string | no | The response code |

### Retrieves the data generated during a JMeter stress test based on the scenario ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-jmeter-scene-running-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID |

### Retrieves the details of a JMeter scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-open-jmeter-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID |

### Queries the sampling logs of a debug task in a PTS scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-pts-debug-sample-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PlanId | string | no | The ID of the debug task |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of records to display on each page |

### Retrieves the details of a report for a scenario stress test
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-pts-report-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario. This is a unique identifier that the system generates after you create the scenario |
| PlanId | string | yes | The ID of the task that is generated each time you start the scenario |

### Performs a batch query for all reports that are associated with a specific stress testing scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-pts-reports-by-scene-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID |
| PageNumber | integer | yes | The number of the page to return |
| PageSize | integer | yes | The number of reports to return on each page. Valid values: 5 to 100 |

### Queries the structure, stress testing configuration, and other information for a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID |

### Queries the baseline data for a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-pts-scene-base-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID. For more information, see https://help.aliyun.com/document_detail/201321.html |

### Retrieves the runtime data for a scenario during stress testing or debugging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-pts-scene-running-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario |
| PlanId | string | yes | The ID of the task. You can obtain this ID from the response of the StartPtsScene operation |

### Retrieves the runtime status of a scenario after a stress test starts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-pts-scene-running-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario. This is a unique identifier that the system generates after the scenario is created |

### GetUserVpcSecurityGroup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-user-vpc-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries to return on each page |
| RegionId | string | yes | The region ID |
| VpcId | string | yes | The virtual private cloud (VPC) ID |

### GetUserVpcVSwitch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-user-vpc-vswitch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The page number for a paged query |
| PageSize | integer | yes | The number of records to display on each page |
| RegionId | string | yes | The region ID |
| VpcId | string | yes | The virtual private cloud (VPC) ID |

### GetUserVpcs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/get-user-vpcs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The page number for a paged query |
| PageSize | integer | yes | The number of entries to display on each page |
| RegionId | string | yes | The region ID |
| VpcId | string | no | The virtual private cloud (VPC) ID |

### Lists JMeter environments based on specified conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/list-envs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The number of the page to return |
| PageSize | integer | yes | The number of environments to return on each page |
| EnvId | string | no | The ID of the environment to query. This is a term query |
| EnvName | string | no | The keyword in the name of the environment to query. This is a fuzzy query |

### Queries JMeter reports based on specified conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/list-jmeter-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The number of the report page to return |
| PageSize | integer | yes | The number of reports to return |
| SceneId | string | no | The ID of the scenario whose report you want to view |
| ReportId | string | no | The report ID |
| BeginTime | integer | no | The beginning of the time range to query. Unit: ms |
| EndTime | integer | no | The end of the time range to query |
| Keyword | string | no | The report keyword |

### Retrieves a list of JMeter scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/list-open-jmeter-scenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The number of the page to return |
| PageSize | integer | yes | The number of scenarios to return on each page |
| SceneId | string | no | The scenario ID |
| SceneName | string | no | The scenario name |

### Lists PTS report summaries that match the specified criteria
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/list-pts-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The page number. The value starts from 1 |
| PageSize | integer | yes | The number of reports to return on each page |
| SceneId | string | no | The ID of the scenario |
| ReportId | string | no | The report ID |
| BeginTime | integer | no | The start timestamp of the report, in milliseconds |
| EndTime | integer | no | The end timestamp of the report, in milliseconds |
| Keyword | string | no | The report keyword |

### Queries a paginated list of scenario overviews
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/list-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| PageNumber | integer | yes | The page number. The value can be from 1 to 1,073,741,824 |
| PageSize | integer | yes | The number of scenarios to display on each page. The value can be from 10 to 1,000 |
| KeyWord | string | no | The keyword. Use it to perform a fuzzy search by SceneName or an exact search by SceneId |

### Modifies the configuration of a scenario, such as the URL and stress test settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/modify-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| Scene | string | yes | The detailed information about the scenario |

### Removes a JMeter environment using the specified environment ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/remove-env` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| EnvId | string | yes | The ID of the environment to delete |

### Removes a JMeter scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/remove-open-jmeter-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario to delete |

### Creates or updates a JMeter environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/save-env` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| Env | string | yes | The environment (JSON-encoded) |

### Creates or updates a JMeter scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/save-open-jmeter-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| OpenJMeterScene | string | yes | The details of the scenario (JSON-encoded) |

### Saves a new scenario or updates an existing one
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/save-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| Scene | string | yes | The details of the scenario (JSON-encoded) |

### Starts a debug session for a scenario to test its configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/start-debug-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID |

### Starts debugging a JMeter scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/start-debugging-jmeter-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario to debug |

### Starts a scenario based on a specified scenario ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/start-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario to start. This ID is returned when you create a scenario and is also displayed on the scenario list page |

### Starts a stress test for a JMeter scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/start-testing-jmeter-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario to stress test |

### Stops a scenario that is being debugged
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/stop-debug-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID |
| PlanId | string | yes | The task ID |

### Stops debugging a JMeter scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/stop-debugging-jmeter-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario to stop debugging |

### Stops a PTS scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/stop-pts-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the scenario to stop. This ID is returned after you create a scenario. You can also find the ID on the Scenarios page in the PTS… |

### Stops a stress test for a JMeter scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/stop-testing-jmeter-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The ID of the stress testing scenario to stop |

### Updates the baseline data for a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/update-pts-scene-base-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |
| SceneId | string | yes | The scenario ID. For more information, see https://help.aliyun.com/document_detail/201321.html |
| SceneBaseline | string | no | The baseline data of the scenario. You can pass the toJSONString of the SceneBaseline class from the amazon-pts-api package as the value… |
| ApiBaselines | string | no | The baseline data of the API. You can pass the toJSONString of the list of ApiBaseLine objects from the amazon-pts-api package as the… |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pts.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-pts/adjust-jmeter-scene-speed" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Performance Testing API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-pts/adjust-jmeter-scene-speed with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Performance Testing API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Performance Testing itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Performance Testing API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-pts.

### What is the status of the Alibaba Cloud Performance Testing API?
Needs your own provider key (bring your own key)