UpgradeDBInstanceMajorVersion - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

RDS PostgreSQL インスタンスのメジャーバージョンアップグレードを開始します。

操作説明

サポート対象エンジン

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	任意	インスタンスの新しいインスタンスタイプ。新しいインスタンスタイプは、ソースインスタンス以上の CPU とメモリを持つ必要があります。このパラメーターは、`UpgradeMode` が `inPlaceUpgrade` または `zeroDownTimeUpgrade` に設定されている場合は不要です。例えば、ソースインスタンスのインスタンスタイプが 1 vCPU と 2 GB のメモリを提供する `pg.n2.small.2c` である場合、2 vCPU と 4 GB のメモリを提供する `pg.n2.medium.2c` にアップグレードできます。説明 ApsaraDB RDS for PostgreSQL のインスタンスタイプの詳細については、「プライマリ ApsaraDB RDS for PostgreSQL インスタンスタイプ」をご参照ください。	pg.n2.medium.2c
DBInstanceStorage	integer	任意	インスタンスの新しいストレージ容量。単位：GB。このパラメーターは、`UpgradeMode` が `inPlaceUpgrade` または `zeroDownTimeUpgrade` に設定されている場合は不要です。有効な値： ESSD PL1 クラウドディスク：20～3,200 ESSD PL2 クラウドディスク：500～3,200 ESSD PL3 クラウドディスク：1,500～3,200 Ultra ディスク：40～2,000 説明パフォーマンス専有型ローカルディスクを使用するインスタンスをアップグレードする際に、ストレージ容量を削減できます。最小限必要なストレージ容量の詳細については、「ApsaraDB RDS for PostgreSQL インスタンスのメジャーエンジンバージョンをアップグレードする」をご参照ください。	20
PayType	string	必須	課金方法。値は `Postpaid` に固定されており、従量課金方式を指定します。説明アップグレード後にインスタンスの課金方法を変更するには、「従量課金インスタンスをサブスクリプションインスタンスに変換する」をご参照ください。	Postpaid
InstanceNetworkType	string	任意	インスタンスの新しいネットワークタイプ。このパラメーターは `VPC` に固定されています。このアップグレードは、VPC 内のインスタンスでのみサポートされます。ご利用のインスタンスがクラシックネットワークにある場合は、まずネットワークタイプを VPC に変更する必要があります。ネットワークタイプの表示または変更方法の詳細については、「ApsaraDB RDS for PostgreSQL インスタンスのネットワークタイプを変更する」をご参照ください。	VPC
SwitchTimeMode	string	任意	スイッチオーバーを実行するタイミングを指定します。このパラメーターは、`SwitchOver` が `true` に設定されている場合にのみ適用されます。有効な値： 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。このパラメーターは、`UpgradeMode` が `inPlaceUpgrade` または `zeroDownTimeUpgrade` に設定されている場合は不要です。ソースインスタンスの VPC ID をクエリするには、`DescribeDBInstanceAttribute` オペレーションを呼び出します。	vpc-bp1opxu1zkhn00gzv****
VSwitchId	string	任意	ターゲットインスタンスの VSwitch の ID。このパラメーターは、`UpgradeMode` が `inPlaceUpgrade` または `zeroDownTimeUpgrade` に設定されている場合は不要です。ソースインスタンスが Basic Edition インスタンスの場合は、ターゲットインスタンスの VSwitch ID を指定します。ソースインスタンスが High-availability Edition インスタンスの場合は、プライマリインスタンスとセカンダリインスタンスの VSwitch ID を指定できます。ID はコンマ (,) で区切ります。説明指定する VSwitch は、ソースインスタンスと同じゾーンにある必要があります。VSwitch ID をクエリするには、`DescribeVSwitches` オペレーションを呼び出します。	vsw-bp10aqj6o4lclxdrm**,vsw-bp10aqj6o4lclxdrm**
PrivateIpAddress	string	任意	ターゲットインスタンスのプライベート IP アドレス。システムが指定された `VPCId` と `VSwitchId` に基づいて IP アドレスを自動的に割り当てるため、このパラメーターを設定する必要はありません。	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。このパラメーターは、`UpgradeMode` が `inPlaceUpgrade` または `zeroDownTimeUpgrade` に設定されている場合は不要です。ゾーン ID をクエリするには、`DescribeRegions` オペレーションを呼び出します。 ApsaraDB RDS for PostgreSQL では、アップグレードの一環として、新しいインスタンスを同じリージョン内の別のゾーンに配置できます。	cn-hangzhou-j
ZoneIdSlave1	string	任意	ターゲットセカンダリゾーンの ID。このパラメーターは High-availability Edition インスタンスにのみ適用され、`UpgradeMode` が `inPlaceUpgrade` または `zeroDownTimeUpgrade` に設定されている場合は不要です。 ApsaraDB RDS for PostgreSQL では、アップグレードの一環として、新しいセカンダリインスタンスを同じリージョン内の別のゾーンに配置できます。ゾーン ID をクエリするには、`DescribeRegions` オペレーションを呼び出します。	cn-hangzhou-j
ZoneIdSlave2	string	任意	予約済み。このパラメーターは設定しないでください。	cn-hangzhou-j
UpgradeMode	string	任意	アップグレードモード。このパラメーターは、`SwitchOver` が `true` に設定されている場合に必要です。有効な値： 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.

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

変更履歴

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

ApsaraDB RDS:UpgradeDBInstanceMajorVersion