# 查询定时任务列表 - QueryingScheduledTasks #### 功能介绍 根据指定条件查询定时任务列表。 #### 接口约束 该接口支持如下数据库实例。 - GeminiDB Influx - GeminiDB Redis - GeminiDB Mongo - GeminiDB Cassandra #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=UpdateHighRiskCommands)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:task:list | List | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | nosql:task:list | - | #### URI GET /v3/{project_id}/scheduled-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_name | 否 | String | **参数解释：** 任务名称。 **约束限制：** 不涉及。 **取值范围：** - REBOOT：重启实例。 - RESIZE_FLAVOR：变更实例的CPU和内存规格。 - UPGRADE_DATABASE：补丁升级。 **默认取值：** 默认为空。 | | job_status | 否 | String | **参数解释：** 任务执行状态。 **约束限制：** 不涉及。 **取值范围：** - Pending：表示任务未执行。 - Running：表示任务正在执行。 - Completed：表示任务执行成功。 - Failed：表示任务执行失败。 - Canceled：表示任务取消执行。 **默认取值：** 默认为空。 | | instance_id | 否 | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不传该值默认查询所有符合条件的实例。 | | start_time | 否 | String | **参数解释：** 任务创建起始时间。 **约束限制：** 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 **取值范围：** 不涉及。 **默认取值：** 不传该值默认为当前时间前7天。 | | end_time | 否 | String | **参数解释：** 任务创建结束时间。 **约束限制：** 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 **取值范围：** 不涉及。 **默认取值：** 不传该值默认为当前时间。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 从第一条数据偏移offset条数据后开始查询，默认为0。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** 1-100。 **默认取值：** 10。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 记录总数。 **取值范围：** 不涉及。 | | schedules | Array of [表5] objects | **参数解释：** 任务详情。 | 表5ScheduleDetailInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。