DescribeUpgradeMajorVersionPrecheckTask - 获取升级主版本预检查任务

查询RDS PostgreSQL大版本升级检查报告。

接口说明

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

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeUpgradeMajorVersionPrecheckTask	Read	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	RDS PostgreSQL实例ID。	pgm-bp1c808s731l****
PageSize	integer	否	表示大版本升级前检查报告每页显示的记录数。取值范围： 30（默认值） 50 100	30
PageNumber	integer	否	表示显示升级前检查报告的页码。取值范围：大于0且不超过Integer的最大值。默认值：1。	1
TargetMajorVersion	string	否	目标实例版本。必须大于当前实例版本。例如：当前实例版本为PostgreSQL 10.0，则目标版本可选择11.0、12.0、13.0、14.0或15.0。	12.0
TaskId	integer	否	升级前检查任务ID，调用UpgradeDBInstanceMajorVersionPrecheck接口执行升级前检查后，从返回参数TaskId中获取。	416980000

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	D1586777-41B5-5F9E-81E8-93DFDD379024
PageNumber	integer	页码。	1
PageRecordCount	integer	每页显示记录数。	30
TotalRecordCount	integer	升级检查报告记录数。	1
Items	array	大版本升级检查报告属性列表。
	object
TargetMajorVersion	string	目标实例版本。	12.0
EffectiveTime	string	检查报告到期时间。以Unix时间戳表示。单位：毫秒。	1635748703000
SourceMajorVersion	string	当前实例版本。	11.0
Result	string	大版本升级检查的检查结果。取值范围： Success：成功 Fail：失败说明当检查结果为Fail时，请排查Detail的参数取值，处理报错后再试，常见报错及处理方法，请参见解读RDS PostgreSQL大版本升级检查报告。	Success
TaskId	integer	大版本升级前检查任务ID。	416980000
Detail	string	大版本升级检查报告内容。	[user_check_report]User check success\n[pg_upgrade_internal.log]Performing...
CheckTime	string	检查时间。以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	错误码	错误信息	描述
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	数据库实例名称不存在，请检查。

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