文档

ModifyDBInstanceConnectionString - 修改实例的连接地址和端口

更新时间:

修改Redis实例的连接地址和端口。

接口说明

该 API 对应的控制台操作请参见修改连接地址

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:ModifyDBInstanceConnectionStringupdate
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
NewConnectionStringstring

新连接地址的前缀。Redis 连接地址格式为:<前缀>.redis.rds.aliyuncs.com。地址前缀需由小写英文字母、数字组成,但必须以小写字母开头,长度为 8~40 个字符。

说明 请求参数 NewConnectionStringPort 两者中必须传入一项。
standardredis123
CurrentConnectionStringstring

Redis 实例当前的连接地址。

r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
Portstring

Redis 服务的端口号,取值范围:1024~65535

说明 请求参数 NewConnectionStringPort 两者中必须传入一项。
6379
IPTypestring

地址的网络类型,取值:

  • Private:专有网络。
  • Public:公网。
Public

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

1790D68A-465C-44E3-BC24-9732652961F9

示例

正常返回示例

JSON格式

{
  "RequestId": "1790D68A-465C-44E3-BC24-9732652961F9"
}

错误码

HTTP status code错误码错误信息描述
400NewConnectionStringNotSupportSpecified newConnectionString is not supported.-
400InvalidIPType.FormatSpecified parameter IPType is not supported.-
400InvalidConnectionStringOrPort.DuplicateSpecified connection string or port want to be modified is the same with current net type.连接串或者端口已存在
400InvalidConnectionString.FormatSpecified connection string is not valid.连接串非法,请选用新的

访问错误中心查看更多错误码。