文档中心

缓存数据库 Redis 版

连接管理

ModifyDBInstanceVisitAddress

调用 ModifyDBInstanceVisitAddress 接口修改目标 Redis 中指定连接地址的域名或端口号。

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs1111	实例 ID。说明您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
AddrType	String	是	Private	需要地址前缀的连接地址类型。取值范围如下： Public：公网地址。 Private：私网地址。 DirectLink：直连地址。说明如需修改直连地址或公网地址的连接地址，需要先申请对应的连接地址。直连地址和公网地址的申请方法，请参见申请直连地址和开启公网访问。关于 Redis 连接地址的更多信息，请参见连接地址类型。
NewAddressPrefix	String	否	testaddrpre	修改后的连接地址前缀。连接地址前缀需同时满足如下要求：由小写字母、数字或连字符（-）组成。以字母开头，字母或数字结尾。长度为 8~53 个字符。修改后的连接地址需要保证全局唯一，不可以与火山引擎中任何地域下的任何连接地址重名。注意若该参数不填，表示不修改连接地址前缀。当需要升级域名后缀（即 UpgradeRegionDomain 为 true）时，必须同时传入连接地址前缀信息（即 NewAddressPrefix 参数不允许为空。）当不需要升级域名后缀（即 UpgradeRegionDomain 为 false）时，您需至少在 NewAddressPrefix 或 NewPort 参数中选择一项进行修改。修改连接地址后，原有的连接会断开。请及时修改客户端的连接信息，使用新的连接地址来连接实例。连接实例的具体方法，请参见连接实例。当前仅支持修改连接地址前缀，即 redis.ivolces.com 或 redis.volces.com 之前的部分。更多详情，请参见修改连接地址。
NewPort	Integer	否	6379	修改后的连接地址端口号。连接地址类型不同，支持的端口号取值范围不同：私网地址和公网地址支持的端口号范围均为 1024~65535。直连地址支持的端口号范围为 1024~4000 和 5100~64512。注意若该参数不填，表示不修改连接地址的端口号。当不需要升级域名后缀（即 UpgradeRegionDomain 为 false）时，您需至少在 NewAddressPrefix 或 NewPort 参数中选择一项进行修改。修改连接地址或端口号后，原有的连接会断开。请及时修改客户端的连接信息，使用新的端口号来连接实例。连接实例的具体方法，请参见连接实例。修改端口会将导致部分服务的访问在短时间内受到影响，请谨慎操作。更多详情，请参见修改端口号。
UpgradeRegionDomain	Boolean	否	false	是否升级连接地址的域名后缀。取值范围如下： true：升级。 false（默认值）：不升级。注意当需要升级域名后缀（即 UpgradeRegionDomain 为 true）时，必须同时传入连接地址前缀信息（即 NewAddressPrefix 参数不允许为空。）升级域名后缀后，原有的连接会断开，请及时修改客户端的连接信息，使用新的连接地址来连接实例。连接实例的具体方法，请参见连接实例。连接地址域名后缀升级后不支持再降级回原来的后缀，请谨慎操作。升级后的连接地址域名后缀会自动包含实例所属地域信息，即域名后缀会由 redis.ivolces.com（或 redis.volces.com）变为redis.{Region ID}.ivolces.com（或 redis.{Region ID}.volces.com），旧的连接地址会保留 12 小时，12 小时保留期到期后会被自动释放。更多详情，请参见升级域名后缀。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceVisitAddress&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
    "InstanceId": "redis-cn0212gzmh2xs1111",​
    "AddrType": "Private",​
    "NewAddressPrefix": "testaddrpre",​
    "NewPort": 6379​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202306041104205y43100232280022D312D31",​
        "Action": "ModifyDBInstanceVisitAddress",​
        "Version": "2020-12-07",​
        "Service": "Redis",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.09.21 14:23:31

这个页面对您有帮助吗？

有用

无用