ModifyDBProxyInstance_云数据库 RDS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
说明 云数据库 RDS MySQL 集群系列于 2023 年 10 月 17 日起逐步在各个单元赠送代理数量为 1 的数据库独享代理服务,详情请参见【优惠】RDS MySQL 集群版赠送代理数量为 1 的数据库独享代理服务

流控信息

请求速率为10/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
rds:ModifyDBProxyInstance
Update
DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
rds:ResourceTag
rds:ResourceTag

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

示例值:rm-t4n3a****参考取值来源:
    CloneDBInstance
    CreateDBInstance
    ReceiveDBInstance
    ModifyDBInstanceSpec
    RecoveryDBInstance
    DescribeDBInstances
    CalculateDBInstanceWeight
    MigrateDBNodes
    UpgradeDBInstanceMajorVersion
    TransformDBInstancePayType
    EvaluateLocalExtendDisk
    RestoreDdrTable
    RebuildReplicationLink
DBProxyInstanceTypestring

数据库代理实例类型,取值:展开详情

示例值:exclusive参考取值来源:
    DescribeDBProxy
DBProxyInstanceNumstring

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

示例值:2参考取值来源:
    DescribeDBProxy
EffectiveTimestring

生效时间,取值:展开详情

示例值:MaintainTime
EffectiveSpecificTimestring

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

示例值:2019-07-10T13:15:12Z
RegionIdstring

地域 ID。可调用 DescribeRegions 获取。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
DBProxyEngineTypestring

废弃参数,无需配置。

示例值:normal参考取值来源:
    DescribeDBProxyEndpoint
VSwitchIdsstring

废弃参数,无需配置。

示例值: vsw-uf6adz52c2p****参考取值来源:
    DescribeVSwitches
DBProxyNodesarray<object>

代理节点列表。展开详情

MigrateAZarray<object>

迁移代理可用区列表。展开详情

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:65C55572-530E-4A53-BE03-1D08CAF0F046

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidDBInstanceName
Specified parameter DBInstanceName is not valid.诊断
400
InvalidParameters.Format
Specified parameter is not valid诊断
400
InvalidAvZone.Format
Specified AvZone is not valid.诊断
400
ErrorMxsServiceInsNum.Error
The Maxscale serviceIns num must be 1.诊断
400
TaskExists
Specified task have existed.诊断
400
InvalidVSwitchIds
Specified vSwitchId is invalid.诊断
400
MirrorInsExists
Specified DB instance mirror ins already existed.诊断
400
APICallingFailed
Api calling failed.诊断
400
InvalidDBProxyNodes.AzProximity
current proxy is open az proximity and target proxy not support az proximity.诊断
400
InvalidDBProxyNodes.General
general-purpose proxy does not support more than 2 nodes.诊断
400
InvalidTargetAvailabilityZone
All endpoint vswitchId must be in the target availability zone.诊断
400
InvalidDBProxyNodes.Node
must set DBProxyNodes params with more than 2 proxy nodes.诊断
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.诊断
400
InvalidMigrateAZInfo
Invalid MigrateAZ params.诊断
400
InvalidDBProxyNodes.ZoneIdNotUnique
ZoneIds is not unique.诊断
400
InvalidVSwitchId.Format
The specified vswitch Id format is incorrect.诊断
400
InvalidEndPoint.Format
The specified EndPoint is not valid.诊断
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.诊断
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
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.诊断
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.诊断
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.诊断
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.诊断
400
Pay.NoCreditCard
No credit cards.诊断
400
VpcNetworkTypeNotSupport
The vpc network type instance does not support this operation.诊断
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.诊断
400
MappingInstanceLevel.NotFound
Can not find the mapping instance level.诊断
403
DBInstanceStatusNotActive
Current DB instance status should be active.诊断
403
InvalidInstanceLevel.Malformed
The specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.诊断
403
NotHaveProxy
The current instance does not have a proxy.诊断
403
MaxscaleMinorVersionNotSupport
The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.诊断
403
IncorrectDBInstanceType
Current DB instance engine and type does not support operations.诊断
403
IncorrectDBInstanceEngine
Current DB Instance engine does not support this operation.诊断
403
IncorrectKindCode
Current custins kindCode does not support this operation.诊断
403
IncorrectDBType
The current DB type does not support this operation.诊断
403
IncorrectDBInstanceState
Current DB instance state does not support this operation.诊断
403
InvalidKmsKey
Kms key is disabled.诊断
403
InvalidVswitchId
Specified conn vswitch id is not valid.诊断
403
IncorrectDBInstance
The current DB instance does not support this operation.诊断
403
MaxscaleInstanceNotSupport
Instances with maxscale instance do not support this operation.诊断
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.诊断
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.诊断
404
IncorrectDBInstanceLockMode
Current DB instance lock mode does not support this operation.诊断
404
InvalidDBInstanceClass.NotFound
Specified DB instance class is not found.诊断
404
InsufficientResourceCapacity
The target availability zone does not have sufficient resources.诊断
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.诊断

变更历史

变更时间变更内容概要操作
2025-02-28
变更错误码400
2025-02-27
变更请求参数MigrateAZ
2024-10-15
变更错误码400
新增请求参数DBProxyNodes
新增请求参数MigrateAZ
2024-07-12
变更错误码400
2024-05-07
变更错误码403
2024-04-25
新增请求参数VSwitchIds
2024-01-09
变更错误码404
2023-12-19
变更错误码400
变更错误码403
新增错误码404
2023-05-15
变更错误码403
  • 1
  • 2
  • 10 条/页