文档首页/ 分布式消息服务RabbitMQ版/ API参考/ API V2（推荐）/ 后台任务管理/ 查询实例的定时任务列表 - ListScheduledTasks
更新时间：2025-11-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例的定时任务列表 - ListScheduledTasks

功能介绍

查询实例的定时任务列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/instances/{instance_id}/scheduled-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

start

否

String

参数解释：

开启查询的定时任务编号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

String

参数解释：

查询的定时任务个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

begin_time

否

String

参数解释：

查询定时任务的最小时间，格式为YYYYMMDDHHmmss。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

否

String

参数解释：

查询定时任务的最大时间，格式为YYYYMMDDHHmmss。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

job_count

String

参数解释：

任务总数。

取值范围：

不涉及。

jobs

Array of ScheduledTaskEntity objects

参数解释：

任务列表。

取值范围：

不涉及。
表4 ScheduledTaskEntity

参数

参数类型

描述

id

String

参数解释：

任务ID。

取值范围：

不涉及。

name

String

参数解释：

任务名称。

取值范围：

不涉及。

user_name

String

参数解释：

用户名称。

取值范围：

不涉及。

user_id

String

参数解释：

用户ID。

取值范围：

不涉及。

params

String

参数解释：

任务参数。

取值范围：

不涉及。

status

String

参数解释：

任务状态。

取值范围：

  • CREATED：定时任务状态为创建成功。

  • SUCCESS：定时任务状态为成功。

  • FAILED：定时任务状态为失败。

  • DELETED：定时任务状态为已删除。

  • EXECUTING：定时任务状态为执行中。

  • CANCELLED：定时任务状态为取消。

created_at

String

参数解释：

创建时间。

取值范围：

不涉及。

updated_at

String

参数解释：

更新时间。

取值范围：

不涉及。

schedule_at

String

参数解释：

定时执行时间。

取值范围：

不涉及。

请求示例

分页查询1970.01.01.000000到2024.01.01.000000之间的定时任务。

/v2/{{project_id}}/instances/{instance_id}/schedule-tasks?start=0&limit=10&beginTime=19700101000000&endTime=20240101000000

响应示例

状态码：200

查询实例的定时任务列表成功。

{
  "job_count" : 2,
  "jobs" : [ {
    "id" : "ff808082889e267601889e2df7be0013",
    "name" : "jobName",
    "user_name" : "paas_dms_03",
    "user_id" : "0b01fbb53600d4671fa8c00673c71260",
    "params" : "{\"reassignment_topics\":\"[topic-1]\"}",
    "status" : "SUCCESS",
    "created_at" : "2023-06-09T03:23:12.702Z",
    "updated_at" : "2023-06-09T03:35:00.067Z",
    "schedule_at" : "2023-06-08T05:08:26.000Z"
  } ]
}

状态码

状态码

描述

200

查询实例的定时任务列表成功。

错误码

请参见错误码。

父主题： 后台任务管理

相关文档