该接口用于开启或者修改RDS实例的数据库代理实例功能。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
说明
云数据库 RDS MySQL 集群系列于 2023 年 10 月 17 日起逐步在各个单元赠送代理数量为 1 的数据库独享代理服务,详情请参见【优惠】RDS MySQL 集群版赠送代理数量为 1 的数据库独享代理服务。
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyDBProxy | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | rm-uf6wjk5**** |
ConfigDBProxyService | string | 是 | 开启或关闭数据库代理,取值:
| Startup |
DBProxyInstanceNum | string | 否 | 开通代理实例数量,取值:1~16。默认值:1。 说明
更多的代理实例能处理更多的请求,您可以根据监控数据了解代理实例的负载,然后设置合理的代理实例数量。
| 1 |
RegionId | string | 否 | 地域 ID,可调用 DescribeRegions 获取。 | cn-hangzhou |
InstanceNetworkType | string | 否 | 实例的网络类型。当前仅支持 VPC 网络,取值:VPC。 说明
RDS MySQL 云盘版或 RDS PostgreSQL 开启数据库代理时,该参数必选。
| VPC |
VPCId | string | 否 | 实例所属 VPC ID。可调用 DescribeDBInstanceAttribute 接口查询。 说明
RDS MySQL 云盘版或 RDS PostgreSQL 开启数据库代理时,该参数必选。
| vpc-**** |
VSwitchId | string | 否 | 实例所属虚拟交换机 ID。可调用 DescribeDBInstanceAttribute 接口查询。 说明
RDS MySQL 云盘版或 RDS PostgreSQL 开启数据库代理时,该参数必选。
| vsw-**** |
DBProxyEngineType | string | 否 | 废弃参数,无需配置。 | normal |
DBProxyInstanceType | string | 否 | 数据库代理实例类型,取值:
| exclusive |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmy**** |
PersistentConnectionStatus | string | 否 | 是否开启连接保持。取值:
说明
| Disabled |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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或空字符串。 |
400 | InvalidOptimizationCategory.Format | Specified optimization category is not valid. | 参数OptimizationCategory无效 |
400 | MinorVersionNotSupport | The current database minor version does not support the operation. | 操作失败,当前小版本不支持该操作。 |
400 | InvalidParameters.Format | Specified parameter is not valid | 操作失败,指定的参数格式不合法。 |
400 | MaxscaleNotSupport | Current custins can not support Maxscale. | 带有maxscale的实例不支持此操作。 |
400 | InvalidTunnelId | Specified conn tunnel is not valid. | 指定的连接通道无效。 |
400 | InvalidRegion.Format | Specified Region 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. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
403 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的连接专有网络ID无效。 |
403 | IncorrectDBInstanceType | The database instance type does not support the operation. | 操作失败,当前数据库类型不支持该操作。 |
403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失败,数据库引擎不支持。 |
403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正确或为空 |
404 | MaxscaleCreating | The relative maxscale instance is being created or deleted. | - |
404 | Maxscale.NotFound | The relative maxscale instance is not found. | 操作失败,未找到关联的maxscale实例。 |
404 | InvalidVSwitchId.NotFound | The specified VSwitch is invalid. | 操作失败,无效的vSwitch,请检查该参数的正确性。 |
404 | InvalidParam | The parameter is invalid. | 操作失败,无效的参数。 |
404 | InsufficientResourceCapacity | The target availability zone does not have sufficient resources. | 目标可用区没有足够的资源。 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-12-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-12-12 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-11-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-11-14 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-06-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
|