调用DescribeScheduleTasks接口查看当前账号下所有或指定的计划任务详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeScheduleTasks

系统规定参数,取值为DescribeScheduleTasks

Status String finish

任务状态,取值范围如下:

  • pending:等待执行中
  • executing:执行中
  • failure:执行失败待重试
  • finish:已完成
  • cancel:已取消
  • expired:超期(即未在计划时间段内开始执行目标任务)
  • rollback:回滚中
说明 若该参数留空,默认查询所有状态的计划任务。
DBClusterId String pc-**************

集群ID。

说明
  • 您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息,包括集群ID。
  • 若该参数留空,默认查询当前账号下所有集群的计划任务。
RegionId String cn-hangzhou

地域ID。

说明
  • 您可以调用DescribeRegions接口查看目标账号下所有的集群的地域信息。
  • 若该参数留空,默认查询当前账号下所有地域内的计划任务。
PageNumber Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值。默认值为1

PageSize Integer 30

每页记录数,取值为30(默认值)、50100

TaskAction String CreateDBNodes

任务类型,取值范围如下:

  • CreateDBNodes
  • ModifyDBNodeClass
  • UpgradeDBClusterVersion
  • ModifyDBClusterPrimaryZone
说明
  • 仅当调用上述接口时指定了PlannedStartTime参数值,会返回目标任务的详情,否则TimerInfos为空。
  • 若该参数留空,默认查询当前账号下所有类型的计划任务。
DBClusterDescription String testdb

集群描述。

OrderId String 20951253014****

订单ID。

说明 仅支持传入数字0~9。

返回数据

名称 类型 示例值 描述
Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Data Object

结果集。

TimerInfos Array of timerInfos

计划任务详情。

Status String finish

目标任务的状态。

Action String CreateDBNodes

任务类型。

PlannedEndTime String 2021-01-28T12:30Z

为目标任务设定的最晚结束时间(UTC时间)。

PlannedTime String 2021-01-28T12:16Z

系统预计的任务开始执行时间(UTC时间)。

DBClusterId String pc-**************

集群ID。

Region String cn-hangzhou

目标任务所属地域的地域ID。

PlannedStartTime String 2021-01-28T12:00Z

为目标任务设定的执行开始时间(UTC时间)。

TaskId String 53879cdb-9a00-428e-acaf-ff4cff******

目标任务的任务ID。

OrderId String 208161753******

订单ID。

说明 仅当Action取值为CreateDBNodesModifyDBNodeClass时返回该参数。
DbClusterStatus String Running

集群状态。

DbClusterDescription String test_cluster

集群描述。

TotalRecordCount Integer 1

总记录数。

PageNumber Integer 1

页码。

PageSize Integer 30

本页记录数。

Success Boolean true

请求结果。

RequestId String 936C7025-27A5-4CB1-BB31-540E1F0CCA12

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeScheduleTasks
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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