You need to enable JavaScript to run this app.
导航
CreateDBEndpointPublicAddress
最近更新时间:2023.08.15 19:41:39首次发布时间:2022.05.18 11:55:02

调用 CreateDBEndpointPublicAddress 接口为指定 Redis 实例的创建公网连接地址(即开启实例的公网访问功能)。

请求类型

异步请求。

注意事项

  • 自 2022 年 05 月 17 日起,新开通 Redis 产品的客户以及存量实例都需要进行跨服务访问授权。请您尽快完成授权,否则调用 CreateDBInstanceModifyDBInstanceSubnetCreateDBEndpointPublicAddress 等接口时将会报错。
    跨服务访问授权方法如下:
  • 相较于私网访问,公网访问的延迟更高且存在一定的安全隐患,建议仅在测试环境中使用,生产环境推荐使用私网访问。当 VPC 外的设备不再需要访问 Redis 实例时,建议您及时关闭公网访问功能。您可以调用 DeleteDBEndpointPublicAddress 接口关闭公网访问功能。

费用说明

公网地址将绑定您的弹性公网 IP(EIP),费用由 EIP 收取。更多详情,请参见 EIP 计费指引

请求参数

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

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

EipId

String

eip-2fef2qcfbfw8w5oxruw3w****

实例需要绑定的 EIP ID。

说明

您可以调用 DescribeEipAddresses 接口查询已创建的 EIP 的详细信息,包括 EIP ID。

ClientTokenStringWbiAlPqJM6tMoSOYhT****用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=CreateDBEndpointPublicAddress&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****",
	"EipId": "eip-2fef2qcfbfw8w5oxruw3w****"
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "2022042511062201022509900802EB****",
          "Action": "CreateDBEndpointPublicAddress",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing",
     },
     "Result": null
}

错误码

更多详情,请参见错误码