文档中心>API 中心>云压测>PTS相关接口>查询场景及对应的任务

查询场景及对应的任务

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

我的收藏

1. 接口描述

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

查询场景配置并附带已经执行的任务内容

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeScenarioWithJobs。
Version String 公共参数,本接口取值:2021-07-28。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量,默认为0
示例值:1
Limit Integer 返回数量,默认为20,最大为100
示例值:10
ProjectIds.N Array of String 项目ID数组
示例值:["project-xx"]
ScenarioIds.N Array of String 场景ID数组
示例值:["scenario-xx"]
ScenarioName String 场景名
示例值:test
ScenarioStatus Integer 场景状态数组
示例值:[1,2]
OrderBy String 排序的列
示例值:status
Ascend Boolean 是否正序
示例值:true/false
ScenarioRelatedJobsParams ScenarioRelatedJobsParams job相关参数
IgnoreScript Boolean 是否需要返回场景的脚本内容
示例值:true
IgnoreDataset Boolean 是否需要返回测试数据文件信息
示例值:true
ScenarioType String 场景类型,如pts-http, pts-js, pts-trpc, pts-jmeter
示例值:pts-xx
Owner String 创建人员

3. 输出参数

参数名称 类型 描述
ScenarioWithJobsSet Array of ScenarioWithJobs 场景配置以及附带的job内容
注意:此字段可能返回 null,表示取不到有效值。
Total Integer 场景总数
示例值:3
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询场景及对应的job内容

查询场景及对应的job内容

输入示例

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

{
    "ScenarioIds": [
        "scenario-44dlxys2"
    ],
    "ScenarioRelatedJobsParams": {
        "OrderBy": "StartTime",
        "Limit": 10,
        "Ascend": true
    }
}

输出示例

{
    "Response": {
        "RequestId": "xx",
        "ScenarioWithJobsSet": [
            {
                "Scenario": {
                    "AppId": 251201585,
                    "Uin": "700000153395",
                    "SubAccountUin": "700000153395",
                    "CreatedAt": "2021-09-27T10:46:26+08:00",
                    "UpdatedAt": "2021-09-27T10:46:26+08:00",
                    "ScenarioId": "scenario-44dlxys2",
                    "Name": "hello",
                    "Type": "pts-js",
                    "Load": {
                        "LoadSpec": {
                            "Concurrency": {
                                "Stages": [
                                    {
                                        "DurationSeconds": 60,
                                        "TargetVirtualUsers": 10
                                    }
                                ],
                                "IterationCount": 5,
                                "MaxRequestsPerSecond": 1000
                            }
                        },
                        "VpcLoadDistribution": {
                            "Region": "ap-guangzhou",
                            "RegionId": 1,
                            "VpcId": "1",
                            "SubnetIds": null
                        },
                        "GeoRegionsLoadDistribution": [
                            {
                                "Region": "1",
                                "RegionId": 1,
                                "Percentage": 1
                            }
                        ]
                    },
                    "EncodedScripts": "",
                    "Description": "this is a test",
                    "Status": 2,
                    "Configs": [
                        "a.prop"
                    ],
                    "Datasets": [
                        {
                            "Name": "a.csv",
                            "UpdatedAt": null,
                            "Size": 0,
                            "LineCount": 5,
                            "HeaderInFile": true,
                            "Split": true,
                            "HeaderColumns": null
                        }
                    ],
                    "Extensions": [
                        "a.jar"
                    ],
                    "ProjectId": "1",
                    "SLAId": "",
                    "CronId": ""
                },
                "Jobs": [
                    {
                        "ErrorRate": 0,
                        "RequestTotal": 0,
                        "ResponseTimeAverage": 0,
                        "ResponseTimeP99": 0,
                        "ResponseTimeP95": 0,
                        "ResponseTimeP90": 0,
                        "JobId": "job-j4j0t76k",
                        "ScenarioId": "scenario-44dlxys2",
                        "Type": "pts-js",
                        "Load": {
                            "LoadSpec": {
                                "Concurrency": {
                                    "Stages": [
                                        {
                                            "DurationSeconds": 60,
                                            "TargetVirtualUsers": 10
                                        }
                                    ],
                                    "IterationCount": 5,
                                    "MaxRequestsPerSecond": 1000
                                }
                            },
                            "VpcLoadDistribution": {
                                "Region": "ap-guangzhou",
                                "RegionId": 1,
                                "VpcId": "1",
                                "SubnetIds": null
                            },
                            "GeoRegionsLoadDistribution": [
                                {
                                    "Region": "1",
                                    "RegionId": 1,
                                    "Percentage": 1
                                }
                            ]
                        },
                        "Scripts": [
                            "a.js"
                        ],
                        "Configs": [
                            "a.prop"
                        ],
                        "Datasets": [
                            {
                                "Name": "a.csv",
                                "UpdatedAt": null,
                                "Size": 0,
                                "LineCount": 5,
                                "HeaderInFile": true,
                                "Split": true,
                                "HeaderColumns": null
                            }
                        ],
                        "Extensions": [
                            "a.jar"
                        ],
                        "StartTime": "2021-09-27T13:50:52+08:00",
                        "EndTime": "2021-09-28T14:00:52+08:00",
                        "Note": "",
                        "JobOwner": "lucas",
                        "Status": 5,
                        "Duration": 60,
                        "MaxVirtualUserCount": 10,
                        "MaxRequestsPerSecond": 1000,
                        "LoadSources": null
                    }
                ]
            }
        ],
        "Total": 1
    }
}

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 参数取值错误。