全部产品
Search

搜索本产品

    云原生数据库 PolarDB：DescribePendingMaintenanceAction - 查询待处理事件的详情

    文档中心

    云原生数据库 PolarDB：DescribePendingMaintenanceAction - 查询待处理事件的详情

    更新时间：Aug 27, 2026

    查询待处理事件的详情。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    polardb:DescribePendingMaintenanceAction

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Region

    string

    是

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

    说明

    • 您可以输入 all 查看您账户下所有的待处理事件。

    • 当Region设置为 all 时，TaskType也必须设置为 all。

    all
    TaskType

    string

    是

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

    • DatabaseSoftwareUpgrading：数据库软件升级

    • DatabaseHardwareMaintenance：硬件维护与升级

    • DatabaseStorageUpgrading：数据库存储升级

    • DatabaseProxyUpgrading：代理小版本升级

    • all：表示查询上述所有类型的待处理事件详情

    说明

    当Region设置为 all 时，TaskType也必须设置为 all。

    all
    IsHistory

    integer

    否

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

    • 0：返回当前任务

    • 1：返回历史任务

    默认取值为 0。

    0
    PageSize

    integer

    否

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

    默认值为 30。

    30
    PageNumber

    integer

    否

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

    1
    ResourceGroupId

    string

    否

    资源组 ID。

    rg-************

    返回参数

    名称

    类型

    描述

    示例值

    object

    TotalRecordCount

    integer

    总记录数。

    1
    RequestId

    string

    请求 ID。

    2F029645-FED9-4FE8-A6D3-488954******
    PageSize

    integer

    每页记录数。

    30
    PageNumber

    integer

    页码。

    1
    Items

    array<object>

    任务列表。

    object

    Status

    integer

    任务状态。

    • 若您设置IsHistory为 0，则返回待处理任务状态的详情，取值范围如下：

      • 2：等待用户设置任务开始时间

      • 3：等待处理

      • 4：任务正在处理中（不支持在该状态下修改任务执行时间）

    • 若您设置IsHistory为 1，则返回历史任务状态的详情，取值范围如下：

      • 5：任务结束且执行成功

      • 6：任务结束但执行失败

      • 7：任务已取消

    3
    PrepareInterval

    string

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

    04:00:00
    Deadline

    string

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

    2020-06-11T15:59:59Z
    DBType

    string

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

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    TaskType

    string

    待处理事件的任务类型。

    DatabaseSoftwareUpgrading
    StartTime

    string

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

    2020-06-09T18:00:00Z
    DBVersion

    string

    数据库引擎版本号。

    • MySQL 版本号取值范围如下：

      • 5.6

      • 5.7

      • 8.0

    • PostgreSQL 版本号取值范围如下：

      • 11

      • 14

    • Oracle 版本号取值范围如下：

      • 11

      • 14

    8.0
    ModifiedTime

    string

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

    2020-06-09T22:00:42Z
    DBClusterId

    string

    集群 ID。

    pc-************
    Region

    string

    任务所在地域的地域 ID。

    cn-hangzhou
    ResultInfo

    string

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

    • manualCancel：手动取消任务

    • paramCheckNotPass：参数检查未通过

    说明

    仅当Status（任务状态）取值为 6（任务结束但执行失败）或 7（任务已取消）时，返回该参数。

    manualCancel
    CreatedTime

    string

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

    2020-06-09T22:00:42Z
    Id

    integer

    目标任务 ID。

    111111
    SwitchTime

    string

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

    2020-06-09T22:00:00Z

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 RequiredParam.NotFound Required input param is not found. 所需的输入参数不存在。

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

    变更历史

    更多信息，参考变更详情。