帮你快速理解、总结文档立即下载

更新场景

最近更新时间:2026-06-01 02:34:21
我的收藏

1. 接口描述

接口请求域名: pts.tencentcloudapi.com 。

更新场景

默认接口请求频率限制:200次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:UpdateScenario。
Version 是 String 公共参数,本接口取值:2021-07-28。
Region 否 String 公共参数,本接口不需要传递此参数。
ScenarioId 是 String 场景ID
示例值:scenario-1a2b3c4d
Name 否 String 场景名;调用该接口时,请将 Scenario 中不需要修改的字段保持原样也作为接口的入参,否则场景可能会不可用。
示例值:scenario name
Description 否 String 场景描述
示例值:this is a test scenario
Type 否 String 压测场景的模式类型。取值范围:pts-http 代表简单模式,pts-js 代表脚本模式,pts-jmeter 代表 JMeter 模式。
示例值:pts-http
Load 否 Load 施压配置
EncodedScripts 否 String deprecated
示例值:WyJhYmMiLCAiZGVmIl0K
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 SLA规则ID
示例值:sla-1a2b3c4d
CronId 否 String cron job ID
示例值:cron-1a2b3c4d
Status 否 Integer 场景状态(注:现已无需传递该参数)
示例值:2
ProjectId 否 String 项目ID
示例值:project-1a2b3c4d
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 域名解析配置
NotificationHooks.N 否 Array of Notification WebHook请求配置
Owner 否 String 创建人名
示例值:owner-name
EnvId 否 String 环境ID
示例值:env-1a2b3c4d

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新场景

更新场景

输入示例

POST / HTTP/1.1
Host: pts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateScenario
<公共请求参数>

{
    "ScenarioId": "scenario-1a2b3c4d",
    "Name": "pts-js(2023-05-12 16:12:30)",
    "Description": "",
    "Type": "pts-js",
    "Load": {
        "LoadSpec": {
            "Concurrency": {
                "IterationCount": 0,
                "MaxRequestsPerSecond": 0,
                "Stages": [
                    {
                        "DurationSeconds": 120,
                        "TargetVirtualUsers": 2
                    },
                    {
                        "DurationSeconds": 120,
                        "TargetVirtualUsers": 4
                    },
                    {
                        "DurationSeconds": 120,
                        "TargetVirtualUsers": 5
                    },
                    {
                        "DurationSeconds": 240,
                        "TargetVirtualUsers": 5
                    }
                ],
                "Resources": 1
            }
        },
        "GeoRegionsLoadDistribution": [
            {
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "Percentage": 100
            }
        ]
    },
    "Status": 2,
    "ProjectId": "project-abc",
    "TestScripts": [
        {
            "Type": "js",
            "Name": "script.js",
            "Size": 896,
            "EncodedContent": "Ly8gU2VuZCBhIGh0dHAgZ2V0IHJlcXVlc3QKaW1wb3J0IGh0dHAgZnJvbSAncHRzL2h0dHAnOwppbXBvcnQgeyBjaGVjaywgc2xlZXAgfSBmcm9tICdwdHMnOwoKZXhwb3J0IGRlZmF1bHQgZnVuY3Rpb24gKCkgewogIC8vIHNpbXBsZSBnZXQgcmVxdWVzdAogIGNvbnN0IHJlc3AxID0gaHR0cC5nZXQoJ2h0dHA6Ly9tb2NraHR0cGJpbi5wdHMuc3ZjLmNsdXN0ZXIubG9jYWwvZ2V0Jyk7CiAgY29uc29sZS5sb2cocmVzcDEuYm9keSk7CiAgLy8gaWYgcmVzcDEuYm9keSBpcyBhIGpzb24gc3RyaW5nLCByZXNwMS5qc29uKCkgdHJhbnNmZXIganNvbiBmb3JtYXQgYm9keSB0byBhIGpzb24gb2JqZWN0CiAgY29uc29sZS5sb2cocmVzcDEuanNvbigpKTsKICBjaGVjaygnc3RhdHVzIGlzIDIwMCcsICgpID0+IHJlc3AxLnN0YXR1c0NvZGUgPT09IDIwMCwgcmVzcDEpOwoKICAvLyBzbGVlcCAxIHNlY29uZAogIHNsZWVwKDEpOwoKICAvLyBnZXQgcmVxdWVzdCB3aXRoIGhlYWRlcnMgYW5kIHBhcmFtZXRlcnMKICBjb25zdCByZXNwMiA9IGh0dHAuZ2V0KCdodHRwOi8vbW9ja2h0dHBiaW4ucHRzLnN2Yy5jbHVzdGVyLmxvY2FsL2dldCcsIHsKICAgIGhlYWRlcnM6IHsKICAgICAgQ29ubmVjdGlvbjogJ2tlZXAtYWxpdmUnLAogICAgICAnVXNlci1BZ2VudCc6ICdwdHMtZW5naW5lJywKICAgIH0sCiAgICBxdWVyeTogewogICAgICBuYW1lMTogJ3ZhbHVlMScsCiAgICAgIG5hbWUyOiAndmFsdWUyJywKICAgIH0sCiAgfSk7CgogIGNvbnNvbGUubG9nKHJlc3AyLmpzb24oKS5hcmdzLm5hbWUxKTsgLy8gJ3ZhbHVlMScKICBjaGVjaygnYm9keS5hcmdzLm5hbWUxIGVxdWFscyB2YWx1ZTEnLCAoKSA9PiByZXNwMi5qc29uKCkuYXJncy5uYW1lMSA9PT0gJ3ZhbHVlMScsIHJlc3AyKTsKfQo=",
            "LoadWeight": 100,
            "UpdatedAt": "2023-05-12T16:12:31+08:00",
            "EncodedHttpArchive": ""
        }
    ],
    "SLAPolicy": {
        "SLARules": [],
        "AlertChannel": {}
    },
    "DomainNameConfig": {},
    "Owner": "owner"
}

输出示例

{
    "Response": {
        "RequestId": "31446d02-c4f3-4a53-9efe-b5ad18cfcb7f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.DbQueryFailed 数据库查询失败。
FailedOperation.DbRecordCreateFailed 数据库创建记录失败。
FailedOperation.DbRecordUpdateFailed 数据库记录更新失败。
FailedOperation.ResourceNotFound 资源不存在。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。