該接口用于發(fā)起RDS PostgreSQL實(shí)例大版本升級任務(wù)。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個(gè)操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| rds:UpgradeDBInstanceMajorVersion | update |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceClass | string | 否 | 升級后實(shí)例規(guī)格。CPU 和內(nèi)存配置必須大于等于原實(shí)例規(guī)格。當(dāng) UpgradeMode（升級模式）取值為 inPlaceUpgrade 時(shí)，無需配置該參數(shù)。 例如，原實(shí)例規(guī)格 說明
RDS PG 的實(shí)例規(guī)格代碼，請參見RDS PostgreSQL 主實(shí)例規(guī)格列表。
| pg.n2.medium.2c |
| DBInstanceStorage | integer | 否 | 升級后實(shí)例存儲(chǔ)空間。單位：GB。當(dāng) UpgradeMode（升級模式）取值為 inPlaceUpgrade 時(shí)，無需配置該參數(shù)。 取值范圍：
說明
本地盤實(shí)例升級大版本時(shí)，支持存儲(chǔ)空間縮容。可選擇的最小存儲(chǔ)空間，請參見升級數(shù)據(jù)庫大版本。
| 20 |
| PayType | string | 是 | 計(jì)費(fèi)方式。固定配置為按量付費(fèi)，取值 Postpaid。 說明
升級后如果需要變更實(shí)例的計(jì)費(fèi)方式，請參見按量付費(fèi)轉(zhuǎn)包年包月。
| Postpaid |
| InstanceNetworkType | string | 否 | 升級后實(shí)例網(wǎng)絡(luò)類型。固定配置為 VPC，當(dāng)前只支持專有網(wǎng)絡(luò)實(shí)例進(jìn)行大版本升級。 如果網(wǎng)絡(luò)類型為經(jīng)典網(wǎng)絡(luò)，請先切換為專有網(wǎng)絡(luò)。關(guān)于如何查看或切換網(wǎng)絡(luò)類型，請參見切換網(wǎng)絡(luò)類型。 | VPC |
| SwitchTimeMode | string | 否 | 該參數(shù)與 SwitchOver 配合使用，只有 SwitchOver 參數(shù)取值為 true 時(shí)有效。表示割接時(shí)間。 取值范圍：
| Immediate |
| SwitchTime | string | 否 | 預(yù)留參數(shù)，無需配置。 | 2021-07-10T13:15:12Z |
| SwitchOver | string | 否 | 割接配置，根據(jù)實(shí)際需求選擇是否將流量切換到新版本實(shí)例上。 取值范圍：
說明
| false |
| CollectStatMode | string | 否 | 選擇在哪個(gè)時(shí)間點(diǎn)對數(shù)據(jù)庫執(zhí)行統(tǒng)計(jì)信息收集。
說明
對于不割接場景，割接前收集表示新實(shí)例開放讀寫前收集，割接后收集表示新實(shí)例開放讀寫后收集。
| After |
| TargetMajorVersion | string | 否 | 升級后實(shí)例目標(biāo)大版本。必須與執(zhí)行升級前檢查時(shí)設(shè)置的目標(biāo)版本一致。 說明
可通過調(diào)用 UpgradeDBInstanceMajorVersionPrecheck 接口執(zhí)行大版本升級前檢查。
| 13.0 |
| DBInstanceId | string | 否 | 原實(shí)例 ID。 | pgm-bp1gm3yh0ht1**** |
| VPCId | string | 否 | VPC ID。當(dāng) UpgradeMode（升級模式）取值為 inPlaceUpgrade 時(shí)，無需配置該參數(shù)。 可以通過 DescribeDBInstanceAttribute 接口查看原實(shí)例的 VPC ID。 | vpc-bp1opxu1zkhn00gzv**** |
| VSwitchId | string | 否 | 目標(biāo)實(shí)例交換機(jī) ID。當(dāng) UpgradeMode（升級模式）取值為 inPlaceUpgrade 時(shí)，無需配置該參數(shù)。
說明
配置的目標(biāo)實(shí)例交換機(jī)需要與原實(shí)例處于同一可用區(qū)。可調(diào)用 DescribeVSwitches 接口查詢獲取。
| vsw-bp10aqj6o4lclxdrm****,vsw-bp10aqj6o4lclxdrm**** |
| PrivateIpAddress | string | 否 | 無需配置，表示目標(biāo)實(shí)例的內(nèi)網(wǎng) IP。系統(tǒng)默認(rèn)通過 VPCId 和 vSwitchId 自動(dòng)分配。 | 172.16.XX.XX |
| UsedTime | string | 否 | 預(yù)留參數(shù)，無需配置。 | 1 |
| Period | string | 否 | 預(yù)留參數(shù)，無需配置。 | Month |
| DBInstanceStorageType | string | 否 | 表示升級后實(shí)例的存儲(chǔ)類型。 取值范圍：
版本升級功能基于云盤快照，當(dāng)前升級后支持選擇的存儲(chǔ)類型如下。
| cloud_essd |
| ZoneId | string | 否 | 目標(biāo)主可用區(qū) ID。當(dāng) UpgradeMode（升級模式）取值為 inPlaceUpgrade 時(shí)，無需配置該參數(shù)。 可以通過 DescribeRegions 接口查看可用區(qū) ID。 RDS PostgreSQL 支持升級后將新的實(shí)例配置到與原實(shí)例同一地域的其他可用區(qū)。 | cn-hangzhou-j |
| ZoneIdSlave1 | string | 否 | 僅當(dāng)原實(shí)例為高可用系列時(shí)，該參數(shù)可配置，表示目標(biāo)實(shí)例備可用區(qū) ID。當(dāng) UpgradeMode（升級模式）取值為 inPlaceUpgrade 時(shí)，無需配置該參數(shù)。 RDS PostgreSQL 支持升級后將新的備實(shí)例配置到與原實(shí)例同一地域的其他可用區(qū)。 可以通過 DescribeRegions 接口查看可用區(qū) ID。 | cn-hangzhou-j |
| ZoneIdSlave2 | string | 否 | 預(yù)留參數(shù)，無需配置。 | cn-hangzhou-j |
| UpgradeMode | string | 否 | 升級模式。當(dāng) SwitchOver（割接配置）取值為 true 時(shí)，需要配置該參數(shù)。取值：
| inPlaceUpgrade |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"DBInstanceId": "pgm-bp1gm3yh0ht1****",
"OrderId": "21128667463****",
"RequestId": "006729E5-2A33-5955-89E3-651D3F44EBE6",
"TaskId": 416980000
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidUpgradePrecheckResult | The upgrade precheck failed. No successful precheck task found in the past 7 days | 升級前置檢查失敗，無七天內(nèi)預(yù)檢查成功任務(wù) |
| 400 | TargetEngineVersion.Parameters.NotFound | targetEngineVersion is missing in the request. | 請求缺少目標(biāo)數(shù)據(jù)庫版本參數(shù) |
| 400 | InvalidDBInstanceStorageType | The specified DBInstanceStorageType is invalid. | 指定的數(shù)據(jù)庫實(shí)例存儲(chǔ)類型無效 |
| 400 | InvalidInstanceNetworkType | The specified InstanceNetworkType is invalid. | 指定的實(shí)例網(wǎng)絡(luò)類型無效 |
| 400 | InvalidVPCId | The specified VPCId is invalid. | 指定的虛擬專有網(wǎng)絡(luò)無效 |
| 400 | InvalidDedicatedHostGroupId | The specified DedicatedHostGroupId is invalid. | 指定的專用主機(jī)組ID無效 |
| 400 | InvalidPayType | The specified PayType is invalid. | 指定的付款類型無效 |
| 400 | InvalidEngineVersion | The specified EngineVersion is invalid. | 指定的數(shù)據(jù)庫版本號無效 |
| 400 | InvalidDBInstanceStorage | The specified DBInstanceStorage is invalid. | 指定的數(shù)據(jù)庫實(shí)例存儲(chǔ)無效 |
| 400 | InvalidSwitchOver | The specified SwitchOver is invalid. | 指定的割接模式無效 |
| 400 | PrimaryInstanceWithReadonlyNotSupport | The specified primary instance with the read-only instance does not support the operation. | 具有只讀實(shí)例的指定主實(shí)例不支持此操作 |
| 400 | InvalidSwitchTimeMode | The specified SwitchTimeMode is invalid. | 指定的升級時(shí)間模式無效 |
| 400 | InvalidSwitchTime | The specified SwitchTime is invalid. | 指定的割接時(shí)間無效 |
| 400 | InvalidCollectStats | The specified CollectStats is invalid. | 指定的統(tǒng)計(jì)信息收集模式無效 |
| 400 | IncorrectDBInstanceState | The current instance state does not support this operation. | 當(dāng)前實(shí)例狀態(tài)不支持此操作。 |
| 400 | InvalidDBinstanceClass.ValueNotSupported | The specified parameter DBinstanceClass is invalid. | 指定的參數(shù)“實(shí)例規(guī)格”無效 |
| 400 | InvalidUpgradeMode | The Specified UpgradeMode is not valid. | 指定的升級模式無效。 |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐實(shí)例不允許單獨(dú)操作。 |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定價(jià)計(jì)劃價(jià)格結(jié)果沒有找到。 |
| 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. | 您還未通過實(shí)名認(rèn)證，不符合購買條件，請登錄費(fèi)用與成本進(jìn)行實(shí)名認(rèn)證。 |
| 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. | 調(diào)用商品服務(wù)返回失敗。 |
| 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. | 客戶您好，阿里云計(jì)劃對當(dāng)前地域進(jìn)行優(yōu)化調(diào)整，該區(qū)域云服務(wù)將停止運(yùn)營，為確保您的業(yè)務(wù)連續(xù)性及數(shù)據(jù)遷移工作的平穩(wěn)過渡，您目前無法操作新購類型的訂單，感謝理解與支持。 |
| 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. | 客戶您好，澳洲地域裁撤，購買的服務(wù)效期不能超過2024.09.30 |
| 400 | Price.CommoditySys | Commodity system call exception. | 商品系統(tǒng)調(diào)用異常。 |
| 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. | 您選購的服務(wù)存在未支付訂單，請支付或作廢后再下單。 |
| 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. | 您的基本信息未完善，請?jiān)诓僮髑跋韧晟颇幕拘畔ⅰ?/span> |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | 您的賬戶出現(xiàn)異常，詳情請聯(lián)系客服。 |
| 400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | 您的信息不完整，請?jiān)诓僮髑疤顚懩男畔ⅰ?/span> |
| 400 | Api.NotSupport | Specified api is not supported. | 當(dāng)前接口不支持。 |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 存在禁止下單的標(biāo)簽，請聯(lián)系您的分銷商處理 |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | 提供的DBInstanceId不存在。 |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 當(dāng)前實(shí)例規(guī)格不支持該存儲(chǔ)類型。 |
| 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 參數(shù)無效。實(shí)例中仍然存在復(fù)制槽，因此無法將其設(shè)置為replica。 |
| 400 | KmsApiError | User secret key invalid. | 用戶密鑰失效。 |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | 銷售表達(dá)式校驗(yàn)系統(tǒng)錯(cuò)誤。 |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | 賬戶不存在。 |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | sql命令執(zhí)行失敗或執(zhí)行超時(shí) |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 當(dāng)前實(shí)例引擎版本不支持歸檔冷數(shù)據(jù)。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 當(dāng)前內(nèi)核版本不支持歸檔冷數(shù)據(jù)。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 當(dāng)前規(guī)格不支持此操作。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | 鏈接地址名重復(fù)，請重新設(shè)置連接字符串。 |
| 400 | RequiredParam.NotFound | Required input param is not found. | 沒有傳入必要的參數(shù)。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | 參數(shù)錯(cuò)誤，請檢查參數(shù)。 |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | 數(shù)據(jù)歸檔不支持跨地域備份和秒級快照，請檢查備份策略。 |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | 實(shí)例狀態(tài)不支持此操作。 |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | 實(shí)例釋放后的歸檔備份保留策略無效。 |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | DB實(shí)例引擎類型不支持此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | 無信用卡。 |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | vpc網(wǎng)絡(luò)類型實(shí)例不支持此操作。 |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 當(dāng)前數(shù)據(jù)庫實(shí)例鏡像已存在。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 實(shí)例規(guī)格停止售賣。 |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | 備份集中沒有指定的數(shù)據(jù)庫。 |
| 400 | OrdTCommodityQueryError | Failed to query for product. | 查詢產(chǎn)品失敗。 |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | 實(shí)例已釋放，請核實(shí)后下單。 |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | 指定的地域無效。 |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 實(shí)例當(dāng)前存在未支付訂單，請支付后重試。 |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | 縮容目標(biāo)容量不能小于當(dāng)前存儲(chǔ)空間使用量 |
| 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. | 用戶權(quán)限不支持此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或?yàn)榭?/span> |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 當(dāng)前引擎小版本不支持此操作。 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 沒有可用的庫存區(qū)域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集團(tuán)上云用戶不可用，無權(quán)限。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 當(dāng)前數(shù)據(jù)庫實(shí)例級別不支持此操作。 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 數(shù)據(jù)庫實(shí)例名稱不存在。請確認(rèn)數(shù)據(jù)名稱是否正確。 |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失敗，實(shí)例處于鎖定狀態(tài)。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 當(dāng)前實(shí)例未授權(quán)訪問密鑰管理服務(wù)。 |
| 404 | Request.NotFound | The requested resource is not available. | 請求的資源不可用。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定的主機(jī)信息不存在。 |
| 500 | InvalidUpgradeMode | The Specified Parameter UpgradeMode is not valid. | 參數(shù) UpgradeMode 值錯(cuò)誤 |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | 請求服務(wù)失敗，請稍后重試。 |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | 請求服務(wù)失敗，請稍后再試或聯(lián)系服務(wù)人員。 |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | 由于rds api服務(wù)失敗，請求處理失敗。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-08-27 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-08-23 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-08-23 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-06-03 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-05-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |