查询定时任务

最近更新时间: 2024-10-18 10:38:34

1. 接口描述

接口请求域名: as.api3.fincloud.tencent.cn。

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

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

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

接口更新时间:2019-11-01 11:11:22。

接口只验签名不鉴权。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 符合条件的定时任务数量。
ScheduledActionSet ScheduledAction 定时任务详细信息列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter.Conflict
InvalidParameterValue.Filter
InternalError