UpgradeDBInstanceMajorVersion - 升級RDS PostgreSQL資料庫大版本 - ApsaraDB RDS

該介面用於發起RDS PostgreSQL執行個體大版本升級任務。

介面說明

適用引擎

RDS PostgreSQL

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:UpgradeDBInstanceMajorVersion

update

*DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceClass	string	否	升級後執行個體規格。CPU 和記憶體配置必須大於等於原執行個體規格。當 UpgradeMode（升級模式）取值為 inPlaceUpgrade 和 zeroDownTimeUpgrade 時，無需配置該參數。例如，原執行個體規格`pg.n2.small.2c`的 CPU 為 1 核，記憶體為 2GB，可升級為`pg.n2.medium.2c`，CPU 為 2 核，記憶體為 4 GB。說明 RDS PG 的執行個體規格代碼，請參見RDS PostgreSQL 主執行個體規格列表。	pg.n2.medium.2c
DBInstanceStorage	integer	否	升級後執行個體儲存空間。單位：GB。當 UpgradeMode（升級模式）取值為 inPlaceUpgrade 和 zeroDownTimeUpgrade 時，無需配置該參數。取值範圍： ESSD PL1 雲端硬碟：20 GB ~ 3200 GB ESSD PL2 雲端硬碟：500 GB ~ 3200 GB ESSD PL3 雲端硬碟：1500 GB ~ 3200 GB 高效能雲端硬碟：40 GB ~ 2000 GB 說明高效能本地碟執行個體升級大版本時，支援儲存空間縮容。可選擇的最小儲存空間，請參見升級資料庫大版本。	20
PayType	string	是	計費方式。固定配置為隨用隨付，取值 Postpaid。說明升級後如果需要變更執行個體的計費方式，請參見隨用隨付轉訂用帳戶。	Postpaid
InstanceNetworkType	string	否	升級後執行個體網路類型。固定配置為 VPC，當前只支援專用網路執行個體進行大版本升級。如果網路類型為傳統網路，請先切換為專用網路。關於如何查看或切換網路類型，請參見切換網路類型。	VPC
SwitchTimeMode	string	否	該參數與 SwitchOver 配合使用，只有 SwitchOver 參數取值為 true 時有效。表示割接時間。取值範圍： Immediate：立即生效。 MaintainTime：在可營運時間段內生效，可調用 ModifyDBInstanceMaintainTime 介面修改可營運時間段。	Immediate
SwitchTime	string	否	預留參數，無需配置。	2021-07-10T13:15:12Z
SwitchOver	string	否	割接配置，根據實際需求選擇是否將流量切換到新版本執行個體上。取值範圍： true：割接，自動切換。此選項一般用於在確認業務可以穩定運行在新版本之後執行正式升級。 false：不割接，不自動切換。此選項一般用於正式升級之前測試當前業務在新版本中的相容性。說明如果選擇了割接：割接後無法回退，請謹慎選擇。切換過程中，原執行個體會被變為唯讀，業務無法寫入，請務必在業務低峰期進行。如果原執行個體中建立了唯讀執行個體，則無法選擇割接。只能通過不割接升級執行個體，且原唯讀執行個體不會被複製。升級完成後，您需要在新版本執行個體中另行建立 PostgreSQL 唯讀執行個體。如果選擇了不割接：遷移過程中，原執行個體的業務不會受到影響。如需通過不割接升級執行個體，需在遷移完成後把應用程式中的資料庫連接地址改為新執行個體的串連地址。如何查看串連地址，請參見查看或修改內外網地址和連接埠。	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	否	目標執行個體交換器 ID。當 UpgradeMode（升級模式）取值為 inPlaceUpgrade 和 zeroDownTimeUpgrade 時時，無需配置該參數。當原執行個體為基礎系列執行個體時，配置目標執行個體交換器 ID。當原執行個體為高可用系列執行個體時，可以配置目標主備執行個體交換器 ID，使用英文逗號（,）分隔。說明配置的目標執行個體交換器需要與原執行個體處於同一可用性區域。可調用 DescribeVSwitches 介面查詢擷取。	vsw-bp10aqj6o4lclxdrm**,vsw-bp10aqj6o4lclxdrm**
PrivateIpAddress	string	否	無需配置，表示目標執行個體的內網 IP。系統預設通過 VPCId 和 vSwitchId 自動分配。	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：高效能雲端硬碟版本升級功能雲端式盤快照，當前升級後支援選擇的儲存類型如下。當原執行個體為 SSD 雲端硬碟時，可選 SSD 雲端硬碟。當原執行個體為 ESSD 雲端硬碟時，可選 ESSD PL1 雲端硬碟、ESSD PL2 雲端硬碟、ESSD PL3 雲端硬碟、高效能雲端硬碟。當原執行個體為高效能本地碟時，可選 ESSD PL1 雲端硬碟、ESSD PL2 雲端硬碟、ESSD PL3 雲端硬碟、高效能雲端硬碟。	cloud_essd
ZoneId	string	否	目標主可用性區域 ID。當 UpgradeMode（升級模式）取值為 inPlaceUpgrade 和 zeroDownTimeUpgrade 時，無需配置該參數。可以通過 DescribeRegions 介面查看可用性區域 ID。 RDS PostgreSQL 支援升級後將新的執行個體配置到與原執行個體同一地區的其他可用性區域。	cn-hangzhou-j
ZoneIdSlave1	string	否	僅當原執行個體為高可用系列時，該參數可配置，表示目標執行個體備可用性區域 ID。當 UpgradeMode（升級模式）取值為 inPlaceUpgrade 和 zeroDownTimeUpgrade 時，無需配置該參數。 RDS PostgreSQL 支援升級後將新的備執行個體配置到與原執行個體同一地區的其他可用性區域。可以通過 DescribeRegions 介面查看可用性區域 ID。	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

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	指定的Virtual Private Cloud絡無效
400	InvalidDedicatedHostGroupId	The specified DedicatedHostGroupId is invalid.	指定的專用主機群組ID無效
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.	您的賬戶可用額度小於0，請先儲值後再嘗試購買。
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.	提供的DBInstanceId不存在。
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.	指定的 wal_level 參數無效。執行個體中仍然存在複製槽，因此無法將其設定為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.	sql命令執行失敗或執行逾時
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.	DB執行個體引擎類型不支援此操作。
400	Pay.NoCreditCard	No credit cards.	無信用卡。
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	vpc網路類型執行個體不支援此操作。
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.	指定的vswitch Id格式不正確。
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.	參數 UpgradeMode 值錯誤
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.	由於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.	SSD盤不支援此操作，請升級至ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	使用者權限不支援此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的VSwitchId格式不正確或為空白
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.	Kms key已禁用。
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 - 升級RDS PostgreSQL資料庫大版本