调用ModifyDBProxy接口开启或者关闭RDS实例的数据库代理功能。
调用该接口时,实例要求如下:
MySQL:
- MySQL 8.0三节点企业版(内核小版本20191204或以上)
- MySQL 8.0高可用版(内核小版本20190915或以上)
- MySQL 5.7三节点企业版(内核小版本20191128或以上)
- MySQL 5.7高可用版(内核小版本20190925或以上)
- MySQL 5.6高可用版(内核小版本20200229或以上)
PostgreSQL:
- 实例大版本为PostgreSQL 15、14、13、12、11或10。
- 实例存储类型为云盘。
- 实例系列为高可用版。
- 实例为主实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyDBProxy | 系统规定参数。取值:ModifyDBProxy。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx | RDS实例ID。可调用DescribeDBInstances接口查询。 |
ConfigDBProxyService | String | 是 | Startup | 开启或关闭数据库独享代理,取值:
|
DBProxyInstanceNum | String | 否 | 1 | 开通代理实例数量,取值:1~60。默认值:1。
说明 更多的代理实例能处理更多的请求,您可以根据监控数据了解代理实例的负载,然后设置合理的代理实例数量。
|
RegionId | String | 否 | cn-hangzhou | 地域ID,可以调用DescribeRegions接口查看地域ID。 |
InstanceNetworkType | String | 否 | VPC | 实例的网络类型。当前仅支持VPC网络,取值:VPC。
说明 RDS MySQL云盘版或RDS PostgreSQL开启数据库代理时,该参数必选。
|
VPCId | String | 否 | vpc-xxxxxxxxxxxx | 实例所属VPC ID。可调用DescribeDBInstanceAttribute接口查询。
说明 RDS MySQL云盘版或RDS PostgreSQL开启数据库代理时,该参数必选。
|
VSwitchId | String | 否 | vsw-xxxxxxxxxxxx | 实例所属虚拟交换机ID。可调用DescribeDBInstanceAttribute接口查询。
说明 RDS MySQL云盘版或RDS PostgreSQL开启数据库代理时,该参数必选。
|
DBProxyEngineType | String | 否 | normal | 内部参数,无需传入值。 |
ResourceGroupId | String | 否 | rg-acfmy***** | 资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | FC452BB1-EED8-4278-95C7-0324B3710DF1 | 请求ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=ModifyDBProxy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&ConfigDBProxyService=Startup
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyDBProxyResponse>
<RequestId>FC452BB1-EED8-4278-95C7-0324B3710DF1</RequestId>
</ModifyDBProxyResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MaxscaleAlreadyExist | The Maxscale is already existed. | Maxscale已存在。 |
400 | MaxscaleNotSupport | Maxscale not supported | 操作失败,实例不支持独享代理,请检查开通独享代理的配置信息。 |
400 | NetWork.NotFound | NetWork.NotFound | 网络不可用。 |
400 | InvalidVpcParameter | Either VPC ID or vSwitch ID is incorrect. Please check again. | 操作失败,请检查VPC参数正确性。 |
400 | MaxscaleInternalError | Database proxy status is CLASS_CHANGING. | DB代理状态是规格变更中,请稍后重启。 |
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。 |
404 | Maxscale.NotFound | The relative maxscale instance is not found. | 操作失败,未找到关联的maxscale实例。 |
404 | InvalidVSwitchId.NotFound | The specified VSwitch is invalid. | 操作失败,无效的VSwitch,请检查该参数的正确性。 |
访问错误中心查看更多错误码。