该接口用于开启或者修改RDS实例的数据库代理实例功能。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
说明
云数据库 RDS MySQL 集群系列于 2023 年 10 月 17 日起逐步在各个单元赠送代理数量为 1 的数据库独享代理服务，详情请参见【优惠】RDS MySQL 集群版赠送代理数量为 1 的数据库独享代理服务。
相关功能文档
注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:ModifyDBProxy | update | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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。 说明
RDS MySQL 云盘版或 RDS PostgreSQL 开启数据库代理时，该参数必选。
| VPC |
| VPCId | string | 否 | 实例所属 VPC ID。可调用 DescribeDBInstanceAttribute 接口查询。 说明
RDS MySQL 云盘版或 RDS PostgreSQL 开启数据库代理时，该参数必选。
| vpc-**** |
| VSwitchId | string | 否 | 实例所属虚拟交换机 ID。可调用 DescribeDBInstanceAttribute 接口查询。 说明
RDS MySQL 云盘版或 RDS PostgreSQL 开启数据库代理时，该参数必选。
| vsw-**** |
| DBProxyEngineType | string | 否 | 废弃参数，无需配置。 | normal |
| DBProxyInstanceType | string | 否 | 数据库代理实例类型，取值：
| exclusive |
| 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 |
返回参数
示例
正常返回示例
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或空字符串。 |
| 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 | MaxscaleNotSupport | Current custins can not support Maxscale. | 带有maxscale的实例不支持此操作。 |
| 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 | 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. | 存在禁止下单的标签，请联系您的分销商处理 |
| 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. | 指定的地域无效。 |
| 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. | 操作失败，无效的vSwitch，请检查该参数的正确性。 |
| 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. | 指定的主机信息不存在。 |
| 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服务失败，请求处理失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-15 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-12-26 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-12-12 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-11-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-11-14 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-09-08 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-06-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |