文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 实例管理/ 查询实例是否存在相同定时任务类型 - CheckScheduleTaskExist
更新时间：2026-05-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例是否存在相同定时任务类型 - CheckScheduleTaskExist

功能介绍

查询目标实例在任务中心是否有相同的类型的定时任务。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:getScheduleTask

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:list

    -

URI

POST /v3/{project_id}/instances/{instance_id}/schedule-tasks/exist

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为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。

获取方法请参见查询数据库代理信息列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

exist

Boolean

参数解释：

定时任务类型是否存在。

取值范围：

  • true：指定的定时任务类型已存在。

  • false：指定的定时任务类型不存在。

scheduled_tasks

Array of ScheduledTaskV3 objects

参数解释：

定时任务详情列表。当 exist 为 true 时，此列表包含已存在的任务信息。

取值范围：

不涉及。
表5 ScheduledTaskV3

参数

参数类型

描述

create_time

String

参数解释：

任务创建时间。

取值范围：

不涉及。

datastore_type

String

参数解释：

数据库类型。

取值范围：

目前只支持gaussdb-mysql。

end_time

String

参数解释：

任务结束时间。

取值范围：

不涉及。

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

String

参数解释：

任务开始时间。

取值范围：

不涉及。

target_config

Map<String,String>

参数解释：

任务的目标端配置信息，以键值对形式存储。

task_id

String

参数解释：

任务ID，此参数是任务的唯一标识。

取值范围：

不涉及。

task_name

String

参数解释：

任务名称。

取值范围：

不涉及。

task_order

Integer

参数解释：

任务执行顺序。

取值范围：

不涉及。

task_status

String

参数解释：

任务状态。

取值范围：

  • RUNNING：任务正在执行。

  • SUCCESS：任务执行成功。

  • FAIL：任务执行失败。

  • CANCELED：任务被取消。

  • WAITING：任务等待执行。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询目标实例在任务中心是否有VERSION_UPGRADE的定时任务。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/schedule-tasks/exist

{
  "schedule_type" : "VERSION_UPGRADE",
  "proxy_id" : "cfeff855de83457c8f5a39dcd009ee54po01"
}

响应示例

无

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 实例管理

相关文档