首页 云数据库 RDS 开发参考 API参考 API目录 数据库独享代理(读写分离) ModifyDBProxy - 开启或关闭实例数据库独享代理功能

ModifyDBProxy - 开启或关闭实例数据库独享代理功能

更新时间: 2023-09-20 11:16:15

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

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ModifyDBProxyWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****
ConfigDBProxyServicestring

开启或关闭数据库独享代理,取值:

  • Startup:开启代理服务
  • Shutdown:关闭代理服务
Startup
DBProxyInstanceNumstring

开通代理实例数量,取值:1~16。默认值:1

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

地域ID,可调用DescribeRegions获取。

cn-hangzhou
InstanceNetworkTypestring

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

说明 RDS MySQL云盘版或RDS PostgreSQL开启数据库代理时,该参数必选。
VPC
VPCIdstring

实例所属VPC ID。可调用DescribeDBInstanceAttribute接口查询。

说明 RDS MySQL云盘版或RDS PostgreSQL开启数据库代理时,该参数必选。
vpc-****
VSwitchIdstring

实例所属虚拟交换机ID。可调用DescribeDBInstanceAttribute接口查询。

说明 RDS MySQL云盘版或RDS PostgreSQL开启数据库代理时,该参数必选。
vsw-****
DBProxyEngineTypestring

预留参数,无需配置。

normal
ResourceGroupIdstring

资源组ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

FC452BB1-EED8-4278-95C7-0324B3710DF1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400MaxscaleAlreadyExistThe Maxscale is already existed.Maxscale已存在。
400MaxscaleNotSupportMaxscale not supported操作失败,实例不支持独享代理,请检查开通独享代理的配置信息。
400NetWork.NotFoundNetWork.NotFound网络不可用。
400InvalidVpcParameterEither VPC ID or vSwitch ID is incorrect. Please check again.操作失败,请检查VPC参数正确性。
400MaxscaleInternalErrorDatabase proxy status is CLASS_CHANGING.DB代理状态是规格变更中,请稍后重启。
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400InvalidOptimizationCategory.FormatSpecified optimization category is not valid.参数OptimizationCategory无效
404MaxscaleCreatingThe relative maxscale instance is being created or deleted.-
404Maxscale.NotFoundThe relative maxscale instance is not found.操作失败,未找到关联的maxscale实例。
404InvalidVSwitchId.NotFoundThe specified VSwitch is invalid.操作失败,无效的vSwitch,请检查该参数的正确性。

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

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
2022-06-08OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:DBProxyEngineType
阿里云首页 云数据库 RDS 相关技术圈