全部产品
Search
文档中心

云数据库 RDS:DescribeUpgradeMajorVersionPrecheckTask - 查询RDS PostgreSQL大版本升级检查报告

更新时间:Mar 13, 2024

该接口用于查询RDS PostgreSQL大版本升级前检查的检查报告。

接口说明

适用引擎

RDS PostgreSQL

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeUpgradeMajorVersionPrecheckTaskRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

pgm-bp1c808s731l****
PageSizeinteger

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

取值范围:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

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

取值范围:大于 0 且不超过 Integer 的最大值。默认值:1。

1
TargetMajorVersionstring

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

12.0
TaskIdinteger

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

416980000

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

D1586777-41B5-5F9E-81E8-93DFDD379024
PageNumberinteger

页码。

1
PageRecordCountinteger

每页显示记录数。

30
TotalRecordCountinteger

升级检查报告记录数。

1
Itemsobject []

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

TargetMajorVersionstring

目标实例版本。

12.0
EffectiveTimestring

检查报告到期时间。

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

1635748703000
SourceMajorVersionstring

当前实例版本。

11.0
Resultstring

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

取值范围:

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

大版本升级前检查任务 ID。

416980000
Detailstring

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

[user_check_report]User check success\n[pg_upgrade_internal.log]Performing...
CheckTimestring

检查时间。

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

1635143903000

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.数据库实例名称不存在,请检查。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

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