查询定时任务列表
功能介绍
根据指定条件查询定时任务列表。
接口约束
该接口支持如下数据库实例。
- GeminiDB Influx
- GeminiDB Redis
- GeminiDB Mongo
- GeminiDB Cassandra
URI
GET https://{Endpoint}/v3/{project_id}/scheduled-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户在某一region下的project Id。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_name |
否 |
String |
任务名称,默认为空。对应取值如下:
|
job_status |
否 |
String |
任务执行状态,默认为空。取值:
|
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。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户认证Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
Integer |
记录总数。 |
schedules |
Array of objects |
任务详情。详情请参考表5。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID。 |
job_name |
String |
任务名称。对应取值如下:
|
job_status |
String |
任务执行状态。取值:
|
instance_id |
String |
实例ID。 |
instance_name |
String |
实例名称。 |
instance_status |
String |
实例状态。取值:
|
datastore_type |
String |
数据库类型。 |
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。 |
请求示例
根据指定条件查询定时任务列表。
GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/scheduled-jobs?offset=2&limit=2&start_time=2019-05-27T03:38:51+0000&job_status=Pending
响应示例
状态码: 200
Success
{ "schedules" : [ { "job_id" : "56d3c1138dcf4f1da73b0170700c78d0", "job_name" : "REBOOT", "job_status" : "Pending", "instance_id" : "8a6117ece8a0457a90060441fa372e8ein06", "instance_name" : "gauss-nosql", "instance_status" : "normal", "datastore_type" : "GeminiDB Cassandra", "create_time" : "2019-05-26T10:41:14+0000", "start_time" : "2019-05-26T12:41:14+0000", "end_time" : "2019-05-26T12:51:14+0000" } ], "total_count" : 1 }
状态码
请参见状态码。
错误码
请参见错误码。