この API は、RDS PostgreSQL インスタンスのメジャーバージョンアップを開始します。
操作説明
対応エンジン
RDS PostgreSQL
関連ドキュメント
この API オペレーションは有料です。この API を呼び出す前に、関連ドキュメントを読み、関連する料金、前提条件、および影響を理解してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rds:UpgradeDBInstanceMajorVersion |
update |
*DBInstance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DBInstanceClass |
string |
任意 |
ターゲットインスタンスのインスタンスタイプ。vCPU とメモリの仕様は、元のインスタンスの仕様以上である必要があります。UpgradeMode が inPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません。 たとえば、元のインスタンスタイプ 説明
ApsaraDB RDS for PostgreSQL でサポートされているインスタンスタイプのリストについては、「プライマリ ApsaraDB RDS for PostgreSQL インスタンスタイプ」をご参照ください。 |
pg.n2.medium.2c |
| DBInstanceStorage |
integer |
任意 |
ターゲットインスタンスのストレージ容量。単位:GB。UpgradeMode が inPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません。 有効値:
説明
パフォーマンス専有型ローカルディスクを使用するインスタンスをアップグレードする際に、ストレージ容量を削減できます。最小ストレージ容量の詳細については、「ApsaraDB RDS for PostgreSQL インスタンスのメジャーエンジンバージョンをアップグレードする」をご参照ください。 |
20 |
| PayType |
string |
必須 |
課金方法。値は 説明
アップグレード後にインスタンスの課金方法を変更するには、「インスタンスの課金方法を従量課金からサブスクリプションに変更する」をご参照ください。 |
Postpaid |
| InstanceNetworkType |
string |
任意 |
ターゲットインスタンスのネットワークタイプ。値は ご利用のインスタンスがクラシックネットワークを使用している場合は、まずネットワークタイプを VPC に切り替える必要があります。ネットワークタイプの表示または切り替え方法については、「ApsaraDB RDS for PostgreSQL インスタンスのネットワークタイプを変更する」をご参照ください。 |
VPC |
| SwitchTimeMode |
string |
任意 |
切り替え時間。このパラメーターは SwitchOver が true に設定されている場合にのみ有効です。 有効値:
|
Immediate |
| SwitchTime |
string |
任意 |
これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。 |
2021-07-10T13:15:12Z |
| SwitchOver |
string |
任意 |
アップグレード後にワークロードをターゲットインスタンスに切り替えるかどうかを指定します。 有効値:
説明
|
false |
| CollectStatMode |
string |
任意 |
データベースの統計情報収集をいつ実行するかを指定します。
説明
切り替えなしのアップグレードでは、Before はターゲットインスタンスが稼働する前に統計情報が収集されることを意味し、After は稼働後に収集されることを意味します。 |
After |
| TargetMajorVersion |
string |
任意 |
インスタンスのターゲットメジャーエンジンバージョン。このパラメーターの値は、事前チェックで指定されたターゲットバージョンと一致する必要があります。 説明
UpgradeDBInstanceMajorVersionPrecheck 操作を呼び出して、メジャーバージョンアップの事前チェックを行うことができます。 |
13.0 |
| DBInstanceId |
string |
任意 |
元のインスタンスの ID。 |
pgm-bp1gm3yh0ht1**** |
| VPCId |
string |
任意 |
VPC ID。UpgradeMode が inPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません。 DescribeDBInstanceAttribute 操作を呼び出して、元のインスタンスの VPC ID を表示できます。 |
vpc-bp1opxu1zkhn00gzv**** |
| VSwitchId |
string |
任意 |
ターゲットインスタンスの vSwitch ID。UpgradeMode が inPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません。
説明
ターゲットインスタンスの vSwitch は、元のインスタンスと同じゾーンにある必要があります。DescribeVSwitches 操作を呼び出して vSwitch ID をクエリできます。 |
vsw-bp10aqj6o4lclxdrm****,vsw-bp10aqj6o4lclxdrm**** |
| PrivateIpAddress |
string |
任意 |
ターゲットインスタンスのプライベート IP アドレス。システムが指定された |
172.16.XX.XX |
| UsedTime |
string |
任意 |
これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。 |
1 |
| Period |
string |
任意 |
これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。 |
Month |
| DBInstanceStorageType |
string |
任意 |
ターゲットインスタンスのストレージタイプ。 有効値:
メジャーバージョンアップ機能はスナップショットに基づいています。ターゲットインスタンスで選択できるストレージタイプは、元のインスタンスのストレージタイプによって異なります。
|
cloud_essd |
| ZoneId |
string |
任意 |
ターゲットインスタンスのプライマリゾーン ID。UpgradeMode が inPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません。 DescribeRegions 操作を呼び出してゾーン ID をクエリできます。 ターゲットインスタンスは、同じリージョン内であれば、元のインスタンスとは異なるゾーンにデプロイできます。 |
cn-hangzhou-j |
| ZoneIdSlave1 |
string |
任意 |
ターゲットインスタンスのセカンダリゾーン ID。このパラメーターは、元のインスタンスが RDS High-availability Edition を実行している場合にのみ使用できます。UpgradeMode が inPlaceUpgrade または zeroDownTimeUpgrade に設定されている場合、このパラメーターを指定する必要はありません。 ターゲットインスタンスのセカンダリインスタンスは、同じリージョン内であれば、元のインスタンスとは異なるゾーンにデプロイできます。 DescribeRegions 操作を呼び出してゾーン ID をクエリできます。 |
cn-hangzhou-j |
| ZoneIdSlave2 |
string |
任意 |
これは予約済みのパラメーターです。このパラメーターを指定する必要はありません。 |
cn-hangzhou-j |
| UpgradeMode |
string |
任意 |
アップグレードモード。SwitchOver が true に設定されている場合、このパラメーターを指定する必要があります。有効値:
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。