弹性伸缩查询定时任务-定时任务相关接口-API 中心-腾讯云

1. 接口描述

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

本接口 (DescribeScheduledActions) 用于查询一个或多个定时任务的详细信息。

可以根据定时任务ID、定时任务名称或者伸缩组ID等信息来查询定时任务的详细信息。过滤信息详细请见过滤器Filter。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的定时任务。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeScheduledActions。
Version	是	String	公共参数，本接口取值：2018-04-19。
Region	是	String	公共参数，详见产品支持的地域列表。
ScheduledActionIds.N	否	Array of String	按照一个或者多个定时任务ID查询。实例ID形如：asst-am691zxo。每次请求的实例的上限为100。参数不支持同时指定ScheduledActionIds和Filters。示例值：["asst-caa5ha40"]
Filters.N	否	Array of Filter	过滤条件。 scheduled-action-id - String - 是否必填：否 -（过滤条件）按照定时任务ID过滤。 scheduled-action-name - String - 是否必填：否 - （过滤条件）按照定时任务名称过滤。 auto-scaling-group-id - String - 是否必填：否 - （过滤条件）按照伸缩组ID过滤。示例值：[{"Name": "auto-scaling-group-name", "Values": ["production-as"]}]
Offset	否	Integer	偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值：20

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的定时任务数量。示例值：1
ScheduledActionSet	Array of ScheduledAction	定时任务详细信息列表。示例值：[{"Recurrence": "* * * * *", "ScheduledActionId": "asst-9ns4dsr0", "AutoScalingGroupId": "asg-2q2sim6z", "ScheduledType": "ONCE", "MinSize": 0, "MaxSize": 8, "ScheduledActionName": "scale-out", "StartTime": "2023-01-03 09:45:00", "CreatedTime": "2022-01-26T02:46:12Z", "EndTime": "0000-00-00 00:00:00", "DesiredCapacity": 0}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询定时任务

输入示例

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

{
    "ScheduledActionIds": [
        "asst-caa5ha40"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "cc207181-288d-4a39-a1d1-63a5e1ba1d2b",
        "TotalCount": 1,
        "ScheduledActionSet": [
            {
                "ScheduledActionId": "asst-jf898dps",
                "ScheduledActionName": "product-a0-sche0",
                "AutoScalingGroupId": "asg-keqt9eg1",
                "StartTime": "2022-02-22T16:00:00+08:00",
                "Recurrence": "0 0 * * *",
                "EndTime": "2024-02-22T16:00:00+08:00",
                "MaxSize": 15,
                "DesiredCapacity": 1,
                "MinSize": 1,
                "CreatedTime": "2022-02-21T02:19:52Z",
                "ScheduledType": "CRONTAB"
            }
        ]
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter.ActionNotFound	无效的Action请求。
InvalidParameter.Conflict	参数冲突，指定的多个参数冲突，不能同时存在。
InvalidParameterValue.Filter	无效的过滤器。
InvalidParameterValue.InvalidAutoScalingGroupId	伸缩组ID无效。
InvalidParameterValue.InvalidFilter	过滤条件无效。
InvalidParameterValue.InvalidScheduledActionId	定时任务ID无效。
ResourceNotFound.ScheduledActionNotFound	指定的定时任务不存在。

查询定时任务

本页目录：