# 查询实例是否存在相同定时任务类型 - CheckScheduleTaskExist #### 功能介绍 查询目标实例在任务中心是否有相同的类型的定时任务。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:instance:getScheduleTask | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:instance:list | - | #### URI POST /v3/{project_id}/instances/{instance_id}/schedule-tasks/exist 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 获取方法请参见[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | schedule_type | 是 | String | **参数解释**： 定时任务类型。 **约束限制**： 不涉及。 **取值范围**： - PROXY_VERSION_UPGRADE：表示升级数据库代理的内核小版本。 - VERSION_UPGRADE：表示升级实例的内核小版本。 - RESIZE_FLAVOR：表示实例规格变更。 - REBOOT_NODE：表示重启节点。 - REBOOT_INSTANCE：表示重启实例。 **默认取值**： 不涉及。 | | proxy_id | 否 | String | **参数解释**： 数据库代理ID。 获取方法请参见[查询数据库代理信息列表](https://support.huaweicloud.com/api-taurusdb/ShowGaussMySqlProxyList.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | exist | Boolean | **参数解释**： 定时任务类型是否存在。 **取值范围**： - true：指定的定时任务类型已存在。 - false：指定的定时任务类型不存在。 | | scheduled_tasks | Array of [ScheduledTaskV3] objects | **参数解释**： 定时任务详情列表。当 *exist* 为 true 时，此列表包含已存在的任务信息。 **取值范围**： 不涉及。 | 表5ScheduledTaskV3 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | Long | **参数解释**： 任务创建时间。 **取值范围**： 不涉及。 | | datastore_type | String | **参数解释**： 数据库类型。 **取值范围**： 目前只支持gaussdb-mysql。 | | end_time | Long | **参数解释**： 任务结束时间。 **取值范围**： 不涉及。 | | instance_id | String | **参数解释**： 任务绑定的实例ID。 **取值范围**： 不涉及。 | | instance_name | String | **参数解释**： 任务绑定的实例名称。 **取值范围**： 不涉及。 | | instance_status | String | **参数解释**： 任务绑定的实例状态。 **取值范围**： - NORMAL：实例正常状态。 - BACKING_UP：实例备份中状态。 - MODIFYING：实例修改中状态。 - REBUILDING：实例重建中状态。 - RESTORING：实例恢复中状态。 - FROZEN：实例已冻结状态。 - FAILED：实例状态异常。 - DELETING：实例删除中状态。 - CREATE_FAILED：实例创建失败状态。 | | project_id | String | **参数解释**： 租户项目ID。 **取值范围**： 不涉及。 | | proxy_id | String | **参数解释**： 任务使用的数据库代理ID。 **取值范围**： 不涉及。 | | proxy_name | String | **参数解释**： 任务使用的数据库代理名称。 **取值范围**： 不涉及。 | | start_time | Long | **参数解释**： 任务开始时间。 **取值范围**： 不涉及。 | | target_config | Map\ | **参数解释**： 任务的目标端配置信息，以键值对形式存储。 | | task_id | String | **参数解释**： 任务ID，此参数是任务的唯一标识。 **取值范围**： 不涉及。 | | task_name | String | **参数解释**： 任务名称。 **取值范围**： 不涉及。 | | task_order | Integer | **参数解释**： 任务执行顺序。 **取值范围**： 不涉及。 | | task_status | String | **参数解释**： 任务状态。 **取值范围**： - Running：任务正在执行。 - Failed：任务执行失败。 - Canceled：任务被取消。 - Pending：任务等待执行。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 查询目标实例在任务中心是否有REBOOT_NODE的定时任务。 ``` POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/schedule-tasks/exist { "schedule_type" : "REBOOT_NODE" } ``` #### 响应示例 **状态码：200** ``` { "exist" : true, "scheduled_tasks" : [ { "task_id" : "1d19619a68b047b08c82b2d57dfb907b", "instance_id" : "61a4ea66210545909d74a05c27a7179ein07", "instance_name" : null, "instance_status" : null, "project_id" : "619d3e78f61b4be68bc5aa0b59edcf7b", "task_name" : "REBOOT_NODE", "create_time" : 1779955044142, "start_time" : 1779991200000, "end_time" : 1780005600000, "task_order" : null, "task_status" : "Pending", "datastore_type" : null, "target_config" : null, "proxy_id" : null, "proxy_name" : null } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询目标实例在任务中心是否有REBOOT_NODE的定时任务。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class CheckScheduleTaskExistSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("")) .build(); CheckScheduleTaskExistRequest request = new CheckScheduleTaskExistRequest(); request.withInstanceId("{instance_id}"); CheckScheduleTaskExistRequestBody body = new CheckScheduleTaskExistRequestBody(); body.withScheduleType("REBOOT_NODE"); request.withBody(body); try { CheckScheduleTaskExistResponse response = client.checkScheduleTaskExist(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 查询目标实例在任务中心是否有REBOOT_NODE的定时任务。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("")) \ .build() try: request = CheckScheduleTaskExistRequest() request.instance_id = "{instance_id}" request.body = CheckScheduleTaskExistRequestBody( schedule_type="REBOOT_NODE" ) response = client.check_schedule_task_exist(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 查询目标实例在任务中心是否有REBOOT_NODE的定时任务。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.CheckScheduleTaskExistRequest{} request.InstanceId = "{instance_id}" request.Body = &model.CheckScheduleTaskExistRequestBody{ ScheduleType: "REBOOT_NODE", } response, err := client.CheckScheduleTaskExist(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=CheckScheduleTaskExist)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。