すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB RDS:UpgradeDBInstanceMajorVersion

最終更新日:Apr 18, 2026

この API は、RDS PostgreSQL インスタンスのメジャーバージョンアップを開始します。

操作説明

対応エンジン

RDS PostgreSQL

関連ドキュメント

この API オペレーションは有料です。この API を呼び出す前に、関連ドキュメントを読み、関連する料金、前提条件、および影響を理解してください。

RDS PostgreSQL インスタンスのメジャーデータベースバージョンのアップグレード

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:UpgradeDBInstanceMajorVersion

update

*DBInstance

acs:rds:*:{#accountId}:dbinstance/{#DBInstanceId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBInstanceClass

string

任意

ターゲットインスタンスのインスタンスタイプ。vCPU とメモリの仕様は、元のインスタンスの仕様以上である必要があります。UpgradeModeinPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません

たとえば、元のインスタンスタイプ pg.n2.small.2c が 1 vCPU と 2 GB のメモリを持つ場合、2 vCPU と 4 GB のメモリを持つ pg.n2.medium.2c にアップグレードできます。

説明

ApsaraDB RDS for PostgreSQL でサポートされているインスタンスタイプのリストについては、「プライマリ ApsaraDB RDS for PostgreSQL インスタンスタイプ」をご参照ください。

pg.n2.medium.2c

DBInstanceStorage

integer

任意

ターゲットインスタンスのストレージ容量。単位:GB。UpgradeModeinPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません

有効値:

  • ESSD PL1 クラウドディスク:20~3200

  • ESSD PL2 クラウドディスク:500~3200

  • ESSD PL3 クラウドディスク:1500~3200

  • Ultra ディスク:40~2000

説明

パフォーマンス専有型ローカルディスクを使用するインスタンスをアップグレードする際に、ストレージ容量を削減できます。最小ストレージ容量の詳細については、「ApsaraDB RDS for PostgreSQL インスタンスのメジャーエンジンバージョンをアップグレードする」をご参照ください。

20

PayType

string

必須

課金方法。値は Postpaid (従量課金) である必要があります。

説明

アップグレード後にインスタンスの課金方法を変更するには、「インスタンスの課金方法を従量課金からサブスクリプションに変更する」をご参照ください。

Postpaid

InstanceNetworkType

string

任意

ターゲットインスタンスのネットワークタイプ。値は VPC である必要があります。メジャーバージョンアップは VPC 内のインスタンスでのみサポートされています。

ご利用のインスタンスがクラシックネットワークを使用している場合は、まずネットワークタイプを VPC に切り替える必要があります。ネットワークタイプの表示または切り替え方法については、「ApsaraDB RDS for PostgreSQL インスタンスのネットワークタイプを変更する」をご参照ください。

VPC

SwitchTimeMode

string

任意

切り替え時間。このパラメーターは SwitchOvertrue に設定されている場合にのみ有効です。

有効値:

  • Immediate:切り替えはすぐに実行されます。

  • MaintainTime:切り替えは指定されたメンテナンスウィンドウ内で実行されます。ModifyDBInstanceMaintainTime 操作を呼び出してメンテナンスウィンドウを変更できます。

Immediate

SwitchTime

string

任意

これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。

2021-07-10T13:15:12Z

SwitchOver

string

任意

アップグレード後にワークロードをターゲットインスタンスに切り替えるかどうかを指定します。

有効値:

  • true:自動切り替えを実行します。このオプションは通常、新しいメジャーバージョンでワークロードが期待どおりに実行できることを確認した後の本番アップグレードに使用されます。

  • false:切り替えを実行しません。このオプションは通常、本番アップグレードの前に新しいメジャーバージョンとのワークロードの互換性をテストするために使用されます。

説明
  • 切り替えを実行する場合:
    • 切り替えは元に戻せません。慎重に進めてください。

    • 切り替え中、元のインスタンスは読み取り専用になり、書き込みリクエストを処理できなくなります。オフピーク時間に操作を実行することを推奨します。

    • 元のインスタンスに読み取り専用インスタンスがある場合、切り替えは実行できません。この場合、切り替えなしでアップグレードする必要があります。読み取り専用インスタンスはクローンされません。アップグレード後にターゲットインスタンス用に新しいものを作成する必要があります。

  • 切り替えを実行しない場合:

false

CollectStatMode

string

任意

データベースの統計情報収集をいつ実行するかを指定します。

  • Before:切り替え前に統計情報を収集します。この方法はワークロードの安定性を確保しますが、インスタンスに大量のデータが含まれている場合、アップグレード時間が長くなる可能性があります。

  • After:切り替え後に統計情報を収集します。この方法はインスタンスのアップグレードを高速化します。ただし、アップグレード後、統計情報が生成されていないテーブルに対するクエリは不正確な実行計画を使用する可能性があり、ピーク時にデータベースがクラッシュする原因となることがあります。

説明

切り替えなしのアップグレードでは、Before はターゲットインスタンスが稼働する前に統計情報が収集されることを意味し、After は稼働後に収集されることを意味します。

After

TargetMajorVersion

string

任意

インスタンスのターゲットメジャーエンジンバージョン。このパラメーターの値は、事前チェックで指定されたターゲットバージョンと一致する必要があります。

説明

UpgradeDBInstanceMajorVersionPrecheck 操作を呼び出して、メジャーバージョンアップの事前チェックを行うことができます。

13.0

DBInstanceId

string

任意

元のインスタンスの ID。

pgm-bp1gm3yh0ht1****

VPCId

string

任意

VPC ID。UpgradeModeinPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません

DescribeDBInstanceAttribute 操作を呼び出して、元のインスタンスの VPC ID を表示できます。

vpc-bp1opxu1zkhn00gzv****

VSwitchId

string

任意

ターゲットインスタンスの vSwitch ID。UpgradeModeinPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません

  • 元のインスタンスが RDS Basic Edition を実行している場合、ターゲットインスタンスの vSwitch ID を指定します。

  • 元のインスタンスが RDS High-availability Edition を実行している場合、ターゲットインスタンスのプライマリインスタンスとセカンダリインスタンスの vSwitch ID を指定できます。vSwitch ID はカンマ (,) で区切ります。

説明

ターゲットインスタンスの vSwitch は、元のインスタンスと同じゾーンにある必要があります。DescribeVSwitches 操作を呼び出して vSwitch ID をクエリできます。

vsw-bp10aqj6o4lclxdrm****,vsw-bp10aqj6o4lclxdrm****

PrivateIpAddress

string

任意

ターゲットインスタンスのプライベート IP アドレス。システムが指定された VPCIdVSwitchId に基づいて自動的に割り当てるため、このパラメーターを指定する必要はありません。

172.16.XX.XX

UsedTime

string

任意

これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。

1

Period

string

任意

これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。

Month

DBInstanceStorageType

string

任意

ターゲットインスタンスのストレージタイプ。

有効値:

  • cloud_ssd:SSD

  • cloud_essd:ESSD PL1

  • cloud_essd2:ESSD PL2

  • cloud_essd3:ESSD PL3

  • general_essd:Ultra ディスク

メジャーバージョンアップ機能はスナップショットに基づいています。ターゲットインスタンスで選択できるストレージタイプは、元のインスタンスのストレージタイプによって異なります。

  • 元のインスタンスが SSD クラウドディスクを使用している場合、SSD クラウドディスクのみを選択できます。

  • 元のインスタンスが ESSD クラウドディスクを使用している場合、ESSD PL1、ESSD PL2、ESSD PL3、または Ultra ディスクを選択できます。

  • 元のインスタンスがパフォーマンス専有型ローカルディスクを使用している場合、ESSD PL1、ESSD PL2、ESSD PL3、または Ultra ディスクを選択できます。

cloud_essd

ZoneId

string

任意

ターゲットインスタンスのプライマリゾーン ID。UpgradeModeinPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません

DescribeRegions 操作を呼び出してゾーン ID をクエリできます。

ターゲットインスタンスは、同じリージョン内であれば、元のインスタンスとは異なるゾーンにデプロイできます。

cn-hangzhou-j

ZoneIdSlave1

string

任意

ターゲットインスタンスのセカンダリゾーン ID。このパラメーターは、元のインスタンスが RDS High-availability Edition を実行している場合にのみ使用できます。UpgradeModeinPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません

ターゲットインスタンスのセカンダリインスタンスは、同じリージョン内であれば、元のインスタンスとは異なるゾーンにデプロイできます。

DescribeRegions 操作を呼び出してゾーン ID をクエリできます。

cn-hangzhou-j

ZoneIdSlave2

string

任意

これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。

cn-hangzhou-j

UpgradeMode

string

任意

アップグレードモード。SwitchOvertrue に設定されている場合、このパラメーターを指定する必要があります。有効値:

  • inPlaceUpgrade:新しいインスタンスを作成せずに、元のインスタンスでメジャーバージョンをアップグレードします。アップグレード後、元のインスタンスは新しいメジャーバージョンを実行し、元の注文、インスタンス名、タグ、CloudMonitor アラートルール、およびバックアップルールを保持します。

  • blueGreenDeployment:元のインスタンスを保持し、新しいメジャーバージョンで新しいインスタンスを作成します。新しいインスタンスは作成中は課金されませんが、アップグレード完了後は両方のインスタンスが課金されます。新しいインスタンスの課金方法は元のインスタンスと異なる場合があり、割引は継承されません。

  • zeroDownTimeUpgrade:ゼロダウンタイムアップグレードを実行します。システムは pg_upgrade を使用して元のインスタンスをターゲットバージョンにアップグレードし、増分更新にはネイティブの論理レプリケーションを使用します。アップグレードプロセスは手動切り替えをサポートし、切り替え前に新しいバージョンを検証できます。元のインスタンスは手動切り替えまで完全に稼働 (読み取り/書き込み) します。切り替え中、インスタンスは数秒間読み取り専用になります。

inPlaceUpgrade

CustomExtraInfo

string

任意

AllowDDL

boolean

任意

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

DBInstanceId

string

インスタンス ID。

pgm-bp1gm3yh0ht1****

OrderId

string

注文 ID。

21128667463****

RequestId

string

リクエスト ID。

006729E5-2A33-5955-89E3-651D3F44EBE6

TaskId

integer

予約済みのパラメーター。

416980000

成功レスポンス

JSONJSON

{
  "DBInstanceId": "pgm-bp1gm3yh0ht1****",
  "OrderId": "21128667463****",
  "RequestId": "006729E5-2A33-5955-89E3-651D3F44EBE6",
  "TaskId": 416980000
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidUpgradePrecheckResult The upgrade precheck failed. No successful precheck task found in the past 7 days
400 TargetEngineVersion.Parameters.NotFound targetEngineVersion is missing in the request.
400 InvalidDBInstanceStorageType The specified DBInstanceStorageType is invalid.
400 InvalidInstanceNetworkType The specified InstanceNetworkType is invalid.
400 InvalidVPCId The specified VPCId is invalid.
400 InvalidDedicatedHostGroupId The specified DedicatedHostGroupId is invalid.
400 InvalidPayType The specified PayType is invalid.
400 InvalidEngineVersion The specified EngineVersion is invalid.
400 InvalidDBInstanceStorage The specified DBInstanceStorage is invalid.
400 InvalidSwitchOver The specified SwitchOver is invalid.
400 PrimaryInstanceWithReadonlyNotSupport The specified primary instance with the read-only instance does not support the operation.
400 InvalidSwitchTimeMode The specified SwitchTimeMode is invalid.
400 InvalidSwitchTime The specified SwitchTime is invalid.
400 InvalidCollectStats The specified CollectStats is invalid.
400 IncorrectDBInstanceState The current instance state does not support this operation.
400 InvalidDBinstanceClass.ValueNotSupported The specified parameter DBinstanceClass is invalid.
400 InvalidUpgradeMode The Specified UpgradeMode is not valid.
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
400 Price.PricingPlanResultNotFound Pricing plan price result not found.
400 Order.NoRealNameAuthentication You 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.
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase.
400 CommodityServiceCalling.Exception Failed to call commodity service.
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again.
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400 Price.CommoditySys Commodity system call exception.
400 Pay.InsufficientBalance Insufficient available balance.
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again.
400 pay.noCreditCard Account not bound to credit card.
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method.
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation.
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details.
400 Api.NotSupport Specified api is not supported.
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance.
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records.
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400 KmsApiError User secret key invalid.
400 System.SaleValidateFailed Sales expression validation system error.
400 Abs.InvalidAccount.NotFound account is not found.
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s.
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled.
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled.
400 IncorrectTargetClasscode The current instance type does not support this operation.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS.
400 RequiredParam.NotFound Required input param is not found.
400 Parameters.Invalid Parameter error, please check the parameters.
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400 InvalideStatus.Format The instance status does not support this operation.
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid.
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation.
400 Pay.NoCreditCard No credit cards.
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation.
400 MirrorInsExists Specified DB instance mirror ins already existed.
400 UnsupportedClassCode The specified DB instance class stops selling.
400 InvalidBackupSet The specified database does not exist in the backup set.
400 OrdTCommodityQueryError Failed to query for product.
400 ProductInstanceReleased The instance has been released. Please check before placing the order.
400 RegionEndTimeDissolvedIndia The region is no longer supported.
400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect.
400 UpgradeModeNotSupport For instances with local SSD, this upgrade Mode is not allowed. For instances with cloud SSD, it is recommended to upgrade minor version at first.
500 InvalidUpgradeMode The Specified Parameter UpgradeMode is not valid.
500 ExternalFailure The request processing has failed due to external service failure.
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel.
500 InvokeProxyFailure The request processing has failed due to service failure of rds api.
403 OrderStatus.UnPaid The specified db instance has unpaid order.
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount.
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
403 InvalidUserOperatorPermission The user permission does not support this operation.
403 InvalidVswitchId Specified conn vswitch id is not valid.
403 IncorrectMinorVersion Current engine minor version does not support operations.
403 OperationDenied.ZoneResource There is no available zone for inventory.
403 NotInFlowController Sorry,no permission.
403 InvalidKmsKey Kms key is disabled.
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation.
404 InvalidDBInstanceName.NotFound The database instance does not exist.
404 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation.
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service.
404 Request.NotFound The requested resource is not available.
404 HostInfo.NotFound The specified host info is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。