云压测列出定时任务-PTS相关接口-API 中心-腾讯云

1. 接口描述

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

列出定时任务，非必填数组为空就默认全选

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCronJobs。
Version	是	String	公共参数，本接口取值：2021-07-28。
Region	否	String	公共参数，本接口不需要传递此参数。
ProjectIds.N	是	Array of String	项目ID数组示例值：["project-xx"]
Offset	否	Integer	偏移量，默认为0 示例值：0
Limit	否	Integer	返回数量示例值：10
CronJobIds.N	否	Array of String	定时任务ID数组示例值：["cron-xx"]
CronJobName	否	String	定时任务名字，模糊查询示例值：test
CronJobStatus.N	否	Array of Integer	定时任务状态数组示例值：[1,2]
OrderBy	否	String	排序的列示例值：status
Ascend	否	Boolean	是否正序示例值：true

3. 输出参数

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

4. 示例

示例1 DescribeCronJobs

列出定时任务,数组为空默认全选

输入示例

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

{
    "ProjectIds": [
        "project-xx"
    ],
    "CronJobIds": [
        "cron-xx"
    ],
    "OrderBy": "Status",
    "Limit": 10,
    "Ascend": true
}

输出示例

{
    "Response": {
        "RequestId": "xx",
        "CronJobSet": [
            {
                "CreatedAt": "2021-09-27T10:46:26+08:00",
                "UpdatedAt": "2021-09-27T10:46:26+08:00",
                "CronJobId": "cron-xx",
                "Name": "hello",
                "Status": 2,
                "ProjectId": "1"
            }
        ],
        "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. 错误码

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

错误码	描述
FailedOperation.DbQueryFailed	数据库查询失败。

列出定时任务

本页目录：