调用DescribeScheduleTasks查询定时任务详情_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询所有定时任务的详情情况。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeScheduleTasks	get	DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
Status	string	否	任务状态，取值范围如下： pending：等待执行中 executing：执行中 failure：执行失败待重试 finish：已完成 cancel：已取消 expired：超期（即未在计划时间段内开始执行目标任务） rollback：回滚中说明若该参数留空，默认查询所有状态的计划任务。	finish
DBClusterId	string	否	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。若该参数留空，默认查询当前账号下所有集群的计划任务。	pc-**************
RegionId	string	否	地域 ID。说明您可以调用 DescribeRegions 接口查看目标账号下所有的集群的地域信息。若该参数留空，默认查询当前账号下所有地域内的计划任务。	cn-hangzhou
PageNumber	integer	否	页码，取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1。	1
PageSize	integer	否	每页记录数，取值为 30（默认值）、50 或 100。	30
TaskAction	string	否	任务类型，取值范围如下： CreateDBNodes ModifyDBNodeClass UpgradeDBClusterVersion ModifyDBClusterPrimaryZone 说明仅当调用上述接口时指定了`PlannedStartTime`参数值，会返回目标任务的详情，否则`TimerInfos`为空。若该参数留空，默认查询当前账号下所有类型的计划任务。	CreateDBNodes
DBClusterDescription	string	否	集群描述。	testdb
OrderId	string	否	订单 ID。说明仅支持传入数字 0~9。	20951253014****
PlannedStartTime	string	否	为目标任务设定的执行开始时间（UTC 时间）。	2021-01-28T12:00Z
PlannedEndTime	string	否	为目标任务设定的最晚开始时间（UTC 时间）。	2021-01-28T12:30Z
ResourceGroupId	string	否	资源组 ID。	rg-************

返回参数

名称	类型	描述	示例值
	object
Data	object	结果集。
PageNumber	integer	页码。	1
PageSize	integer	本页记录数。	30
TimerInfos	array<object>	计划任务详情。
timerInfos	object
Action	string	任务类型。	CreateDBNodes
CrontabJobId	string	周期策略 ID。
DBClusterId	string	集群 ID。	pc-**************
DbClusterDescription	string	集群描述。	test_cluster
DbClusterStatus	string	集群状态。	Running
OrderId	string	订单 ID。说明仅当`Action`取值为 CreateDBNodes 或 ModifyDBNodeClass 时返回该参数。	208161753******
PlannedEndTime	string	为目标任务设定的最晚开始时间（UTC 时间）。	2021-01-28T12:30Z
PlannedStartTime	string	为目标任务设定的执行开始时间（UTC 时间）。	2021-01-28T12:00Z
PlannedTime	string	系统预计的任务开始执行时间（UTC 时间）。	2021-01-28T12:16Z
Region	string	目标任务所属地域的地域 ID。	cn-hangzhou
Status	string	目标任务的状态。	finish
TaskCancel	boolean	计划任务是否可以取消。取值： true：可以取消 false：不能取消	true
TaskId	string	目标任务的任务 ID。	53879cdb-9a00-428e-acaf-ff4cff******
TotalRecordCount	integer	总记录数。	1
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	936C7025-27A5-4CB1-BB31-540E1F0CCA12
Success	boolean	请求结果。	true

示例

正常返回示例

JSON格式

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TimerInfos": [
      {
        "Action": "CreateDBNodes",
        "CrontabJobId": "",
        "DBClusterId": "pc-**************",
        "DbClusterDescription": "test_cluster",
        "DbClusterStatus": "Running",
        "OrderId": "208161753******",
        "PlannedEndTime": "2021-01-28T12:30Z",
        "PlannedFlashingOffTime": "",
        "PlannedStartTime": "2021-01-28T12:00Z",
        "PlannedTime": "2021-01-28T12:16Z",
        "Region": "cn-hangzhou",
        "Status": "finish",
        "TaskCancel": true,
        "TaskId": "53879cdb-9a00-428e-acaf-ff4cff******"
      }
    ],
    "TotalRecordCount": 1
  },
  "Message": "Successful",
  "RequestId": "936C7025-27A5-4CB1-BB31-540E1F0CCA12",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidOrderId.Malformed	The specified parameter OrderId is not valid.	指定的订单 ID 无效。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-29	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-12	OpenAPI 错误码发生变更	查看变更详情