文档首页/ 云运维中心 COC/ API参考/ API/ 定时运维/ 查询ScheduledTask列表
更新时间：2025-09-04 GMT+08:00
查看PDF
分享

查询ScheduledTask列表

功能介绍

按特定条件查询定时运维任务列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/schedule/task

表1 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释：

企业项目ID

约束限制：

请选择企业管理中存在的企业项目ID。

取值范围：

不涉及。

默认取值：

0。

task_id

否

String

参数解释：

任务ID。

约束限制：

请选择真实存在的定时任务ID。

取值范围：

以“ST”开头长度26的字符串。

默认取值：

不涉及。

task_name

否

String

参数解释：

任务名称。

约束限制：

与task_id对应，请选择真实存在的定时任务名称。

取值范围：

不涉及。

默认取值：

不涉及。

scheduled_type

否

String

参数解释：

定时任务执行策略。

约束限制：

不涉及。

取值范围：

  • PERIODIC：周期执行。

  • ONCE：单次执行。

  • CRON：按CRON表达式执行。

默认取值：

不涉及。

task_type

否

String

参数解释：

定时任务类型。

约束限制：

不涉及。

取值范围：

  • SCRIPT：脚本。

  • RUNBOOK：作业。

默认取值：

不涉及。

associated_task_type

否

String

参数解释：

关联任务的类型。

约束限制：

不涉及。

取值范围：

  • CUSTOMIZATION：自定义脚本/作业。

  • COMMUNAL：公共脚本/作业。

默认取值：

不涉及。

risk_level

否

String

参数解释：

定时任务的风险等级。

约束限制：

不涉及。

取值范围：

  • HIGH：高风险。

  • MEDIUM：中风险。

  • LOW：低风险。

默认取值：

不涉及。

created_by

否

String

参数解释：

定时任务创建人的IAM用户ID。

约束限制：

请选择在人员管理中存在的用户ID。

取值范围：

不涉及。

默认取值：

不涉及。

reviewer

否

String

参数解释：

定时任务审批人的IAM用户ID。

约束限制：

请选择在人员管理中存在的用户ID。

取值范围：

不涉及。

默认取值：

不涉及。

reviewer_user_name

否

String

参数解释：

审批人昵称。

约束限制：

与reviewer对应。

取值范围：

不涉及。

默认取值：

不涉及。

approve_status

否

String

参数解释：

定时任务的的审批状态。

约束限制：

不涉及。

取值范围：

  • PASSED：正常。

  • PENDING：待审批。

  • REJECTED：驳回。

默认取值：

不涉及。

last_execution_status

否

String

参数解释：

定时任务的最近执行状态。

约束限制：

不涉及。

取值范围：

  • READY：待执行。

  • PROCESSING：执行中。

  • ABNORMAL：异常。

  • PAUSED：已暂停。

  • CANCELED：已取消。

  • FINISHED：成功。

默认取值：

不涉及。

last_execution_start_time

否

Long

参数解释：

定时任务最近执行时间的查询开始时间的时间戳。

约束限制：

不涉及。

取值范围：

毫秒级UTC时间戳。

默认取值：

不涉及。

last_execution_end_time

否

Long

参数解释：

定时任务最近执行时间的查询结束时间的时间戳。

约束限制：

不涉及。

取值范围：

毫秒级UTC时间戳。

默认取值：

不涉及。

marker

否

String

参数解释：

用于分页查询。

约束限制：

不涉及。

取值范围：

上一次查询的最后一条记录ID。

默认取值：

不涉及。

region_id

否

String

参数解释：

区域。

约束限制：

请参考统一身份认证服务选择存在的区域。

取值范围：

不涉及。

默认取值：

不涉及。

resource_id

否

String

参数解释：

资源ID。

约束限制：

仅支持单个资源查询。

取值范围：

不涉及。

默认取值：

默认为空。

offset

否

Integer

参数解释：

用于分页查询，偏移指针。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

Integer

参数解释：

用于分页查询，查询数量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

count

Long

参数解释：

定时运维任务的总数量。

取值范围：

不涉及。

next_maker

String

参数解释：

用于分页查询的下次起始点。

取值范围：

不涉及。

scheduled_tasks

