該接口用于開啟或者修改RDS實(shí)例的數(shù)據(jù)庫代理實(shí)例功能。
接口說明
適用引擎
- RDS MySQL
- RDS PostgreSQL
說明
云數(shù)據(jù)庫 RDS MySQL 集群系列于 2023 年 10 月 17 日起逐步在各個單元贈送代理數(shù)量為 1 的數(shù)據(jù)庫獨(dú)享代理服務(wù)，詳情請參見【優(yōu)惠】RDS MySQL 集群版贈送代理數(shù)量為 1 的數(shù)據(jù)庫獨(dú)享代理服務(wù)。
相關(guān)功能文檔
注意 使用該接口前，請仔細(xì)閱讀功能文檔，確保完全了解使用接口的前提條件及使用后造成的影響后，再進(jìn)行操作。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（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:ModifyDBProxy | update | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實(shí)例 ID。可調(diào)用 DescribeDBInstances 獲取。 | rm-uf6wjk5**** |
| ConfigDBProxyService | string | 是 | 開啟或關(guān)閉數(shù)據(jù)庫代理，取值：
| Startup |
| DBProxyInstanceNum | string | 否 | 開通代理實(shí)例數(shù)量，取值：1~16。默認(rèn)值：1。 說明
更多的代理實(shí)例能處理更多的請求，您可以根據(jù)監(jiān)控?cái)?shù)據(jù)了解代理實(shí)例的負(fù)載，然后設(shè)置合理的代理實(shí)例數(shù)量。
| 1 |
| RegionId | string | 否 | 地域 ID，可調(diào)用 DescribeRegions 獲取。 | cn-hangzhou |
| InstanceNetworkType | string | 否 | 實(shí)例的網(wǎng)絡(luò)類型。當(dāng)前僅支持 VPC 網(wǎng)絡(luò)，取值：VPC。 說明
RDS MySQL 云盤版或 RDS PostgreSQL 開啟數(shù)據(jù)庫代理時，該參數(shù)必選。
| VPC |
| VPCId | string | 否 | 實(shí)例所屬 VPC ID。可調(diào)用 DescribeDBInstanceAttribute 接口查詢。 說明
RDS MySQL 云盤版或 RDS PostgreSQL 開啟數(shù)據(jù)庫代理時，該參數(shù)必選。
| vpc-**** |
| VSwitchId | string | 否 | 實(shí)例所屬虛擬交換機(jī) ID。可調(diào)用 DescribeDBInstanceAttribute 接口查詢。 說明
RDS MySQL 云盤版或 RDS PostgreSQL 開啟數(shù)據(jù)庫代理時，該參數(shù)必選。
| vsw-**** |
| DBProxyEngineType | string | 否 | 廢棄參數(shù)，無需配置。 | normal |
| DBProxyInstanceType | string | 否 | 數(shù)據(jù)庫代理實(shí)例類型，取值：
| exclusive |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmy**** |
| PersistentConnectionStatus | string | 否 | 是否開啟連接保持。取值：
說明
| Disabled |
| DBProxyNodes | array<object> | 否 | 代理節(jié)點(diǎn)列表。 | |
| object | 否 | 代理節(jié)點(diǎn)詳情。 | ||
| cpuCores | string | 否 | 節(jié)點(diǎn) CPU 核數(shù)，取值 1~16。 說明
選擇 DBProxyNodes 時，該參數(shù)必選。
| 1 |
| nodeCounts | string | 否 | 可用區(qū)中代理節(jié)點(diǎn)數(shù)量，取值 1~2。 說明
選擇 DBProxyNodes 時，該參數(shù)必選。
| 2 |
| zoneId | string | 否 | 節(jié)點(diǎn)所在的可用區(qū) ID。 說明
選擇 DBProxyNodes 時，該參數(shù)必選。
| cn-hangzhou-c |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MaxscaleAlreadyExist | The Maxscale is already existed. | Maxscale已存在。 |
| 400 | MaxscaleNotSupport | Maxscale not supported | 操作失敗，實(shí)例不支持獨(dú)享代理，請檢查開通獨(dú)享代理的配置信息。 |
| 400 | NetWork.NotFound | NetWork.NotFound | 網(wǎng)絡(luò)不可用。 |
| 400 | InvalidVpcParameter | Either VPC ID or vSwitch ID is incorrect. Please check again. | 操作失敗，請檢查VPC參數(shù)正確性。 |
| 400 | MaxscaleInternalError | Database proxy status is CLASS_CHANGING. | DB代理狀態(tài)是規(guī)格變更中，請稍后重啟。 |
| 400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的實(shí)例名稱（DBInstanceName）無效，請檢查參數(shù)值是否為null或空字符串。 |
| 400 | InvalidOptimizationCategory.Format | Specified optimization category is not valid. | 參數(shù)OptimizationCategory無效 |
| 400 | MinorVersionNotSupport | The current database minor version does not support the operation. | 當(dāng)前實(shí)例內(nèi)核小版本不支持該操作，可嘗試升級內(nèi)核小版本。 |
| 400 | InvalidParameters.Format | Specified parameter is not valid | 操作失敗，指定的參數(shù)格式不合法。 |
| 400 | MaxscaleNotSupport | Current custins can not support Maxscale. | 帶有maxscale的實(shí)例不支持此操作。 |
| 400 | InvalidTunnelId | Specified conn tunnel is not valid. | 指定的連接通道無效。 |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定的地域不合法，請檢查該參數(shù)的正確性。 |
| 400 | InvalidDBProxyNodes.General | general-purpose proxy does not support more than 2 nodes. | 通用型代理不支持節(jié)點(diǎn)數(shù)大于2 |
| 400 | InvalidDBProxyNodes.ZoneIdAndNodeCounts | The number of node count and zone count is mismatch. | 可用區(qū)數(shù)量或節(jié)點(diǎn)數(shù)量不合法。 |
| 400 | InvalidDBProxyNodes.ZoneId | The number of zone is request 1 or 2. | DBProxyNodes字段的ZoneId可用區(qū)只能是1個或2個。 |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐實(shí)例不允許單獨(dú)操作。 |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定價計(jì)劃價格結(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. | 客戶您好，該地域已裁撤。 |
| 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ī)格不支持該存儲類型。 |
| 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)錯誤。 |
| 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. | 當(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ù)錯誤，請檢查參數(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. | 指定的地域無效。 |
| 400 | InvalidDBProxyNodes.ZoneIdNotUnique | ZoneIds is not unique. | 可用區(qū)ID不唯一。 |
| 403 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的連接專有網(wǎng)絡(luò)ID無效。 |
| 403 | IncorrectDBInstanceType | The database instance type does not support the operation. | 操作失敗，當(dāng)前數(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. | 操作失敗，當(dāng)前實(shí)例所屬環(huán)境類型不支持，請檢查接口支持的實(shí)例類型。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 當(dāng)前實(shí)例狀態(tài)不支持此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或?yàn)榭?/span> |
| 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)前存儲空間使用量 |
| 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. | 當(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 | MaxscaleCreating | The relative maxscale instance is being created or deleted. | - |
| 404 | Maxscale.NotFound | The relative maxscale instance is not found. | 操作失敗，未找到關(guān)聯(lián)的maxscale實(shí)例。 |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitch is invalid. | 操作失敗，無效的vSwitch，請檢查該參數(shù)的正確性。 |
| 404 | InvalidParam | The parameter is invalid. | 操作失敗，無效的參數(shù)。 |
| 404 | InsufficientResourceCapacity | The target availability zone does not have sufficient resources. | 目標(biāo)可用區(qū)沒有足夠的資源。 |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 沒有找到指定的實(shí)例，請檢查實(shí)例的正確性。 |
| 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 | 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ù)失敗，請求處理失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-10-15 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-12-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-12-12 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-11-23 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-11-14 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-09-08 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-06-08 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |