該接口用于新增RDS實(shí)例數(shù)據(jù)庫(kù)代理的連接地址。
接口說(shuō)明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| rds:CreateDBProxyEndpointAddress | create | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可調(diào)用 DescribeRegions 獲取。 | cn-hangzhou |
| DBInstanceId | string | 是 | 實(shí)例 ID。可調(diào)用 DescribeDBInstances 獲取。 | rm-t4n3**** |
| DBProxyEndpointId | string | 是 | 數(shù)據(jù)庫(kù)代理連接地址 ID。可以調(diào)用 DescribeDBProxyEndpoint 接口查詢。 | ta9um4**** |
| ConnectionStringPrefix | string | 是 | 新的數(shù)據(jù)庫(kù)代理連接地址的前綴。自定義。 | test1234 |
| DBProxyNewConnectStringPort | string | 否 | 新的數(shù)據(jù)庫(kù)代理連接地址的端口，默認(rèn)值：
| 3306 |
| DBProxyConnectStringNetType | string | 是 | 新的數(shù)據(jù)庫(kù)代理連接地址的網(wǎng)絡(luò)類型，取值：
默認(rèn)值：Classic。 | Public |
| VPCId | string | 否 | 新的數(shù)據(jù)庫(kù)代理連接地址的 VPC ID。可調(diào)用 DescribeDBInstanceAttribute 接口查詢。 說(shuō)明
當(dāng) DBProxyConnectStringNetType 取值為 VPC 時(shí)， 必須傳入此參數(shù)。
| vpc-bp**** |
| VSwitchId | string | 否 | 新的數(shù)據(jù)庫(kù)代理連接地址的虛擬交換機(jī) ID。可調(diào)用 DescribeDBInstanceAttribute 接口查詢。 說(shuō)明
當(dāng) DBProxyConnectStringNetType 取值為 VPC 時(shí)， 必須傳入此參數(shù)。
| vsw-bp**** |
| DBProxyEngineType | string | 否 | 預(yù)留參數(shù)，無(wú)需配置。 | normal |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmy**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidPort.Malformed | Specified port is not valid. | 指定的端口無(wú)效。 |
| 400 | NetTypeExists | Specified net type already existed. | 網(wǎng)絡(luò)類型切換失敗，當(dāng)前網(wǎng)絡(luò)類型已經(jīng)存在。 |
| 400 | IncorrectDBInstanceNetType | Current DB instance net type does not support this operation. | 操作失敗，實(shí)例網(wǎng)絡(luò)類型不支持。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | 鏈接地址名重復(fù)，請(qǐng)重新設(shè)置連接字符串。 |
| 400 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的連接專有網(wǎng)絡(luò)ID無(wú)效。 |
| 400 | InvalidVpcInstanceId | Specified vpc instance id is not valid. | 操作失敗，當(dāng)前VPC實(shí)例ID無(wú)效。 |
| 400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的實(shí)例名稱（DBInstanceName）無(wú)效，請(qǐng)檢查參數(shù)值是否為null或空字符串。 |
| 400 | InvalidVpcIdOrVswitchId.NotSupported | The specified vpcId or vSwitchId is not supported. | 指定的vpcId或者vSwitchId不支持，請(qǐng)檢查實(shí)例信息 |
| 400 | InvalidPrivateIpAddress.Mismatch | Specified private IP address is not in the CIDR block of virtual switch. | VPC地址無(wú)效。 |
| 400 | InvalidVpcParameter | Specified VPCId VSwitchId or IPAddress or TunnelId is not valid. | VPCId VSwitchId不合法，請(qǐng)檢查VPCId VSwitchId的正確性。 |
| 400 | InvalidBizType.Format | Specified biz type is not valid. | 當(dāng)前業(yè)務(wù)類型不支持該操作。 |
| 400 | InvalidVSwitchId.NotFound | Specified vSwitch is not found in specified VPC. | 當(dāng)前VPC內(nèi)無(wú)可用交換機(jī)。 |
| 400 | InvalidVSwitchId.Mismatch | Specified instance and virtual switch are not in the same zone. | 實(shí)例和交換機(jī)不在同一可用區(qū)。 |
| 400 | InvalidPrivateIpAddress.AlreadyUsed | The specified IP is already used. | ip已被使用。 |
| 400 | VswitchIpExhausted | No available ip in the specified vswitch. | 指定的vswitch中沒(méi)有可用的IP。 |
| 400 | MaxscaleNotSupport | Current custins can not support Maxscale. | 帶有maxscale的實(shí)例不支持此操作。 |
| 400 | InvalidConnectionString.Format | Specified connection string is not valid. | 實(shí)例連接地址的字符串格式不正確。字符串前綴長(zhǎng)度為5~40。 |
| 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é)果沒(méi)有找到。 |
| 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. | 您還未通過(guò)實(shí)名認(rèn)證，不符合購(gòu)買條件，請(qǐng)登錄費(fèi)用與成本進(jìn)行實(shí)名認(rèn)證。 |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的賬戶可用額度小于0，請(qǐng)先充值后再嘗試購(gòu)買。 |
| 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ì)劃對(duì)當(dāng)前地域進(jìn)行優(yōu)化調(diào)整，該區(qū)域云服務(wù)將停止運(yùn)營(yíng)，為確保您的業(yè)務(wù)連續(xù)性及數(shù)據(jù)遷移工作的平穩(wěn)過(guò)渡，您目前無(wú)法操作新購(gòu)類型的訂單，感謝理解與支持。 |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | 您購(gòu)買的模塊不合法，請(qǐng)重新購(gòu)買。 |
| 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. | 您選購(gòu)的周期有問(wèn)題，請(qǐng)重新選購(gòu)。 |
| 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. | 您選購(gòu)的服務(wù)存在未支付訂單，請(qǐng)支付或作廢后再下單。 |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | 沒(méi)有為您的帳戶指定付款方式。我們建議您添加一種付款方式。 |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 您的基本信息未完善，請(qǐng)?jiān)诓僮髑跋韧晟颇幕拘畔ⅰ?/span> |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | 您的賬戶出現(xiàn)異常，詳情請(qǐng)聯(lián)系客服。 |
| 400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | 您的信息不完整，請(qǐng)?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)簽，請(qǐng)聯(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ù)無(wú)效。實(shí)例中仍然存在復(fù)制槽，因此無(wú)法將其設(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 | RequiredParam.NotFound | Required input param is not found. | 沒(méi)有傳入必要的參數(shù)。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | 參數(shù)錯(cuò)誤，請(qǐng)檢查參數(shù)。 |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | 數(shù)據(jù)歸檔不支持跨地域備份和秒級(jí)快照，請(qǐng)檢查備份策略。 |
| 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í)例釋放后的歸檔備份保留策略無(wú)效。 |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | DB實(shí)例引擎類型不支持此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | 無(wú)信用卡。 |
| 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ù)庫(kù)實(shí)例鏡像已存在。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 實(shí)例規(guī)格停止售賣。 |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | 備份集中沒(méi)有指定的數(shù)據(jù)庫(kù)。 |
| 400 | OrdTCommodityQueryError | Failed to query for product. | 查詢產(chǎn)品失敗。 |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | 實(shí)例已釋放，請(qǐng)核實(shí)后下單。 |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | 指定的地域無(wú)效。 |
| 400 | APICallingFailed | Api calling failed. | 后端API內(nèi)部調(diào)用失敗 |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失敗，該實(shí)例狀態(tài)下不支持此操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 當(dāng)前實(shí)例狀態(tài)不支持此操作。 |
| 403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失敗，數(shù)據(jù)庫(kù)引擎不支持。 |
| 403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失敗，當(dāng)前實(shí)例所屬環(huán)境類型不支持，請(qǐng)檢查接口支持的實(shí)例類型。 |
| 403 | IncorrectDBInstanceConnType | Current DB instance conn type does not support this operation. | 當(dāng)前數(shù)據(jù)庫(kù)實(shí)例的連接類型不支持此操作。 |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 實(shí)例當(dāng)前存在未支付訂單，請(qǐ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盤不支持此操作，請(qǐng)升級(jí)至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. | 沒(méi)有可用的庫(kù)存區(qū)域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集團(tuán)上云用戶不可用，無(wú)權(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ù)庫(kù)實(shí)例級(jí)別不支持此操作。 |
| 404 | Endpoint.NotFound | Specified endpoint is not found. | 未找到指定獨(dú)享代理連接地址的端口。 |
| 404 | Maxscale.NotFound | The related maxscale instance is not found. | 操作失敗，未找到關(guān)聯(lián)的maxscale實(shí)例。 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交換機(jī)參數(shù)無(wú)效。 |
| 404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | 數(shù)據(jù)庫(kù)實(shí)例ID不存在，請(qǐng)檢查。 |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的實(shí)例不存在指定的實(shí)例被刪除或者實(shí)例不支持當(dāng)前操作。 |
| 404 | InsufficientResourceCapacity | Current cluster resources are insufficient. Try again later. | 當(dāng)前集群的資源不足，請(qǐng)您稍后再試。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 當(dāng)前實(shí)例未授權(quán)訪問(wèn)密鑰管理服務(wù)。 |
| 404 | Request.NotFound | The requested resource is not available. | 請(qǐng)求的資源不可用。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定的主機(jī)信息不存在。 |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | 請(qǐng)求服務(wù)失敗，請(qǐng)稍后重試。 |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | 請(qǐng)求服務(wù)失敗，請(qǐng)稍后再試或聯(lián)系服務(wù)人員。 |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | 由于rds api服務(wù)失敗，請(qǐng)求處理失敗。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-12-19 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-06-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-06-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |