該接口用于變更RDS數(shù)據(jù)庫代理實例相關(guān)配置。
接口說明
適用引擎
- RDS MySQL
- RDS PostgreSQL
說明
云數(shù)據(jù)庫 RDS MySQL 集群系列于 2023 年 10 月 17 日起逐步在各個單元贈送代理數(shù)量為 1 的數(shù)據(jù)庫獨享代理服務，詳情請參見【優(yōu)惠】RDS MySQL 集群版贈送代理數(shù)量為 1 的數(shù)據(jù)庫獨享代理服務。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| rds:ModifyDBProxyInstance | update | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實例 ID?？烧{(diào)用 DescribeDBInstances 獲取。 | rm-t4n3a**** |
| DBProxyInstanceType | string | 是 | 數(shù)據(jù)庫代理實例類型，取值：
| exclusive |
| DBProxyInstanceNum | string | 是 | 設(shè)置代理實例數(shù)量。當取值為 0 的時候，表示這個實例關(guān)閉此種類型代理服務。取值：1~16。 說明
更多的代理實例能處理更多的請求，您可以根據(jù)監(jiān)控數(shù)據(jù)了解代理實例的負載，然后設(shè)置合理的代理實例數(shù)量。
| 2 |
| EffectiveTime | string | 否 | 生效時間，取值：
默認值：MaintainTime。 | MaintainTime |
| EffectiveSpecificTime | string | 否 | 指定時間生效。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。 說明
EffectiveTime 為 SpecificTime 時，該參數(shù)必傳。
| 2019-07-10T13:15:12Z |
| RegionId | string | 否 | 地域 ID?？烧{(diào)用 DescribeRegions 獲取。 | cn-hangzhou |
| DBProxyEngineType | string | 否 | 廢棄參數(shù)，無需配置。 | normal |
| VSwitchIds | string | 否 | 廢棄參數(shù)，無需配置。 | vsw-uf6adz52c2p**** |
| DBProxyNodes | array<object> | 否 | 代理節(jié)點列表。 說明
當前代理實例為多可用區(qū)部署時，該參數(shù)必傳。
| |
| object | 否 | 代理節(jié)點詳情。 | ||
| cpuCores | string | 否 | 節(jié)點 CPU 核數(shù)，取值 1~16。 說明
選擇 DBProxyNodes 時，該參數(shù)必選。
| 1 |
| nodeCounts | string | 否 | 可用區(qū)中代理節(jié)點數(shù)量，取值 1~2。 說明
選擇 DBProxyNodes 時，該參數(shù)必選。
| 2 |
| zoneId | string | 否 | 節(jié)點所在的可用區(qū) ID。 說明
選擇 DBProxyNodes 時，該參數(shù)必選。
| cn-hangzhou-c |
| MigrateAZ | array<object> | 否 | 遷移代理可用區(qū)列表。 說明
當前僅支持 RDS MySQL 云盤版代理實例遷移可用區(qū)。
| |
| object | 否 | 遷移代理可用區(qū)詳情。 | ||
| dbProxyEndpointId | string | 否 | 代理連接地址 ID。可以通過接口 DescribeDBProxyEndpoint 獲取。 說明
選擇 MigrateAZ 時，該參數(shù)必選。
| yhw429******** |
| destVSwitchId | string | 否 | 代理實例遷移對應的目標 VSwitchId。 說明
選擇 MigrateAZ 時，該參數(shù)必選。
| vsw-sw0qq49d1m**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "65C55572-530E-4A53-BE03-1D08CAF0F046"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的實例名稱（DBInstanceName）無效，請檢查參數(shù)值是否為null或空字符串。 |
| 400 | InvalidParameters.Format | Specified parameter is not valid | 操作失敗，指定的參數(shù)格式不合法。 |
| 400 | InvalidAvZone.Format | Specified AvZone is not valid. | 指定的AvZone不合法，請檢查該參數(shù)的正確性。 |
| 400 | ErrorMxsServiceInsNum.Error | The Maxscale serviceIns num must be 1. | Maxscale必須為1. |
| 400 | TaskExists | Specified task have existed. | 任務已存在。 |
| 400 | InvalidVSwitchIds | Specified vSwitchId is invalid. | 指定的vSwitchId無效。 |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 當前數(shù)據(jù)庫實例鏡像已存在。 |
| 400 | APICallingFailed | Api calling failed. | 后端API內(nèi)部調(diào)用失敗 |
| 400 | InvalidDBProxyNodes.AzProximity | current proxy is open az proximity and target proxy not support az proximity. | 當前代理已開通就近訪問，且目標部署模式不支持就近訪問功能。 |
| 400 | InvalidDBProxyNodes.General | general-purpose proxy does not support more than 2 nodes. | 通用型代理不支持節(jié)點數(shù)大于2 |
| 400 | InvalidTargetAvailabilityZone | All endpoint vswitchId must be in the target availability zone. | 所有連接地址的vswitchId必須在目標可用區(qū)中。 |
| 400 | InvalidDBProxyNodes.Node | must set DBProxyNodes params with more than 2 proxy nodes. | DBProxyNodes的節(jié)點數(shù)最少為2個 |
| 400 | InvalidDBProxyNodes.ZoneIdAndNodeCounts | The number of node count and zone count is mismatch. | 可用區(qū)數(shù)量或節(jié)點數(shù)量不合法。 |
| 400 | InvalidDBProxyNodes.ZoneId | The number of zone is request 1 or 2. | DBProxyNodes字段的ZoneId可用區(qū)只能是1個或2個。 |
| 400 | InvalidMigrateAZInfo | Invalid MigrateAZ params. | MigrateAZ參數(shù)無效。 |
| 400 | InvalidDBProxyNodes.ZoneIdNotUnique | ZoneIds is not unique. | 可用區(qū)ID不唯一。 |
| 400 | InvalidVSwitchId.Format | The specified vswitch Id format is incorrect. | 指定的vswitch Id格式不正確。 |
| 400 | InvalidEndPoint.Format | The specified EndPoint is not valid. | 獨享代理連接地址ID（DBProxyEndpointId）未傳，查詢不存在， 請檢查Endpoint參數(shù)。 |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐實例不允許單獨操作。 |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定價計劃價格結(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. | 您還未通過實名認證，不符合購買條件，請登錄費用與成本進行實名認證。 |
| 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)用商品服務返回失敗。 |
| 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. | 客戶您好，阿里云計劃對當前地域進行優(yōu)化調(diào)整，該區(qū)域云服務將停止運營，為確保您的業(yè)務連續(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. | 客戶您好，該地域已裁撤。 |
| 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. | 您選購的服務存在未支付訂單，請支付或作廢后再下單。 |
| 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. | 您的賬戶出現(xiàn)異常，詳情請聯(lián)系客服。 |
| 400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | 您的信息不完整，請在操作前填寫您的信息。 |
| 400 | Api.NotSupport | Specified api is not supported. | 當前接口不支持。 |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 存在禁止下單的標簽，請聯(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 | 當前實例規(guī)格不支持該存儲類型。 |
| 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è)置為replica。 |
| 400 | KmsApiError | User secret key invalid. | 用戶密鑰失效。 |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | 銷售表達式校驗系統(tǒng)錯誤。 |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | 賬戶不存在。 |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | sql命令執(zhí)行失敗或執(zhí)行超時 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 當前實例引擎版本不支持歸檔冷數(shù)據(jù)。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 當前內(nèi)核版本不支持歸檔冷數(shù)據(jù)。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 當前規(guī)格不支持此操作。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | 鏈接地址名重復，請重新設(shè)置連接字符串。 |
| 400 | RequiredParam.NotFound | Required input param is not found. | 沒有傳入必要的參數(shù)。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | 參數(shù)錯誤，請檢查參數(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. | 實例狀態(tài)不支持此操作。 |
| 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網(wǎng)絡類型實例不支持此操作。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 實例規(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. | 實例已釋放，請核實后下單。 |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | 指定的地域無效。 |
| 403 | DBInstanceStatusNotActive | Current DB instance status should be active. | 操作失敗，請檢查實例運行狀態(tài)。 |
| 403 | InvalidInstanceLevel.Malformed | The specified class code does not support the endpoint number. Please check the shard number and the current endpoint number. | 操作失敗，規(guī)定的規(guī)格碼不支持該終端數(shù)，請檢查分片數(shù)量和當前的終端數(shù)。 |
| 403 | NotHaveProxy | The current instance does not have a proxy. | 當前實例沒有代理。 |
| 403 | MaxscaleMinorVersionNotSupport | The Maxscale version used by the instance is too low, please upgrade the Maxscale version first. | 實例使用數(shù)據(jù)庫代理的版本過低，請先升級數(shù)據(jù)庫代理版本。 |
| 403 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | 操作失敗，當前數(shù)據(jù)庫實例引擎和類型不支持。 |
| 403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失敗，數(shù)據(jù)庫引擎不支持。 |
| 403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失敗，當前實例所屬環(huán)境類型不支持，請檢查接口支持的實例類型。 |
| 403 | IncorrectDBType | The current DB type does not support this operation. | 操作失敗，當前數(shù)據(jù)庫類型不支持此操作，請使用其他類型的數(shù)據(jù)庫進行操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 當前實例狀態(tài)不支持此操作。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或為空 |
| 403 | DBInstanceStatusNotActive | The status of the current instance is not active. | 操作失敗，請檢查實例運行狀態(tài)。 |
| 403 | IncorrectDBInstance | The current DB instance does not support this operation. | 操作失敗，當前實例不支持此操作。 |
| 403 | MaxscaleInstanceNotSupport | Instances with maxscale instance do not support this operation. | 帶Maxscale代理的實例不支持此操作。 |
| 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. | 用戶權(quán)限不支持此操作。 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 當前引擎小版本不支持此操作。 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 沒有可用的庫存區(qū)域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集團上云用戶不可用，無權(quán)限。 |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失敗，實例處于鎖定狀態(tài)。 |
| 404 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | 當前選擇的配置或規(guī)格不存在或已停售，請重新選擇。 |
| 404 | InsufficientResourceCapacity | The target availability zone does not have sufficient resources. | 目標可用區(qū)沒有足夠的資源。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 當前實例未授權(quán)訪問密鑰管理服務。 |
| 404 | Request.NotFound | The requested resource is not available. | 請求的資源不可用。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定的主機信息不存在。 |
| 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. | 請求服務失敗，請稍后再試或聯(lián)系服務人員。 |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | 由于rds api服務失敗，請求處理失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-10-15 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-07-12 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-05-07 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-04-25 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-01-09 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-12-19 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-05-15 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-06-23 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-06-07 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |