该接口用于创建RDS实例独享代理的连接地址。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:CreateDBProxyEndpointAddress | WRITE |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-t4n3**** |
| DBProxyEndpointId | string | 是 | 独享代理连接地址ID。可以调用DescribeDBProxyEndpoint接口查询。 | ta9um4**** |
| ConnectionStringPrefix | string | 是 | 新的独享代理连接地址的前缀。自定义。 | test1234 |
| DBProxyNewConnectStringPort | string | 否 | 新的独享代理连接地址的端口，默认值：
| 3306 |
| DBProxyConnectStringNetType | string | 是 | 新的独享代理连接地址的网络类型，取值：
默认值：Classic。 | Public |
| VPCId | string | 否 | 新的独享代理连接地址的VPC ID。可调用DescribeDBInstanceAttribute接口查询。 说明
当DBProxyConnectStringNetType取值为VPC时， 必须传入此参数。
| vpc-bp**** |
| VSwitchId | string | 否 | 新的独享代理连接地址的虚拟交换机ID。可调用DescribeDBInstanceAttribute接口查询。 说明
当DBProxyConnectStringNetType取值为VPC时， 必须传入此参数。
| vsw-bp**** |
| DBProxyEngineType | string | 否 | 预留参数，无需配置。 | normal |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmy**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidPort.Malformed | Specified port is not valid. | 指定的端口无效。 |
| 400 | NetTypeExists | Specified net type already existed. | 网络类型切换失败，当前网络类型已经存在。 |
| 400 | IncorrectDBInstanceNetType | Current DB instance net type does not support this operation. | 操作失败，实例网络类型不支持。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | 链接地址名重复，请重新设置连接字符串。 |
| 400 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的连接专有网络ID无效。 |
| 400 | InvalidVpcInstanceId | Specified vpc instance id is not valid. | 操作失败，当前VPC实例ID无效。 |
| 400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称（DBInstanceName）无效，请检查参数值是否为null或空字符串。 |
| 400 | InvalidVpcIdOrVswitchId.NotSupported | The specified vpcId or vSwitchId is not supported. | 指定的vpcId或者vSwitchId不支持，请检查实例信息 |
| 400 | InvalidPrivateIpAddress.Mismatch | Specified private IP address is not in the CIDR block of virtual switch. | VPC地址无效。 |
| 400 | InvalidVpcParameter | Specified VPCId VSwitchId or IPAddress or TunnelId is not valid. | VPCId VSwitchId不合法，请检查VPCId VSwitchId的正确性。 |
| 400 | InvalidBizType.Format | Specified biz type is not valid. | 当前业务类型不支持该操作。 |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败，该实例状态下不支持此操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 404 | Endpoint.NotFound | Specified endpoint is not found. | 未找到指定独享代理连接地址的端口。 |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitch is invalid. | 操作失败，无效的vSwitch，请检查该参数的正确性。 |
| 404 | Maxscale.NotFound | The related maxscale instance is not found. | 操作失败，未找到关联的maxscale实例。 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交换机参数无效。 |
| 404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | 数据库实例ID不存在，请检查。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-06-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2022-06-08 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|