該介面用於開啟或者修改RDS執行個體的資料庫代理執行個體功能。
介面說明
適用引擎
RDS MySQL
RDS PostgreSQL
雲資料庫 RDS MySQL 叢集系列於 2023 年 10 月 17 日起逐步在各個單元贈送代理數量為 1 的資料庫獨享代理服務，詳情請參見【優惠】RDS MySQL 叢集版贈送代理數量為 1 的資料庫獨享代理服務。
相關功能文檔
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
rds:ModifyDBProxy |
update |
*DBInstance
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體 ID。可調用 DescribeDBInstances 擷取。 |
rm-uf6wjk5**** |
| ConfigDBProxyService |
string |
是 |
開啟或關閉資料庫代理，取值：
|
Startup |
| DBProxyInstanceNum |
string |
否 |
開通代理執行個體數量，取值：1~16。預設值：1。 說明
更多的代理執行個體能處理更多的請求，您可以根據監控資料瞭解代理執行個體的負載，然後設定合理的代理執行個體數量。 |
1 |
| RegionId |
string |
否 |
地區 ID，可調用 DescribeRegions 擷取。 |
cn-hangzhou |
| InstanceNetworkType |
string |
否 |
執行個體的網路類型。當前僅支援 VPC 網路，取值：VPC。 說明
開啟資料庫代理時，該參數必選。 |
VPC |
| VPCId |
string |
否 |
執行個體所屬 VPC ID。可調用 DescribeDBInstanceAttribute 介面查詢。 說明
開啟資料庫代理時，該參數必選。 |
vpc-**** |
| VSwitchId |
string |
否 |
執行個體所屬虛擬交換器 ID。可調用 DescribeDBInstanceAttribute 介面查詢。 說明
開啟資料庫代理時，該參數必選。 |
vsw-**** |
| DBProxyEngineType |
string |
否 |
廢棄參數，無需配置。 |
normal |
| DBProxyInstanceType |
string |
否 |
資料庫代理執行個體類型，取值：
|
exclusive |
| DBInstanceId |
string |
是 |
執行個體 ID。可調用 DescribeDBInstances 擷取。 |
rm-uf6wjk5**** |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmy**** |
| PersistentConnectionStatus |
string |
否 |
是否開啟串連保持。取值：
說明
|
Disabled |
| DBProxyNodes |
array<object> |
否 |
代理節點列表。 |
|
|
object |
否 |
代理節點詳情。 |
||
| cpuCores |
string |
否 |
節點 CPU 核心數，取值 1~16。 說明
選擇 DBProxyNodes 時，該參數必選。 |
1 |
| nodeCounts |
string |
否 |
可用性區域中代理節點數量，取值 1~2。 說明
選擇 DBProxyNodes 時，該參數必選。 |
2 |
| zoneId |
string |
否 |
節點所在的可用性區域 ID。 說明
選擇 DBProxyNodes 時，該參數必選。 |
cn-hangzhou-c |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數詳情。 |
||
| RequestId |
string |
請求 ID。 |
FC452BB1-EED8-4278-95C7-0324B3710DF1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MaxscaleAlreadyExist | The Maxscale is already existed. | Maxscale已存在。 |
| 400 | MaxscaleNotSupport | Maxscale not supported | 操作失敗，執行個體不支援獨享代理，請檢查開通獨享代理的配置資訊。 |
| 400 | NetWork.NotFound | NetWork.NotFound | 網路不可用。 |
| 400 | InvalidVpcParameter | Either VPC ID or vSwitch ID is incorrect. Please check again. | 操作失敗，請檢查VPC參數正確性。 |
| 400 | MaxscaleInternalError | Database proxy status is CLASS_CHANGING. | DB代理程式狀態是規格變更中，請稍後重啟。 |
| 400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的執行個體名稱（DBInstanceName）無效，請檢查參數值是否為null或Null 字元串。 |
| 400 | InvalidOptimizationCategory.Format | Specified optimization category is not valid. | 參數OptimizationCategory無效 |
| 400 | MinorVersionNotSupport | The current database minor version does not support the operation. | 當前執行個體核心小版本不支援該操作，可嘗試升級核心小版本。 |
| 400 | InvalidParameters.Format | Specified parameter is not valid | 操作失敗，指定的參數格式不合法。 |
| 400 | InvalidTunnelId | Specified conn tunnel is not valid. | 指定的串連通道無效。 |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定的地區不合法，請檢查該參數的正確性。 |
| 400 | InvalidDBProxyNodes.General | general-purpose proxy does not support more than 2 nodes. | 通用型代理不支援節點數大於2 |
| 400 | InvalidDBProxyNodes.ZoneIdAndNodeCounts | The number of node count and zone count is mismatch. | 可用性區域數量或節點數量不合法。 |
| 400 | InvalidDBProxyNodes.ZoneId | The number of zone is request 1 or 2. | DBProxyNodes欄位的ZoneId可用性區域只能是1個或2個。 |
| 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 | InvalidDBProxyNodes.ZoneIdNotUnique | ZoneIds is not unique. | 可用性區域ID不唯一。 |
| 400 | MaxscaleServiceLinkedRole.NotFound | Service linked role 'AliyunServiceRoleForRDSProxyOnEcs' not found. | 資料庫代理服務關聯角色未找到，請檢查。 |
| 400 | MappingInstanceLevel.NotFound | Can not find the mapping instance level. | 找不到映射執行個體規格。 |
| 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 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的串連專用網路ID無效。 |
| 403 | IncorrectDBInstanceType | The database instance type does not support the operation. | 操作失敗，當前資料庫類型不支援該操作。 |
| 403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失敗，資料庫引擎不支援。 |
| 403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失敗，當前執行個體所屬環境類型不支援，請檢查介面支援的執行個體類型。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 當前執行個體狀態不支援此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或為空白 |
| 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 | 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 | MaxscaleCreating | The relative maxscale instance is being created or deleted. | |
| 404 | Maxscale.NotFound | The relative maxscale instance is not found. | 操作失敗，未找到關聯的maxscale執行個體。 |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitch is invalid. | |
| 404 | InvalidParam | The parameter is invalid. | 操作失敗，無效的參數。 |
| 404 | InsufficientResourceCapacity | The target availability zone does not have sufficient resources. | 目標可用性區域沒有足夠的資源。 |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 沒有找到指定的執行個體，請檢查執行個體的正確性。 |
| 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. | 指定的主機資訊不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。