- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询ScheduledTask列表
功能介绍
按特定条件查询定时运维任务列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/schedule/task
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
企业项目ID。 约束：请选择企业管理中存在的项目ID。 默认值：不涉及。 |
|
task_id |
否 |
String |
任务ID。 取值范围：以“ST”开头长度26的字符串。 默认值：不涉及。 |
|
task_name |
否 |
String |
任务名称，与task_id对应。 |
|
scheduled_type |
否 |
String |
定时任务执行策略。 取值范围： 默认值：不涉及。 |
|
task_type |
否 |
String |
定时任务类型。 取值范围： 默认值：不涉及。 |
|
associated_task_type |
否 |
String |
关联任务的类型。 取值范围： 默认值：不涉及。 |
|
risk_level |
否 |
String |
定时任务的风险等级。 取值范围： 默认值：不涉及。 |
|
created_by |
否 |
String |
定时任务创建人的IAM用户ID。 约束：请选择在人员管理中存在的用户ID。 默认值：不涉及。 |
|
reviewer |
否 |
String |
定时任务审批人的IAM用户ID。 约束：请选择在人员管理中存在的用户ID。 默认值：不涉及。 |
|
reviewer_user_name |
否 |
String |
审批人昵称，与reviewer对应。 |
|
approve_status |
否 |
String |
定时任务的审批状态。 取值范围： 默认值：不涉及。 |
|
last_execution_status |
否 |
String |
定时任务的最近执行状态。 取值范围： 默认值：不涉及。 |
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
定时运维任务的总数量。 |
|
next_maker |
String |
用于分页查询的下次起始点。 |
|
scheduled_tasks |
Array of ScheduledTaskBasicInfo objects |
定时运维任务列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
任务ID。 |
|
enterprise_project_id |
String |
企业项目ID。 |
|
name |
String |
任务名称。 |
|
scheduled_type |
String |
任务执行策略。 |
|
task_type |
String |
引用任务类型。 |
|
associated_task_type |
String |
任务关联任务的属性（公共/自定义）。 |
|
risk_level |
String |
任务风险等级。 |
|
created_by |
String |
任务创建人。 |
|
update_by |
String |
任务修改人。 |
|
created_user_name |
String |
任务创建人昵称。 |
|
reviewer |
String |
任务审批人。 |
|
reviewer_user_name |
String |
任务审批人昵称。 |
|
approve_status |
Object |
任务审批状态。 |
|
last_execution_time |
Long |
任务最近执行时间时间戳。 |
|
last_execution_status |
String |
任务最近执行状态。 |
|
execution_count |
Integer |
任务执行次数。 |
|
enabled |
Boolean |
任务是否启用。 |
|
created_time |
Long |
任务创建时间。 |
|
modified_time |
Long |
任务更新时间。 |
|
region_id |
String |
任务所属区域。 |
|
associated_task_name |
String |
任务关联的脚本/作业名称。 |
|
associated_task_name_en |
String |
任务关联脚本/作业名称（英文）。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
服务器未能处理请求。 |
错误码
请参见错误码。
