调用DescribeUpgradeMajorVersionPrecheckTask接口查询RDS PostgreSQL大版本升级检查报告。

RDS PostgreSQL实例执行大版本升级前，大版本升级检查结果必须为Success，调用该接口可以查询大版本升级检查报告。

当检查结果为Fail时，需要对升级检查报告中的报错进行处理，常见报错及处理方法，请参见解读RDS PostgreSQL大版本升级检查报告。

调试

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

请求参数

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

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

DBInstanceId String 是 pgm-bp1c808s731l****

RDS PostgreSQL实例ID。
PageSize Integer 否 30

表示大版本升级前检查报告每页显示的记录数。

取值范围：

  • 30（默认值）
  • 50
  • 100
PageNumber Integer 否 1

表示显示升级前检查报告的页码。

取值范围：大于0且不超过Integer的最大值。默认值：1。
TargetMajorVersion String 否 12.0

目标实例版本。必须大于当前实例版本。

例如：当前实例版本为PostgreSQL 10.0，则目标版本可选择11.0、12.0、13.0、14.0或15.0。
TaskId Integer 否 416980000

升级前检查任务ID，调用UpgradeDBInstanceMajorVersionPrecheck接口执行升级前检查后，从返回参数TaskId中获取。

返回数据

名称 类型 示例值 描述
RequestId String D1586777-41B5-5F9E-81E8-93DFDD379024

请求ID。
PageNumber Integer 1

页码。
PageRecordCount Integer 30

每页显示记录数。
TotalRecordCount Integer 1

升级检查报告记录数。
Items Array of Tasks

大版本升级检查报告属性列表。
TargetMajorVersion String 12.0

目标实例版本。
EffectiveTime String 1635748703000

检查报告到期时间。

以Unix时间戳表示。单位：毫秒。
SourceMajorVersion String 11.0

当前实例版本。
Result String Success

大版本升级检查的检查结果。

取值范围：

  • Success：成功
  • Fail：失败
说明 当检查结果为Fail时，请排查Detail的参数取值，处理报错后再试，常见报错及处理方法，请参见解读RDS PostgreSQL大版本升级检查报告。
TaskId Integer 416980000

大版本升级前检查任务ID。
Detail String [user_check_report]User check success\n[pg_upgrade_internal.log]Performing...

大版本升级检查报告内容。
CheckTime String 1635143903000

检查时间。

以Unix时间戳表示。单位：毫秒。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeUpgradeMajorVersionPrecheckTask
&DBInstanceId=pgm-bp1c808s731l****
&<公共请求参数>

正常返回示例

XML格式 

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

<DescribeUpgradeMajorVersionPrecheckTask>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>D1586777-41B5-5F9E-81E8-93DFDD379024</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <CheckTime>1635143903000</CheckTime>
        <SourceMajorVersion>11.0</SourceMajorVersion>
        <TaskId>416980000</TaskId>
        <EffectiveTime>1635748703000</EffectiveTime>
        <TargetMajorVersion>12.0</TargetMajorVersion>
        <Detail>[user_check_report]User check success\n[pg_upgrade_internal.log]Performing...</Detail>
        <Result>Success</Result>
    </Items>
</DescribeUpgradeMajorVersionPrecheckTask>

JSON格式 

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

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 30,
  "RequestId" : "D1586777-41B5-5F9E-81E8-93DFDD379024",
  "PageNumber" : 1,
  "Items" : {
    "CheckTime" : 1635143903000,
    "SourceMajorVersion" : 11.0,
    "TaskId" : 416980000,
    "EffectiveTime" : 1635748703000,
    "TargetMajorVersion" : 12.0,
    "Detail" : "[user_check_report]User check success\\n[pg_upgrade_internal.log]Performing...",
    "Result" : "Success"
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBInstanceName.NotFound The specified DB instance name does not exist. 数据库实例名称不存在，请检查。

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