云服务器
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云服务器 > API 文档 > 实例相关接口 > 查询定时任务信息

查询定时任务信息

最近更新时间：2024-03-12 01:19:26

我的收藏

1. 接口描述

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

本接口 (DescribeInstancesActionTimer) 用于查询定时任务信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeInstancesActionTimer。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
ActionTimerIds.N 否 Array of String 定时任务ID列表。
InstanceIds.N 否 Array of String 按照一个或者多个实例ID查询。
示例值：["ins-37qv3ucj\r\n"]
TimerAction 否 String 定时任务执行时间，格式如：2018-05-01 19:00:00，必须大于当前时间5分钟。
EndActionTime 否 String 执行时间的结束范围，用于条件筛选，格式如2018-05-01 19:00:00。
StartActionTime 否 String 执行时间的开始范围，用于条件筛选，格式如2018-05-01 19:00:00。
StatusList.N 否 Array of String 定时任务状态列表。
  • UNDO：未执行
  • DOING：正在执行
  • DONE：执行完成。
    		•

    3. 输出参数

    参数名称 类型 描述
    ActionTimers Array of ActionTimer 定时任务信息列表。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询定时任务

    输入示例

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

{
    "InstanceIds": [
        "ins-37qv3ucj"
    ]
}

    输出示例

    {
    "Response": {
        "ActionTimers": [
            {
                "TimerAction": "TerminateInstances",
                "ActionTime": "2020-02-02 10:00:00",
                "Externals": {}
            }
        ],
        "RequestId": "af3ab130-244d-4c66-a8a0-03cad009f825"
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue.InvalidAppIdFormat 无效的appid。
    InvalidParameterValue.InvalidTimeFormat 时间格式不合法。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    中国站