帮你快速理解、总结文档立即下载

查询AI 定时任务触发计划

最近更新时间:2026-08-20 01:44:53
我的收藏

1. 接口描述

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

查询AI 定时任务触发计划。

查询指定AI 定时任务在给定时间窗口内的未来触发计划列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAISchedulePlanList。
Version String 公共参数,本接口取值:2022-11-21。
Region String 公共参数,此参数为可选参数。
ScheduleId String

AI 定时任务 ID。可通过 DescribeAIScheduleList 接口获取。


示例值:sched-a1b2c3d4
StartTime Integer

预览窗口开始时间,Unix 毫秒时间戳,0 表示当前时间。


示例值:1704067200000
EndTime Integer

预览窗口结束时间,Unix 毫秒时间戳。


示例值:1704153600000
Offset Integer

分页偏移量,默认 0。


示例值:0
Limit Integer

最大返回条数,默认 20,最大 100。


示例值:10

3. 输出参数

参数名称 类型 描述
PlanSet Array of AiSchedulePlanInfo

触发计划列表。

TotalCount Integer

总条数。


示例值:3
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 触发计划列表

输入示例

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

{
    "ScheduleId": "sched-a1b2c3d4",
    "StartTime": 1704067200000,
    "EndTime": 1704153600000,
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "PlanSet": [
            {
                "FireTime": 1775725829063,
                "TriggerId": "trigger-mock-001",
                "TriggerType": 1
            }
        ],
        "TotalCount": 3,
        "RequestId": "de1463ad-426b-4970-8458-68f1208a907b"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。