1. 接口描述
接口请求域名： pts.tencentcloudapi.com 。
创建场景
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateScenario。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-28。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Name | 是 | String | 场景名 示例值：test |
| Type | 是 | String | 压测引擎类型 示例值：pts-http, pts-js,pts-jmeter,pts-trpc |
| ProjectId | 是 | String | 项目ID 示例值：project-xx |
| Description | 否 | String | 场景描述 示例值：this is a test scenario |
| Load | 否 | Load | 施压配置 |
| Configs.N | 否 | Array of String | deprecated 示例值：["a.prop","b.prop"] |
| Datasets.N | 否 | Array of TestData | 测试数据集 |
| Extensions.N | 否 | Array of String | deprecated 示例值：["a.jar","b.jar"] |
| SLAId | 否 | String | deprecated 示例值：sla-xx |
| CronId | 否 | String | cron job ID 示例值：cron-xx |
| Scripts.N | 否 | Array of String | deprecated 示例值：["a.js"] |
| TestScripts.N | 否 | Array of ScriptInfo | 测试脚本文件信息 |
| Protocols.N | 否 | Array of ProtocolInfo | 协议文件路径 |
| RequestFiles.N | 否 | Array of FileInfo | 请求文件路径 |
| SLAPolicy | 否 | SLAPolicy | SLA 策略 |
| Plugins.N | 否 | Array of FileInfo | 拓展包文件路径 |
| DomainNameConfig | 否 | DomainNameConfig | 域名解析配置 |
| Owner | 否 | String | 创建人名 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ScenarioId | String | 场景ID 示例值：scenario-xx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建场景
创建场景
输入示例
POST / HTTP/1.1
Host: pts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateScenario
<公共请求参数>
{
"Load": {
"VpcLoadDistribution": {
"VpcId": "abc",
"Region": "ap-guangzhou",
"RegionId": 1
},
"GeoRegionsLoadDistribution": [
{
"Region": "ap-guangzhou",
"RegionId": 1,
"Percentage": 30
},
{
"Region": "ap-shanghai",
"RegionId": 5,
"Percentage": 70
}
],
"LoadSpec": {
"Concurrency": {
"MaxRequestsPerSecond": 1000,
"Stages": [
{
"DurationSeconds": 60,
"TargetVirtualUsers": 1000
}
],
"IterationCount": 5
}
}
},
"Datasets": [
{
"HeaderInFile": true,
"Name": "data.csv",
"LineCount": 300,
"Split": true,
"UpdatedAt": "2020-09-22T00:00:00+00:00",
"HeaderColumns": [
"a1"
],
"Size": 3000
}
],
"Name": "scenario-a",
"ProjectId": "project-a",
"Scripts": [
"b.js"
],
"Configs": [
"c.prop"
],
"Type": "pts-js",
"Description": "Description"
}输出示例
{
"Response": {
"RequestId": "31446d02-c4f3-4a53-9efe-b5ad18cfcb7f",
"ScenarioId": "scenario-a"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.ResourceNotFound | 资源不存在。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
