调用ModifyDBProxy接口开启或者关闭RDS实例的数据库独享代理功能。

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

调用该接口时，实例必须为MySQL 8.0高可用版（本地SSD盘）。

调试

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

请求参数

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

系统规定参数，取值：ModifyDBProxy。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

实例ID。
ConfigDBProxyService String 是 Startup

开启或关闭数据库独享代理，取值：

  • Startup：开启代理服务；
  • Shutdown：关闭代理服务。
RegionId String 否 cn-hangzhou

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

DBProxyInstanceNum String 否 1

开通代理实例数量，取值：1~60。默认值：1。

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

实例的网络类型。当前仅支持VPC网络，取值：VPC。

VPCId String 否 vpc-xxxxxxxxxxxx

实例所属VPC ID。
VSwitchId String 否 CloudInstanceId

实例所属虚拟交换机ID。
AccessKeyId String 否 LTAIfCxxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
RequestId String FC452BB1-EED8-4278-95C7-0324B3710DF1

请求ID。

示例

请求示例


http(s)://rds.aliyuncs.com/?Action=ModifyDBProxy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&ConfigDBProxyService=Startup
&<公共请求参数>

正常返回示例

XML 格式 

<ModifyDBProxyResponse>
  <RequestId>FC452BB1-EED8-4278-95C7-0324B3710DF1</RequestId>
 </ModifyDBProxyResponse>

JSON 格式 

{
	"RequestId":"FC452BB1-EED8-4278-95C7-0324B3710DF1"
}

错误码

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