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

文档中心

立即注册

导航

CreateDBEndpointDirectLinkAddress

最近更新时间：2025.02.14 11:19:37首次发布时间：2025.02.14 11:19:37

调用 CreateDBEndpointDirectLinkAddress 接口为目标 Redis 实例申请直连地址。

请求类型

异步请求。

注意事项

客户端在首次使用直连地址访问实例时，会将直连地址解析为 Redis 给所有分片所分配的固定虚拟 IP（VIP）地址，之后通过 Redis Cluster 协议路由到各数据分片。因此您的客户端需要支持 Redis Cluster 协议。
如果释放直连地址后又重新申请了直连地址，新申请直连地址所对应的 IP 地址可能会与之前申请的直连地址所对应的 IP 不一样。建议直接使用直连地址域名而不是 IP地址来访问 Redis 实例，避免出现因 IP 地址变化导致实例无法连接的情况。
直连地址的访问方式节约了通过代理处理请求的时间，理论上可以缩短服务端响应客户端的时间，但也会因此失去自动负载均衡、自动读写分离等高级特性，建议您根据自身情况谨慎选择连接地址类型。更多详情，请参见申请直连地址。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
Port	Integer	否	6379	设置直连地址的端口号，取值范围为 1024~4000 和 5100~64512。说明若该参数不填，直连地址默认使用 6379端口号。申请完成后，您还可以调用 ModifyDBInstanceVisitAddress 接口修改直连地址的域名和端口号。
ClientToken	String	否	WbiAlPqJM6tMoSOYhTOYhT	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

POST https://redis.volcengineapi.com/?Action=CreateDBEndpointDirectLinkAddress&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****",
    "Port": 6379
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "CreateDBEndpointDirectLinkAddress",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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