ModifyDBProxyEndpoint_云数据库 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

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

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

代理连接地址 ID。可以通过接口 DescribeDBProxyEndpoint 查看。展开详情

示例值:gos787jog2wk0y****参考取值来源:
    DescribeDBProxyEndpoint
    CreateDBProxyEndpointAddress
ConfigDBProxyFeaturesstring

设置代理连接地址想要开通的代理功能,各功能之间以英文分号(;)隔开。格式:功能 1:开通情况;功能 2:开通情况;... ,末尾不加英文分号(;)。展开详情

示例值:ReadWriteSpliting:1;ConnectionPersist:0
RegionIdstring

地域 ID。可调用 DescribeRegions 获取。

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

读写分离中只读实例的最大延迟阈值,当只读实例延迟时间超过该值时,读取流量不发往该实例,单位:秒。不传该参数则保持原值。取值:0~3600展开详情

示例值:30
CausalConsistReadTimeoutstring

一致性读超时时间,单位:毫秒。默认为 10 毫秒,取值:0~60000

示例值:10
ReadOnlyInstanceDistributionTypestring

读权重分配模式。取值:展开详情

示例值:Standard
ReadOnlyInstanceWeightstring

自定义读权重分配,即传入主实例和只读实例的读请求权重。以 100 递增,最大值为 10000,格式:展开详情

示例值:{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}
DbEndpointOperatorstring

操作类型,取值:展开详情

示例值:Modify
DbEndpointAliasesstring

代理终端的备注信息。

示例值:test-proxy参考取值来源:
    DescribeDBProxyEndpoint
DbEndpointTypestring

代理终端的类型,保留参数,无需设置。

示例值:RWSplit
DbEndpointReadWriteModestring

读写类型,取值:展开详情

示例值:ReadWrite
DBProxyEngineTypestring

废弃参数,无需配置。

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

指定代理连接地址的可用区对应的交换机 ID。默认为代理实例默认终端对应的交换机 ID。可通过调用 DescribeVSwitches 接口查询已创建的交换机。

示例值:vsw-uf6adz52c2p****参考取值来源:
    DescribeVSwitches
EffectiveTimestring

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

示例值:MaintainTime
EffectiveSpecificTimestring

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

示例值:2023-05-06T07:08:09Z
DbEndpointMinSlaveCountstring

最小保留实例数

示例值:2枚举值:
VpcIdstring

指定代理连接地址的可用区对应的 VPC ID。默认为代理实例默认终端对应的 VPC ID。可通过调用 DescribeDBInstanceAttribute 接口查询实例默认 VPC。

示例值:vpc-2zeusejj******

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidVpcInstanceId
The specified VPC instance ID is invalid.诊断
400
InvalidEndPoint.Format
The specified EndPoint is not valid.诊断
400
InvalidEndpointType.Format
The specified EndpointType is invalid.诊断
400
IncorrectDBInstanceNetType
The current database instance network type does not support the operation.诊断
400
EndpointNum.Error
The number of endpoint is invalid.诊断
400
EndpointTypeOperation.NotSupport
The endpoint type does not support the operation.诊断
400
InvalidDBInstanceName
Specified parameter DBInstanceName is not valid.诊断
400
ClusterEndpoint.StatusNotValid
The cluster endpoint status is invalid.诊断
400
MaxscaleNotSupport
Current custins can not support Maxscale.诊断
400
InvalidAvZone.Format
Specified AvZone 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
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.诊断
400
APICallingFailed
Api calling failed.诊断
400
InvalidVSwitchId.Format
The specified vswitch Id format is incorrect.诊断
403
MaxScaleLevel.NotSupport
The current maxscale ins_num does not support this operation.诊断
403
ReadDBInstance.NotFound
The current database instance does not contain any read only instance.诊断
403
IncorrectKindCode
The current KindCode of the custins does not support the operation.诊断
403
IncorrectDBInstanceState
The current database instance state does not support the operation.诊断
403
IncorrectDBInstanceEngine
Current DB Instance engine does not support this operation.诊断
403
IncorrectDBInstanceType
Current DB instance type does 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
InvalidVswitchId
Specified conn vswitch id is not valid.诊断
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.诊断
403
InvalidInstanceLevel.Malformed
Current DB instance level does not support this operation.诊断
404
EndpointConfig.Invalid
Please check the endpoint config parameter.诊断
404
Readins.NotFound
The current instance does not contain any read only instance. The operation is not supported.诊断
404
Endpoint.NotFound
Specified endpoint is not found.诊断
404
EndpointType.NotFound
The specified endpoint type is not found.诊断
404
InvalidReadDBInstance.NotFound
The specified read only database instance does not exist.诊断
404
InvalidParam
The specified Weight is invalid.诊断
404
Maxscale.NotFound
The related maxscale instance is not found.诊断
404
IncorrectVswitchId
The specified parameter VSwitchId is not valid.诊断
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-27
新增请求参数CausalConsistReadTimeout
新增请求参数VpcId
2024-12-26
变更错误码400
2024-12-13
变更错误码400
2024-11-26
新增请求参数DbEndpointMinSlaveCount
2024-10-15
变更错误码400
变更错误码404
新增请求参数VSwitchId
新增请求参数EffectiveTime
新增请求参数EffectiveSpecificTime
2023-12-19
变更错误码400
变更错误码403
变更错误码404
2022-06-08
新增请求参数DBProxyEngineType