该接口用于修改RDS实例独享代理的连接地址。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyDBProxyEndpointAddress | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-t4n3a**** |
DBProxyEndpointId | string | 是 | 独享代理连接地址ID。可以通过接口DescribeDBProxyEndpoint查询。 | ta9um4**** |
DBProxyNewConnectString | string | 否 | 目标独享代理连接地址的前缀。自定义。 说明
至少传入DBProxyNewConnectString和DBProxyNewConnectStringPort其中一个参数。
| test123456 |
DBProxyNewConnectStringPort | string | 否 | 目标独享代理连接地址的端口。自定义。 说明
至少传入DBProxyNewConnectString和DBProxyNewConnectStringPort其中一个参数。
| 3307 |
DBProxyConnectStringNetType | string | 否 | 需要修改的独享代理连接地址的网络类型,取值:
MySQL默认值:Classic。 说明
RDS PostgreSQL时,该参数必选,支持Public和VPC。
| Public |
DBProxyEngineType | string | 否 | 预留参数,无需配置。 | normal |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidConnectionString.Format | Specified connection string is not valid. | 实例连接地址的字符串格式不正确。字符串前缀长度为5~40。 |
400 | InvalidPort.Malformed | Specified port is not valid. | 指定的端口无效。 |
400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | 链接地址名重复,请重新设置连接字符串。 |
400 | InvalidConnectionStringOrPort.Duplicate | Specified connection string or port want to be modified is the same with current net type. | 连接串或端口号重复,请修改。 |
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。 |
400 | OtherEndpoint.Exist | Other endpoint already exist. | endpoint已存在。 |
403 | ParameterLeastAssociate | Must input at least one optional parameter. | 还原时间或备份集不能同时为空,请设置后重试。 |
403 | NetTypeChangeTimesExceeded | Exceeding the daily net type change times of the DB instance. | - |
404 | InvalidConnectionString.NotFound | Specified connection string or net type is not found. | 连接串不存在。请检查连接串是否正确。 |
404 | InsufficientResourceCapacity | There is insufficient capacity available for the requested instance. | - |
404 | Endpoint.NotFound | Specified endpoint is not found. | 未找到指定独享代理连接地址的端口。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-06-08 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|