Array of ScheduledTaskBasicInfo objects

参数解释：

定时运维任务列表。

取值范围：

请参考ScheduledTaskBasicInfo的具体取值约束。
表3 ScheduledTaskBasicInfo

参数

参数类型

描述

id

String

参数解释：

任务ID。

取值范围：

以“ST”开头长度26的字符串。

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

不涉及。

name

String

参数解释：

任务名称。

取值范围：

由中文、字母、数字、中划线、下划线组成，长度在3~100之间。

scheduled_type

String

参数解释：

定时任务执行策略。

取值范围：

  • PERIODIC：周期执行。

  • ONCE：单次执行。

  • CRON：按CRON表达式执行。

task_type

String

参数解释：

定时任务引用的任务类型。

取值范围：

  • SCRIPT：脚本。

  • RUNBOOK：作业。

associated_task_type

String

参数解释：

定时任务引用的任务属性。

取值范围：

  • CUSTOMIZATION：自定义脚本/作业。

  • COMMUNAL：公共脚本/作业。

risk_level

String

参数解释：

定时任务风险等级。

取值范围：

  • HIGH：高风险。

  • MEDIUM：中风险。

  • LOW：低风险。

created_by

String

参数解释：

定时任务创建人的IAM用户ID。

取值范围：

不涉及。

update_by

String

参数解释：

定时任务修改人。

取值范围：

不涉及。

created_user_name

String

参数解释：

定时任务创建人昵称。

取值范围：

不涉及。

reviewer

String

参数解释：

定时任务审批人的IAM用户ID。

取值范围：

不涉及。

reviewer_user_name

String

参数解释：

定时任务审批人昵称。

取值范围：

不涉及。

approve_status

Object

参数解释：

定时任务审批状态。

取值范围：

  • PASSED：正常。

  • PENDING：待审批。

  • REJECTED：驳回。

last_execution_time

Long

参数解释：

定时任务最近执行时间时间戳。

取值范围：

不涉及。

last_execution_status

String

参数解释：

定时任务的最近执行状态。

取值范围：

  • READY：待执行。

  • PROCESSING：执行中。

  • ABNORMAL：异常。

  • PAUSED：已暂停。

  • CANCELED：已取消。

  • FINISHED：成功。

execution_count

Integer

参数解释：

定时任务执行次数。

取值范围：

不涉及。

enabled

Boolean

参数解释：

定时任务是否启用。

取值范围：

布尔值。

created_time

Long

参数解释：

定时任务创建时间戳。

取值范围：

不涉及。

modified_time

Long

参数解释：

定时任务更新时间戳。

取值范围：

不涉及。

region_id

String

参数解释：

定时任务所属区域。

取值范围：

不涉及。

associated_task_name

String

参数解释：

定时任务关联的脚本/作业名称。

取值范围：

不涉及。

associated_task_name_en

String

参数解释：

任务关联脚本/作业名称（英文）。

取值范围：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

查询前10个最近执行成功，且执行策略为单次执行的定时任务。

GET https://{Endpoint}/v1/schedule/task?offset=0&limit=10&scheduled_type=ONCE&last_execution_status=FINISHED

响应示例

状态码：200

请求成功。

{
  "count" : 1,
  "next_maker" : "ST****",
  "scheduled_tasks" : [ {
    "approve_status" : "PASSED",
    "associated_task_name" : "test_scheduled_task",
    "associated_task_name_en" : "",
    "associated_task_type" : "CUSTOMIZATION",
    "created_by" : "****",
    "created_time" : 1745396111000,
    "created_user_name" : "****",
    "enabled" : true,
    "enterprise_project_id" : "0",
    "execution_count" : 1,
    "id" : "****",
    "last_execution_status" : "FINISHED",
    "last_execution_time" : 1745396135000,
    "modified_time" : 1745396111000,
    "name" : "****",
    "region_id" : "cn-north-4",
    "risk_level" : "LOW",
    "scheduled_type" : "ONCE",
    "task_type" : "RUNBOOK",
    "update_by" : "****"
  } ]
}

状态码

状态码

描述

200

请求成功。

400

服务器未能处理请求。

错误码

请参见错误码。

父主题： 定时运维

相关文档