文档

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

返回参数

名称类型描述示例值
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.任务已存在。
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.操作失败,当前实例不支持此操作。
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.目标可用区没有足够的资源。

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

变更历史

变更时间变更内容概要操作
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)
文档反馈