调用AllocateDirectConnection为Redis集群实例申请直连地址。

集群架构的Redis实例默认提供代理(proxy)连接方式,您也可以开通直连访问并获取直连地址,客户端通过该地址可绕过代理,像连接原生Redis集群一样连接阿里云Redis集群,从而降低链路开销,进一步提升Redis服务的响应速度。更多详情请参见开通直连访问

调用本接口的Redis实例需满足下述条件:

  • Redis实例为集群架构。
  • Redis实例的引擎版本为4.0(社区版)或5.0(社区版、企业版)。
  • Redis实例的网络类型为专有网络。如果当前为经典网络,您可以调用SwitchNetwork接口将其切换为专有网络。
  • Redis实例的SSL加密功能需处于关闭状态。如果已开启SSL加密功能,您可以调用ModifyInstanceSSL接口将其关闭。
  • Redis实例所属的交换机需具备充足的可分配的IP地址数,详情请参见查询Redis实例所属交换机可分配的IP地址数

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String AllocateDirectConnection

系统规定参数,取值:DescribeDBInstanceNetInfo

InstanceId String r-bp1zxszhcgatnx****

实例ID。

RegionId String cn-hangzhou

实例所属的地域ID。

ConnectionString String redisdirect123

直连地址的前缀,由小写英文字母或数字组成,以小写字母开头,长度为8~64字符。

Port String 6379

端口号,取值范围为1024~65535,默认值为6379

返回数据

名称 类型 示例值 描述
RequestId String 5D622714-AEDD-4609-9167-F5DDD3D1****

请求ID。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=AllocateDirectConnection
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>

正常返回示例

XML 格式

<AllocateDirectConnectionResponse>
      <RequestId>5D622714-AEDD-4609-9167-F5DDD3D1****</RequestId>
</AllocateDirectConnectionResponse>

JSON 格式

{
	"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

错误码

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