查询实例是否存在相同定时任务类型 - CheckScheduleTaskExist
功能介绍
查询目标实例在任务中心是否有相同的类型的定时任务。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v3/{project_id}/instances/{instance_id}/schedule-tasks/exist
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| schedule_type | 是 | String | 参数解释: 定时任务类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| proxy_id | 否 | String | 参数解释: 数据库代理ID。 获取方法请参见查询数据库代理信息列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| exist | Boolean | 参数解释: 定时任务类型是否存在。 取值范围: |
| scheduled_tasks | Array of ScheduledTaskV3 objects | 参数解释: 定时任务详情列表。当 exist 为 true 时,此列表包含已存在的任务信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| create_time | Long | 参数解释: 任务创建时间。 取值范围: 不涉及。 |
| datastore_type | String | 参数解释: 数据库类型。 取值范围: 目前只支持gaussdb-mysql。 |
| end_time | Long | 参数解释: 任务结束时间。 取值范围: 不涉及。 |
| instance_id | String | 参数解释: 任务绑定的实例ID。 取值范围: 不涉及。 |
| instance_name | String | 参数解释: 任务绑定的实例名称。 取值范围: 不涉及。 |
| instance_status | String | 参数解释: 任务绑定的实例状态。 取值范围: |
| project_id | String | 参数解释: 租户项目ID。 取值范围: 不涉及。 |
| proxy_id | String | 参数解释: 任务使用的数据库代理ID。 取值范围: 不涉及。 |
| proxy_name | String | 参数解释: 任务使用的数据库代理名称。 取值范围: 不涉及。 |
| start_time | Long | 参数解释: 任务开始时间。 取值范围: 不涉及。 |
| target_config | Map<String,String> | 参数解释: 任务的目标端配置信息,以键值对形式存储。 |
| task_id | String | 参数解释: 任务ID,此参数是任务的唯一标识。 取值范围: 不涉及。 |
| task_name | String | 参数解释: 任务名称。 取值范围: 不涉及。 |
| task_order | Integer | 参数解释: 任务执行顺序。 取值范围: 不涉及。 |
| task_status | String | 参数解释: 任务状态。 取值范围: |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
查询目标实例在任务中心是否有REBOOT_NODE的定时任务。
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/schedule-tasks/exist
{
"schedule_type" : "REBOOT_NODE"
} 响应示例
状态码:200
Success.
{
"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代码示例如下。
查询目标实例在任务中心是否有REBOOT_NODE的定时任务。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | 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("<YOUR REGION>")) .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()); } } } |
查询目标实例在任务中心是否有REBOOT_NODE的定时任务。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | # 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("<YOUR REGION>")) \ .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) |
查询目标实例在任务中心是否有REBOOT_NODE的定时任务。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | 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("<YOUR REGION>")). 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的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success. |
| 400 | Client error. |
| 500 | Server error. |
错误码
请参见错误码。