AllocateDirectConnection_云数据库 Tair(兼容 Redis®)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

客户端可通过直连地址绕过代理,像连接原生 Redis 集群一样连接集群实例,从而降低链路开销,进一步提升云数据库 Tair(兼容 Redis)服务的响应速度。

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

  • 实例为集群架构。
  • 部署模式为经典。
  • 实例的网络类型为专有网络。如果当前为经典网络,您可以调用 SwitchNetwork 接口将其切换为专有网络。
  • 实例未开启 SSL 加密功能。如果已开启 SSL 加密功能,您可以调用 ModifyInstanceSSL 接口将其关闭。

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
kvstore:AllocateDirectConnection
Create
DBInstance
acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:r-bp1zxszhcgatnx****参考取值来源:
    CreateInstance
    ModifyInstanceSSL
    RestartInstance
    RestoreInstance
    DescribeInstances
ConnectionStringstring

直连地址的前缀,由小写英文字母或数字组成,以小写字母开头,长度为 8~40 字符。默认为实例 ID+-direct,例如实例 ID 为 r-8vbwsicr5d5gse****,则该参数默认为r-8vbwsicr5d5gse****-direct

示例值:redisdirect123参考取值来源:
    AllocateInstancePublicConnection
Portstring

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

示例值:6379

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:5D622714-AEDD-4609-9167-F5DDD3D1****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
NetTypeExists
Specified net type already existed诊断
400
InvalidConnType
Specified DB instance conn type is not valid.诊断
400
TaskHasExist
The task already exists.诊断
400
ConnectionStringAlreadyExists
Specified connection string already exists in the Aliyun RDS.诊断
400
InvalidConnectionString.Format
Specified connection string is not valid.诊断
400
DirectConnectionAlreadyExists
Specified instance direct connection already exists.诊断
400
InvalidVPCParamGroup
Specified vpc param group is not valid.诊断
400
InvalidConnectionString
ConnectionString is invalid, valid regex: ^\w+$诊断
403
UnsupportedEngineVersion
Current engine version does not support operations.诊断
403
IncorrectMinorVersion
Current engine minor version does not support operations.诊断
403
InstanceStatus.NotSupport
Instance status does not support this operation.诊断
404
InvalidDbInstanceId.NotFound
Specified instance does not exist.诊断

变更历史

暂无变更历史

相关示例

为Redis集群实例申请直连地址
2021-12-03