AI 助理
备案控制台
文档
输入文档关键字查找
首页

AllocateInstancePublicConnection - 为实例申请公网连接地址

更新时间：
我的收藏

为云数据库 Tair（兼容 Redis）实例申请公网连接地址。

接口说明

该 API 对应的控制台操作请参见申请公网连接地址。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:AllocateInstancePublicConnectioncreate
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    无
无

请求参数

名称类型必填描述示例值
InstanceIdstring是

实例 ID。

r-bp1zxszhcgatnx****
ConnectionStringPrefixstring是

公网连接地址的前缀，需由小写英文字母与数字组成，以小写字母开头，长度为 8~40 个字符。

说明 公网连接地址格式为：<前缀>.redis.rds.aliyuncs.com。
r-bp1zxszhcgatnx****
Portstring是

实例的服务端口号，取值范围：1024~65535。

6379

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

20C8341E-B5AD-4B24-BD82-D73241522ABF

示例

正常返回示例

JSON格式

{
  "RequestId": "20C8341E-B5AD-4B24-BD82-D73241522ABF"
}

错误码

HTTP status code错误码错误信息描述
400MissingInstanceIdInstanceId is mandatory for this action.-
400MissingConnectionStringConnectionStringPrefix is mandatory for this action.-
400MissingPortPort is mandatory for this action.-
400NetTypeExistsSpecified net type already existed.指定的网络类型已经存在
400InvalidConnectionString.FormatSpecified connection string is not valid.连接串非法，请选用新的
400NewSSLAlreadyEnablednew SSL have already been enabled.实例已经启用了新的SSL
403SSLNotSupportNetTypeSSL instance does not support create public network.SSL实例不支持创建公共网络。

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

变更历史

变更时间变更内容概要操作
2024-02-26OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情