调用DescribePendingMaintenanceAction接口查询待处理事件的详情。

调试

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

请求参数

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

系统规定参数。取值：DescribePendingMaintenanceAction。

RegionId String 否 cn-hangzhou

地域ID。
Region String 是 all

待处理事件所在地域的地域ID，您可以调用DescribeRegions接口查看PolarDB支持的地域和可用区。

说明
  • 您可以输入all查看您账户下所有的待处理事件。
  • 当Region设置为all时，TaskType也必须设置为all。
TaskType String 是 all

待处理事件的任务类型，取值范围如下：

  • DatabaseSoftwareUpgrading：数据库软件升级
  • DatabaseHardwareMaintenance：硬件维护与升级
  • DatabaseStorageUpgrading：数据库存储升级
  • DatabaseProxyUpgrading：代理小版本升级
  • all：表示查询上述所有类型的待处理事件详情
说明 当Region设置为all时，TaskType也必须设置为all。
IsHistory Integer 否 0

是否返回历史任务，取值范围如下：

  • 0：返回当前任务
  • 1：返回历史任务

默认取值为0。

PageSize Integer 否 30

每页记录数，取值为30、50或100。

默认值为30。

PageNumber Integer 否 1

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

返回数据

名称 类型 示例值 描述
TotalRecordCount Integer 1

总记录数。
RequestId String 2F029645-FED9-4FE8-A6D3-488954******

请求ID。
PageSize Integer 30

每页记录数。
PageNumber Integer 1

页码。
Items Array of Items

任务列表。
Status Integer 3

任务状态。

  • 若您设置IsHistory为0，则返回待处理任务状态的详情，取值范围如下：
    • 2：等待用户设置任务开始时间
    • 3：等待处理
    • 4：任务正在处理中（不支持在该状态下修改任务执行时间）
  • 若您设置IsHistory为1，则返回历史任务状态的详情，取值范围如下：
    • 5：任务结束且执行成功
    • 6：任务结束但执行失败
    • 7：任务已取消
PrepareInterval String 04:00:00

待处理事件切换之前所需的准备时间，格式为HH:mm:ss。

Deadline String 2020-06-11T15:59:59Z

任务执行时间可调整范围的最晚期限，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

DBType String MySQL

数据库引擎类型，取值范围如下：

  • MySQL
  • PostgreSQL
  • Oracle
TaskType String DatabaseSoftwareUpgrading

待处理事件的任务类型。
StartTime String 2020-06-09T18:00:00Z

后台执行该任务的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

DBVersion String 8.0

数据库引擎版本号。

  • MySQL版本号取值范围如下：
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL版本号取值为11。
  • Oracle版本号取值为11。
ModifiedTime String 2020-06-09T22:00:42Z

修改时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

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

集群ID。
Region String cn-hangzhou

任务所在地域的地域ID。
ResultInfo String manualCancel

任务执行结果，取值范围如下：

  • manualCancel：手动取消任务
  • paramCheckNotPass：参数检查未通过
说明 仅当Status（任务状态）取值为6（任务结束但执行失败）或7（任务已取消）时，返回该参数。
CreatedTime String 2020-06-09T22:00:42Z

创建任务的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

Id Integer 111111

目标任务ID。
SwitchTime String 2020-06-09T22:00:00Z

待处理事件预计的切换时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

示例

请求示例

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

正常返回示例

XML格式 

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

<DescribePendingMaintenanceActionResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageSize>30</PageSize>
<RequestId>2F029645-FED9-4FE8-A6D3-488954******</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <Status>3</Status>
    <CreatedTime>2020-06-09T22:00:42Z</CreatedTime>
    <Deadline>2020-06-11T15:59:59Z</Deadline>
    <StartTime>2020-06-09T18:00:00Z</StartTime>
    <DBClusterId>pc-************</DBClusterId>
    <DBType>MySQL</DBType>
    <DBVersion>8.0</DBVersion>
    <ModifiedTime>2020-06-09T22:00:42Z</ModifiedTime>
    <TaskType>DatabaseSoftwareUpgrading</TaskType>
    <Region>cn-hangzhou</Region>
    <PrepareInterval>04:00:00</PrepareInterval>
    <Id>111111</Id>
    <SwitchTime>2020-06-09T22:00:00Z</SwitchTime>
</Items>
</DescribePendingMaintenanceActionResponse>

JSON格式 

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

{
  "TotalRecordCount" : "1",
  "PageSize" : "30",
  "RequestId" : "2F029645-FED9-4FE8-A6D3-488954******",
  "PageNumber" : "1",
  "Items" : [ {
    "Status" : "3",
    "CreatedTime" : "2020-06-09T22:00:42Z",
    "Deadline" : "2020-06-11T15:59:59Z",
    "StartTime" : "2020-06-09T18:00:00Z",
    "DBClusterId" : "pc-************",
    "DBType" : "MySQL",
    "DBVersion" : "8.0",
    "ModifiedTime" : "2020-06-09T22:00:42Z",
    "TaskType" : "DatabaseSoftwareUpgrading",
    "Region" : "cn-hangzhou",
    "PrepareInterval" : "04:00:00",
    "Id" : "111111",
    "SwitchTime" : "2020-06-09T22:00:00Z"
  } ]
}

错误码

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