ModifyDBInstanceVisitAddress--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceVisitAddress

最近更新时间：2024.09.13 11:12:18首次发布时间：2024.05.10 10:18:06

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

请求类型

异步请求。

请求参数

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

返回参数

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

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceVisitAddress&Version=2020-12-07 HTTP/1.1
Host: redis.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-cn0212gzmh2xs****",
    "AddrType": "Private",
    "NewAddressPrefix": "testaddrpre",
    "NewPort": 6379
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104205y4310023228002****",
        "Action": "ModifyDBInstanceVisitAddress",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-north-1"
    },
    "Result": null
}

错误码

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