DescribeUpgradeMajorVersionPrecheckTask操作を呼び出して、ApsaraDB RDS for PostgreSQLインスタンスへのメジャーエンジンバージョンアップのチェックレポートを照会できます。

ApsaraDB RDS for PostgreSQLインスタンスのメジャーエンジンバージョンをアップグレードする前に、アップグレードチェックを実行し、チェック結果がSuccessであることを確認する必要があります。 この操作では、アップグレードチェックレポートを照会します。

チェック結果がFailの場合、発生したエラーを処理する必要があります。 一般的なエラーを処理する方法の詳細については、「ApsaraDB RDS For PostgreSQLインスタンスへのメジャーエンジンバージョンアップのチェックレポートの概要」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 DescribeUpgradeMajorVersionPrecheckTask

実行する操作です。 値をDescribeUpgradeMajorVersionPrecheckTaskに設定します。

DBInstanceId String 必須 pgm-bp1c808s731l ****

インスタンスの ID です。

PageSize Integer いいえ 30

アップグレードチェックレポートの各ページで返されるエントリの数。

有効な値：

  • 30 (これはデフォルト値です) 。
  • 50
  • 100
PageNumber Integer いいえ 1

アップグレードチェックレポートで返されるページの番号。

有効値：0 以外の正の整数。 デフォルト値：1

TargetMajorVersion String 任意 12.0

インスタンスの新しいメジャーエンジンバージョン。 新しいメジャーエンジンバージョンは、元のメジャーエンジンバージョンよりも後でなければなりません。

たとえば、元のメジャーエンジンのバージョンがPostgreSQL 9.4の場合、新しいメジャーエンジンのバージョンはPostgreSQL 10、PostgreSQL 11、PostgreSQL 12、またはPostgreSQL 13です。

TaskId Integer いいえ 416980000

アップグレードチェックタスクのID。 アップグレードチェックタスクのIDは、UpgradeDBInstanceMajorVersionPrecheck操作の呼び出しから返されるTaskIdパラメーターから取得できます。

レスポンスパラメーター

項目 データ型 例: 説明　
項目 タスクの配列

アップグレードチェックレポートの属性で構成される配列。

チェックタイム String 1635143903000

アップグレードチェックが実行された時刻。

このパラメーターの値は、UNIX時間形式に従うタイムスタンプです。 単位：ミリ秒。

詳細 String [user_check_report] ユーザーチェック成功 \n[pg_upgrade_internal.log] 実行中...

アップグレードチェックレポートの内容。

EffectiveTime String 1635748703000

アップグレードチェックレポートの有効期限。

このパラメーターの値は、UNIX時間形式に従うタイムスタンプです。 単位：ミリ秒。

結果 String 成功

アップグレードチェックの結果。

有効な値：

  • 成功
  • Fail
説明 チェック結果がFailの場合、Detailパラメーターの値をチェックして、発生したエラーに関する情報を取得する必要があります。 エラーを処理したら、もう一度試すことができます。 一般的なエラーを処理する方法の詳細については、「ApsaraDB RDS For PostgreSQLインスタンスへのメジャーエンジンバージョンアップのチェックレポートの概要」をご参照ください。
SourceMajorVersion String 11.0

インスタンスの元のメジャーエンジンバージョン。

TargetMajorVersion String 12.0

インスタンスの新しいメジャーエンジンバージョン。

TaskId Integer 416980000

アップグレードチェックタスクのID。

PageNumber Integer 1

返されたページ数。

PageRecordCount Integer 30

1 ページあたりで返されるエントリ数。

RequestId String D1586777-41B5-5F9E-81E8-93DFDD379024

リクエストの ID です。

TotalRecordCount Integer 1

アップグレードチェックレポートのエントリの総数。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeUpgradeMajorVersionPrecheckTask
&DBInstanceId=pgm-bp1c808s731l ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

<DescribeUpgradeMajorVersionPrecheckTask>
      <TotalRecordCount>1</TotalRecordCount>
      <PageRecordCount>30</PageRecordCount>
      <RequestId>D1586777-41B5-5F9E-81E8-93DFDD379024</RequestId>
      <ページ番号> 1 </ PAGENUMBER>
      <Items>
            <CheckTime>1635143903000</CheckTime>
            <SourceMajorVersion>11.0</SourceMajorVersion>
            <TaskId>416980000</TaskId>
            <EffectiveTime>1635748703000</EffectiveTime>
            <TargetMajorVersion>12.0</TargetMajorVersion>
            <Detail>[user_check_report] ユーザーチェック成功 \n[pg_upgrade_internal.log] 実行中...</Detail>
            <結果> 成功 </結果>
      </アイテム>
</DescribeUpgradeMajorVersionPrecheckTask>

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] ユーザーチェック成功 \\n[pg_upgrade_internal.log]Performing..." 、
        "結果": "成功"
    }
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidDBInstanceName.NotFound 指定された DB インスタンス名は存在しません。 インスタンスの名前が見つからない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。