更新时间:2024-11-29 GMT+08:00
分享

查询定时任务

功能介绍

根据指定条件查询定时任务列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/scheduled-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

表2 Query参数

参数

是否必选

参数类型

描述

job_name

String

任务名称,默认为空。对应取值如下:

"RESIZE_FLAVOR":变更实例的CPU和内存规格

job_status

String

任务执行状态,默认为空。 取值:

值为"Pending",表示任务未执行。

值为"Running",表示任务正在执行。

值为"Completed",表示任务执行成功。

值为"Failed",表示任务执行失败。

值为"Canceled",表示任务取消执行。

instance_id

String

实例ID,不传该值默认查所有符合条件的实例。

start_time

String

任务创建起始时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100,不传默认为当前时间前七天。

end_time

String

任务创建结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100,不传默认为当前时间。

offset

Integer

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0。

limit

Integer

查询记录数。不传该参数时,默认为10,取值范围1-100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。请参考认证鉴权

响应参数

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

记录数量。

schedules

Array of objects

任务详情,请参考表5

表5 schedules

参数

参数类型

描述

job_id

String

任务ID。

job_name

String

任务名称。对应取值如下:

"RESIZE_FLAVOR":变更实例的CPU和内存规格

job_status

String

任务执行状态。 取值:

值为"Running",表示任务正在执行。

值为"Completed",表示任务执行成功。

值为"Failed",表示任务执行失败。

值为"Pending",表示任务未执行。

instance_id

String

实例ID。

instance_name

String

实例名称。

instance_status

String

实例状态。 取值:

值为“createfail”,表示实例创建失败。

值为“creating”,表示实例创建中。

值为“normal”,表示实例正常。

值为“abnormal”,表示实例异常。

值为“deleted”,表示实例已删除。

create_time

String

任务创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

start_time

String

任务开始时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

end_time

String

任务结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

请求示例

查询项目ID为b02ce40e8cb84a8e980fdb11fac657db下的前10条定时任务。

GET https://{endpoint}/v3/b02ce40e8cb84a8e980fdb11fac657db/scheduled-jobs

响应示例

状态码: 200

Success

{ 
  "total_count" : 1, 
  "schedules" : [ { 
    "job_id" : "3861199d-c196-4791-bcd0-b45fde754f50", 
    "job_name" : "RESIZE_FLAVOR", 
    "job_status" : "Pending", 
    "instance_id" : "a2b33e2077ee41e397e57cd2f022b72fin02", 
    "instance_name" : "dds-zzx-recover", 
    "instance_status" : "normal", 
    "create_time" : "2019-05-26T10:41:14+0000", 
    "start_time" : "2019-05-26T10:41:14+0000", 
    "end_time" : "2019-05-26T12:51:14+0000" 
  } ] 
}

SDK

单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档