调用ModifyDBProxyEndpoint接口修改RDS实例数据库独享代理的连接地址信息。

RDS提供数据库独享代理服务,包括读写分离、短连接优化等能力。详情请参见数据库独享代理

调用该接口时,实例必须满足以下条件:

  • 实例已开通数据库独享代理功能。
  • 实例版本如下:
    • MySQL 8.0三节点企业版(内核小版本20191204或以上)
    • MySQL 8.0高可用版(内核小版本20190915或以上)
    • MySQL 5.7三节点企业版(内核小版本20191128或以上)
    • MySQL 5.7高可用版(内核小版本20190925或以上)
    • MySQL 5.6高可用版(内核小版本20200229或以上)

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyDBProxyEndpoint

系统规定参数,取值:ModifyDBProxyEndpoint

DBInstanceId String rm-t4n3axxxxx

实例ID。

DBProxyEndpointId String ta9um4xxxxx

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

ConfigDBProxyFeatures String ReadWriteSpliting:1;ConnectionPersist:0;

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

功能取值:

  • ReadWriteSpliting:读写分离
  • ConnectionPersist:短连接优化
  • TransactionReadSqlRouteOptimizeStatus:事务拆分

开通情况取值:

  • 1:功能已开通
  • 0:功能未开通
RegionId String cn-hangzhou

地域ID,可以通过接口DescribeRegions查看地域ID。

ReadOnlyInstanceMaxDelayTime String 30

读写分离的延迟阈值,当只读实例延迟时间超过该阈值时,读取流量不发往该实例,单位:秒。不传该参数则保持原值。取值:30~3600。默认值:30

说明 开通读写分离时才需要传入该参数。
ReadOnlyInstanceDistributionType String Standard

读权重分配模式,详情请参见读权重分配。取值:

  • Standard:按规格权重自动分配
  • Custom:自定义分配权重
说明 开通读写分离时才需要传入该参数。
ReadOnlyInstanceWeight String {“rm-uf6wjk5xxxx“:”500”,”rr-tfhfgk5xxx”:”200”...}

自定义读权重分配,即传入主实例和只读实例的读请求权重。以100递增,最大值为10000,格式:{“实例1ID“:”权重”,”实例2ID”:”权重”...}

说明ReadOnlyInstanceDistributionType=Custom时,需要传入该参数。

返回数据

名称 类型 示例值 描述
RequestId String 6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=ModifyDBProxyEndpoint
&DBInstanceId=rm-uf6wjk5xxxxxxx
&DBProxyEndpointId=ta9um4xxxxx
&ConfigDBProxyFeatures=ReadWriteSpliting:1;ConnectionPersist:1;
&ReadOnlyInstanceMaxDelayTime=30
&ReadOnlyInstanceDistributionType=Standard
&<公共请求参数>

正常返回示例

XML 格式

<ModifyDBProxyEndpointResponse>
    <RequestId>6B50D92C-1960-4D4F-A290-AFADD6B1A5C8</RequestId>
</ModifyDBProxyEndpointResponse>

JSON 格式

{
	"RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}

错误码

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