该接口用于开启或者关闭RDS实例的数据库独享代理功能。
接口说明
调试
您可以在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 |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmy**** |
返回参数
示例
正常返回示例
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无效 |
| 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，请检查该参数的正确性。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2022-06-08 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||
|