云压测
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云压测 > API 文档 > PTS相关接口 > 查询场景列表

查询场景列表

最近更新时间：2024-03-12 01:44:48

我的收藏

本页目录：

1. 接口描述

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

查询场景列表

默认接口请求频率限制：20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeScenarios。
Version 是 String 公共参数，本接口取值：2021-07-28。
Region 否 String 公共参数，本接口不需要传递此参数。
ScenarioIds.N 否 Array of String 场景ID数组
示例值：["scenario-xx"]
ScenarioName 否 String 场景名
示例值：test
ScenarioStatus.N 否 Array of Integer 场景状态数组
示例值：[1,2]
Offset 否 Integer 偏移量，默认为0
示例值：1
Limit 否 Integer 返回数量，默认为20，最大为100
示例值：10
OrderBy 否 String 排序的列
示例值：status
Ascend 否 Boolean 是否正序
示例值：true
ProjectIds.N 否 Array of String 项目ID数组
示例值：["project-xx"]
ScenarioType 否 String 场景类型
示例值：pts-js

3. 输出参数

参数名称 类型 描述
ScenarioSet Array of Scenario 场景列表
注意：此字段可能返回 null，表示取不到有效值。
Total Integer 场景总数
示例值：3
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询场景列表

输入示例

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

{
    "ScenarioIds": [
        "scenario-xx"
    ]
}

输出示例

{
    "Response": {
        "Total": 0,
        "ScenarioSet": [
            {
                "Status": 0,
                "Load": {
                    "VpcLoadDistribution": {
                        "VpcId": "xx",
                        "Region": "xx",
                        "RegionId": 0
                    },
                    "GeoRegionsLoadDistribution": [
                        {
                            "Region": "xx",
                            "RegionId": 0,
                            "Percentage": 0
                        }
                    ],
                    "LoadSpec": {
                        "RequestsPerSecond": {
                            "DurationSeconds": 0
                        },
                        "Concurrency": {
                            "Stages": [
                                {
                                    "DurationSeconds": 0,
                                    "TargetVirtualUsers": 0
                                }
                            ],
                            "IterationCount": 0
                        }
                    }
                },
                "Datasets": [
                    {
                        "HeaderInFile": true,
                        "Name": "xx",
                        "LineCount": 0,
                        "Split": true,
                        "UpdatedAt": "2020-09-22T00:00:00+00:00",
                        "HeaderColumns": [
                            "xx"
                        ],
                        "Size": 0
                    }
                ],
                "Description": "xx",
                "SubAccountUin": "xx",
                "Uin": "xx",
                "Extensions": [
                    "xx"
                ],
                "CreatedAt": "xx",
                "AppId": 0,
                "UpdatedAt": "xx",
                "Configs": [
                    "xx"
                ],
                "Type": "xx",
                "Name": "xx"
            }
        ],
        "RequestId": "xx"
    }
}

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 数据库查询失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
中国站