查询定时任务列表 - QueryingScheduledTasks

功能介绍

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

接口约束

该接口支持如下数据库实例。

GeminiDB Influx
GeminiDB Redis
GeminiDB Mongo
GeminiDB Cassandra

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:task:list
List
instance *
g:ResourceTag/<tag-key>
g:EnterpriseProjectId
nosql:task:list
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbfornosql:task:list	List	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:task:list	-

URI

GET /v3/{project_id}/scheduled-jobs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户在某一region下的project Id。

表2 Query参数
参数	是否必选	参数类型	描述
job_name	否	String	任务名称，默认为空。对应取值如下： REBOOT：重启实例。 RESIZE_FLAVOR：变更实例的CPU和内存规格。 UPGRADE_DATABASE：补丁升级。
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	用户认证Token。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total_count	Integer	记录总数。
schedules	Array of objects	任务详情。详情请参考表5。

表5 ScheduleDetailInfo
参数	参数类型	描述
job_id	String	任务ID。
job_name	String	任务名称。对应取值如下： REBOOT：重启实例。 RESIZE_FLAVOR：变更实例的CPU和内存规格。 UPGRADE_DATABASE：补丁升级。
job_status	String	任务执行状态。取值： Pending：表示任务未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 Canceled：表示任务取消执行。
instance_id	String	实例ID。
instance_name	String	实例名称。
instance_status	String	实例状态。取值： Createfail：表示实例创建失败。 Creating：表示实例创建中。 Normal：表示实例正常。 Abnormal：表示实例异常。 Deleted：表示实例已删除。
datastore_type	String	数据库类型。取值为枚举值： GeminiDB Mongo: 表示GeminiDB Mongo接口类型。 GeminiDB Cassandra: 表示GeminiDB Cassandra接口类型。 GeminiDB Redis: 表示GeminiDB Redis接口类型。 GeminiDB Influx: 表示GeminiDB Influx接口类型。 GeminiDB DynamoDB: 表示GeminiDB兼容DynamoDB接口类型。 GeminiDB HBase: 表示GeminiDB HBase接口类型。
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 
}