该接口用于新增RDS实例数据库代理的连接地址。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:CreateDBProxyEndpointAddress | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可调用 DescribeRegions 获取。 | cn-hangzhou |
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | rm-t4n3**** |
DBProxyEndpointId | string | 是 | 数据库代理连接地址 ID。可以调用 DescribeDBProxyEndpoint 接口查询。 | ta9um4**** |
ConnectionStringPrefix | string | 是 | 新的数据库代理连接地址的前缀。自定义。 | test1234 |
DBProxyNewConnectStringPort | string | 否 | 新的数据库代理连接地址的端口,默认值:
| 3306 |
DBProxyConnectStringNetType | string | 是 | 新的数据库代理连接地址的网络类型,取值:
默认值:Classic。 | Public |
VPCId | string | 否 | 新的数据库代理连接地址的 VPC ID。可调用 DescribeDBInstanceAttribute 接口查询。 说明
当 DBProxyConnectStringNetType 取值为 VPC 时, 必须传入此参数。
| vpc-bp**** |
VSwitchId | string | 否 | 新的数据库代理连接地址的虚拟交换机 ID。可调用 DescribeDBInstanceAttribute 接口查询。 说明
当 DBProxyConnectStringNetType 取值为 VPC 时, 必须传入此参数。
| vsw-bp**** |
DBProxyEngineType | string | 否 | 预留参数,无需配置。 | normal |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmy**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPort.Malformed | Specified port is not valid. | 指定的端口无效。 |
400 | NetTypeExists | Specified net type already existed. | 网络类型切换失败,当前网络类型已经存在。 |
400 | IncorrectDBInstanceNetType | Current DB instance net type does not support this operation. | 操作失败,实例网络类型不支持。 |
400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | 链接地址名重复,请重新设置连接字符串。 |
400 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的连接专有网络ID无效。 |
400 | InvalidVpcInstanceId | Specified vpc instance id is not valid. | 操作失败,当前VPC实例ID无效。 |
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。 |
400 | InvalidVpcIdOrVswitchId.NotSupported | The specified vpcId or vSwitchId is not supported. | 指定的vpcId或者vSwitchId不支持,请检查实例信息 |
400 | InvalidPrivateIpAddress.Mismatch | Specified private IP address is not in the CIDR block of virtual switch. | VPC地址无效。 |
400 | InvalidVpcParameter | Specified VPCId VSwitchId or IPAddress or TunnelId is not valid. | VPCId VSwitchId不合法,请检查VPCId VSwitchId的正确性。 |
400 | InvalidBizType.Format | Specified biz type is not valid. | 当前业务类型不支持该操作。 |
400 | InvalidVSwitchId.NotFound | Specified vSwitch is not found in specified VPC. | 当前VPC内无可用交换机。 |
400 | InvalidVSwitchId.Mismatch | Specified instance and virtual switch are not in the same zone. | 实例和交换机不在同一可用区。 |
400 | InvalidPrivateIpAddress.AlreadyUsed | The specified IP is already used. | ip已被使用。 |
400 | VswitchIpExhausted | No available ip in the specified vswitch. | 指定的vswitch中没有可用的IP。 |
400 | MaxscaleNotSupport | Current custins can not support Maxscale. | 带有maxscale的实例不支持此操作。 |
400 | InvalidConnectionString.Format | Specified connection string is not valid. | 实例连接地址的字符串格式不正确。字符串前缀长度为5~40。 |
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 | RegionEndTimeDissolvedIndia | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. | 客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。 |
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. | 客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30 |
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 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | 您的信息不完整,请在操作前填写您的信息。 |
400 | System.SaleValidateFailed | Sales expression validation system error. | 销售表达式校验系统错误。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失败,数据库引擎不支持。 |
403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。 |
403 | IncorrectDBInstanceConnType | Current DB instance conn type does not support this operation. | 当前数据库实例的连接类型不支持此操作。 |
403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 实例当前存在未支付订单,请支付后重试。 |
404 | Endpoint.NotFound | Specified endpoint is not found. | 未找到指定独享代理连接地址的端口。 |
404 | Maxscale.NotFound | The related maxscale instance is not found. | 操作失败,未找到关联的maxscale实例。 |
404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交换机参数无效。 |
404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | 数据库实例ID不存在,请检查。 |
404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
404 | InsufficientResourceCapacity | Current cluster resources are insufficient. Try again later. | 当前集群的资源不足,请您稍后再试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-12-19 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-06-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-06-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|