文档

ModifyDBProxyInstance - 变更数据库代理实例配置

更新时间:

该接口用于变更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:ModifyDBProxyInstanceWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-t4n3a****
DBProxyInstanceTypestring

数据库代理实例类型,取值:

  • common:通用型代理
  • exclusive:独享型代理(默认)
exclusive
DBProxyInstanceNumstring

设置代理实例数量。当取值为 0 的时候,表示这个实例关闭此种类型代理服务。取值:1~16

说明 更多的代理实例能处理更多的请求,您可以根据监控数据了解代理实例的负载,然后设置合理的代理实例数量。
2
EffectiveTimestring

生效时间,取值:

  • Immediate:立即生效。
  • MaintainTime:在可运维时间段内生效,请参见 ModifyDBInstanceMaintainTime。
  • SpecificTime:指定时间生效。

默认值:MaintainTime

MaintainTime
EffectiveSpecificTimestring

指定时间生效。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 EffectiveTimeSpecificTime 时,该参数必传。
2019-07-10T13:15:12Z
RegionIdstring

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
DBProxyEngineTypestring

废弃参数,无需配置。

normal
VSwitchIdsstring

指定迁移至目标可用区对应的交换机 ID。可通过调用 DescribeVSwitches 接口查询已创建的交换机。

说明 当前仅支持 RDS MySQL 云盘版代理实例迁移可用区
vsw-uf6adz52c2p****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

65C55572-530E-4A53-BE03-1D08CAF0F046

示例

正常返回示例

JSON格式

{
  "RequestId": "65C55572-530E-4A53-BE03-1D08CAF0F046"
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400InvalidParameters.FormatSpecified parameter is not valid操作失败,指定的参数格式不合法。
400InvalidAvZone.FormatSpecified AvZone is not valid.指定的AvZone不合法,请检查该参数的正确性。
400ErrorMxsServiceInsNum.ErrorThe Maxscale serviceIns num must be 1.Maxscale必须为1.
400TaskExistsSpecified task have existed.任务已存在。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear 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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud 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。
400RegionEndTimeDissolvedAustraliaCloud 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
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
403DBInstanceStatusNotActiveCurrent DB instance status should be active.操作失败,请检查实例运行状态。
403InvalidInstanceLevel.MalformedThe specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.操作失败,规定的规格码不支持该终端数,请检查分片数量和当前的终端数。
403NotHaveProxyThe current instance does not have a proxy.当前实例没有代理。
403MaxscaleMinorVersionNotSupportThe Maxscale version used by the instance is too low, please upgrade the Maxscale version first.实例使用数据库代理的版本过低,请先升级数据库代理版本。
403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.操作失败,当前数据库实例引擎和类型不支持。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403IncorrectKindCodeCurrent custins kindCode does not support this operation.操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。
403IncorrectDBTypeThe current DB type does not support this operation.操作失败,当前数据库类型不支持此操作,请使用其他类型的数据库进行操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403InvalidKmsKeyKms key is disabled.Kms key已禁用。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
403DBInstanceStatusNotActiveThe status of the current instance is not active.操作失败,请检查实例运行状态。
403IncorrectDBInstanceThe current DB instance does not support this operation.操作失败,当前实例不支持此操作。
403MaxscaleInstanceNotSupportInstances with maxscale instance do not support this operation.带Maxscale代理的实例不支持此操作。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
404InvalidDBInstanceClass.NotFoundSpecified DB instance class is not found.当前选择的配置或规格不存在或已停售,请重新选择。
404InsufficientResourceCapacityThe target availability zone does not have sufficient resources.目标可用区没有足够的资源。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
2024-04-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:VSwitchIds
2024-01-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
2023-12-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    新增错误码:404
2023-05-15OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2022-06-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:DBProxyEngineType
  • 本页导读 (1)