云压测查询任务列表-API 文档-文档中心-腾讯云

1. 接口描述

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

查询任务列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeJobs。
Version	是	String	公共参数，本接口取值：2021-07-28。
Region	否	String	公共参数，本接口不需要传递此参数。
ScenarioIds.N	是	Array of String	场景ID数组示例值：["scenario-xx"]
ProjectIds.N	是	Array of String	项目ID数组示例值：["project-xx"]
Offset	否	Integer	分页起始位置示例值：0
Limit	否	Integer	每页最大数目示例值：10
JobIds.N	否	Array of String	任务ID数组示例值：["job-xx"]
OrderBy	否	String	按字段排序示例值：id
Ascend	否	Boolean	升序/降序示例值：true
StartTime	否	Timestamp ISO8601	任务开始时间示例值：2021-09-08T16:08:50+08:00
EndTime	否	Timestamp ISO8601	任务结束时间示例值：2021-09-08T16:08:50+08:00
Debug	否	Boolean	调试任务标记示例值：false
Status.N	否	Array of Integer	任务的状态示例值：[10,11]

3. 输出参数

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

4. 示例

示例1 查询任务列表

输入示例

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

{
    "ProjectIds": [
        "project-xx"
    ],
    "OrderBy": "asc",
    "JobIds": [
        "job-xx"
    ],
    "Ascend": true,
    "Limit": 0,
    "StartTime": "2020-09-22T00:00:00+00:00",
    "Offset": 0,
    "EndTime": "2020-09-22T00:00:00+00:00",
    "ScenarioIds": [
        "scenario-xx"
    ]
}

输出示例

{
    "Response": {
        "JobSet": [
            {
                "ErrorRate": 0,
                "RequestTotal": 78,
                "RequestsPerSecond": 3.6055887,
                "ResponseTimeAverage": 0.041749522,
                "ResponseTimeP99": 0.0988,
                "ResponseTimeP95": 0.094,
                "ResponseTimeP90": 0.088,
                "ResponseTimeMax": 0.08245612,
                "ResponseTimeMin": 0.004263497,
                "NetworkReceiveRate": 1842.4558,
                "NetworkSendRate": 773.39874,
                "JobId": "job-g5zcpcwi",
                "ProjectId": "project-492xxqe4",
                "ProjectName": "测试",
                "ScenarioId": "scenario-ouz3x17a",
                "ScenarioName": "pts-js(2024-08-07 11:40:53)",
                "CronId": "",
                "Type": "pts-js",
                "Load": {
                    "LoadSpec": {
                        "Concurrency": {
                            "Stages": [
                                {
                                    "DurationSeconds": 120,
                                    "TargetVirtualUsers": 2
                                },
                                {
                                    "DurationSeconds": 120,
                                    "TargetVirtualUsers": 4
                                },
                                {
                                    "DurationSeconds": 120,
                                    "TargetVirtualUsers": 5
                                },
                                {
                                    "DurationSeconds": 240,
                                    "TargetVirtualUsers": 5
                                }
                            ],
                            "Resources": 1,
                            "IterationCount": 0,
                            "MaxRequestsPerSecond": 40,
                            "GracefulStopSeconds": 3
                        },
                        "RequestsPerSecond": null,
                        "ScriptOrigin": null
                    },
                    "VpcLoadDistribution": null,
                    "GeoRegionsLoadDistribution": [
                        {
                            "Region": "ap-guangzhou",
                            "RegionId": 1,
                            "Percentage": 100
                        }
                    ]
                },
                "TestScripts": null,
                "Datasets": null,
                "Protocols": [],
                "RequestFiles": [],
                "Plugins": [],
                "StartTime": "2024-08-08T14:31:50+08:00",
                "EndTime": "2024-08-08T14:32:12+08:00",
                "Note": "",
                "JobOwner": "teset",
                "AbortReason": 1,
                "Status": 16,
                "Message": "用户中断",
                "DomainNameConfig": {
                    "HostAliases": null,
                    "DNSConfig": null
                },
                "Debug": false,
                "NotificationHooks": null,
                "Duration": 600,
                "MaxVirtualUserCount": 5,
                "MaxRequestsPerSecond": 40,
                "LoadSourceInfos": null,
                "CreatedAt": "2024-08-08T14:31:44+08:00",
                "Configs": null,
                "Extensions": null,
                "Scripts": null,
                "LoadSources": null
            }
        ],
        "RequestId": "ae27925c-eb40-47d3-8643-c8c204ab77be",
        "Total": 1
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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