文档

DescribePendingMaintenanceAction - 查询待处理事件的详情

更新时间:

查询待处理事件的详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Regionstring

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

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

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

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

    是否返回历史任务,取值范围如下:

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

    默认取值为 0

    0
    PageSizeinteger

    每页记录数,取值为 3050100

    默认值为 30

    30
    PageNumberinteger

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

    1
    ResourceGroupIdstring

    资源组 ID。

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

    返回参数

    名称类型描述示例值
    object
    TotalRecordCountinteger

    总记录数。

    1
    RequestIdstring

    请求 ID。

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

    每页记录数。

    30
    PageNumberinteger

    页码。

    1
    Itemsobject []

    任务列表。

    Statusinteger

    任务状态。

    • 若您设置IsHistory0,则返回待处理任务状态的详情,取值范围如下:

      • 2:等待用户设置任务开始时间
      • 3:等待处理
      • 4:任务正在处理中(不支持在该状态下修改任务执行时间)
    • 若您设置IsHistory1,则返回历史任务状态的详情,取值范围如下:

      • 5:任务结束且执行成功
      • 6:任务结束但执行失败
      • 7:任务已取消
    3
    PrepareIntervalstring

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

    04:00:00
    Deadlinestring

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

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

    数据库引擎类型,取值范围如下:

    • MySQL
    • PostgreSQL
    • Oracle
    MySQL
    TaskTypestring

    待处理事件的任务类型。

    DatabaseSoftwareUpgrading
    StartTimestring

    后台执行该任务的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

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

    数据库引擎版本号。

    • MySQL 版本号取值范围如下:
      • 5.6
      • 5.7
      • 8.0
    • PostgreSQL 版本号取值范围如下:
      • 11
      • 14
    • Oracle 版本号取值范围如下:
      • 11
      • 14
    8.0
    ModifiedTimestring

    修改时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

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

    集群 ID。

    pc-************
    Regionstring

    任务所在地域的地域 ID。

    cn-hangzhou
    ResultInfostring

    任务执行结果,取值范围如下:

    • manualCancel:手动取消任务
    • paramCheckNotPass:参数检查未通过
    说明 仅当Status(任务状态)取值为 6(任务结束但执行失败)或 7(任务已取消)时,返回该参数。
    manualCancel
    CreatedTimestring

    创建任务的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

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

    目标任务 ID。

    111111
    SwitchTimestring

    待处理事件预计的切换时间,格式为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错误码错误信息描述
    400RequiredParam.NotFoundRequired input param is not found.所需的输入参数不存在。

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

    • 本页导读 (0)
    文档反馈