该接口用于修改RDS MySQL集群系列实例的Endpoint连接地址信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyDBInstanceEndpointAddress | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 该参数用于保证请求的幂等性,防止重复提交请求。参数值由客户端生成,保证在不同请求间唯一。 该参数值由 ASCII 字符组成,最长不超过 64 个字符,不能包含非 ASCII 字符。 | 6000170000591aed949d0f**** |
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 查询。 | rm-**** |
DBInstanceEndpointId | string | 是 | 实例的 Endpoint ID。可调用 DescribeDBInstanceEndpoints 查询。 | ep-**** |
ConnectionString | string | 是 | 待修改的实例某个连接地址,可以是内网或外网连接地址。 | rm-uf6wjk5****.mysql.rds.aliyuncs.com |
VpcId | string | 否 | 内网连接的 VPC ID。 | vpc-bp17xdic25d**** |
VSwitchId | string | 否 | 内网连接的交换机 ID。 | vsw-bp12u14ecz**** |
PrivateIpAddress | string | 否 | 内网 IP 地址。 | 172.16.XX.XX |
ConnectionStringPrefix | string | 否 | 目标连接地址的前缀。只能修改 ConnectionString 参数的前缀部分。 | rm-bp181qoj4s34m33**** |
Port | string | 否 | 目标连接的端口号。 | 3306 |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": {
"DBInstanceName": "rm-****",
"DBInstanceEndpointId": "ep-****"
},
"RequestId": "90496720-2319-42A8-87CD-FCE4DF95EBED"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidSourceCategory | specified source category is invalid. | 指定的源类别无效。 |
400 | InvalidDBInstanceConnType.Format | Specified DB instance conn type is not valid. | 操作失败,当前数据库实例的连接类型不支持此操作。 |
400 | InvalidConnectionString.Format | Specified connection string is not valid. | 实例连接地址的字符串格式不正确。字符串前缀长度为5~40。 |
400 | InvalidParamCombination | VPCId,VSwitchId,PrivateIPAddress can not be modified with ConnectionStringPrefix,Port. | 参数组合需要满足VPCId、VSwitchId、PrivateIPAddress为一组,ConnectionStringPrefix、Port为一组的要求。 |
400 | EmptyEndpointNodeConfig | Specified endpoint has no nodes, add node to endpoint first. | endpoint下没有挂任何节点,请先给endpoint添加节点。 |
400 | APICallingFailed | Api called failed, please check vpc vsw vip | 接口调用失败,请检查VPC、VSW、VIP等参数。 |
400 | InvalidEngineVersion.NotSupport | The specified parameter "EngineVersion" is not valid. | 无效的引擎版本参数。请重新设置:MySQL:5.5/5.6/5.7;SQLServer:2008r2/2012;PostgreSQL:9.4;PPAS:9.3。 |
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. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
403 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的连接专有网络ID无效。 |
403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正确或为空 |
404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | 数据库实例ID不存在,请检查。 |
404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败,实例处于锁定状态。 |
404 | Endpoint.NotFound | Specified endpoint is not existed. | 目标的endpoint不存在。 |
404 | InvalidConnectionString.NotFound | Specified connection string or net type is not found. | 连接串不存在。请检查连接串是否正确。 |
404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-05-09 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|