You need to enable JavaScript to run this app.
导航
ModifyDBInstanceSubnet
最近更新时间:2023.11.29 10:25:30首次发布时间:2022.05.18 11:54:51

调用 ModifyDBInstanceSubnet 接口将目标 Redis 实例绑定到指定子网。

请求类型

异步请求。

注意事项

  • 自 2022 年 05 月 17 日起,新开通 Redis 产品的客户以及存量实例都需要进行跨服务访问授权。请您尽快完成授权,否则调用 CreateDBInstanceModifyDBInstanceSubnetCreateDBEndpointPublicAddress 等接口时将会报错。
    跨服务访问授权方法如下:
  • 针对创建时间早于 2022 年 05 月 17 日的实例,您可以通过该接口将实例绑定至目标私有网络和子网,来完成网络安全升级。关于网络安全升级的更多信息,请参见网络安全升级

操作影响

  • 变更网络配置(包括修改私有网络或子网)过程中,所有连接地址(如私网地址、直连地址、公网地址)都可能会发生 1~2 次连接闪断,请谨慎操作。建议在业务低峰期执行变更操作,并确保业务具备自动重连机制。
  • 修改私有网络和子网不会改变私网地址或直连地址域名,但其对应的 IP 地址将会发生变化,请确保业务使用域名进行连接,并且业务所在网络环境与新配置的网络环境能够互通。
  • 请及时对客户端缓存进行清理,否则可能会出现读写异常的情况。
  • 修改私有网络和子网会短暂影响 DTS、DBW 等数据库生态产品的使用。

请求参数

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

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

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

VpcId

String

vpc-1g15j0fvgmt4w8ibuxwjl****

设置实例的私有网络 ID。

说明

  • 若输入了实例当前所属的私有网络 ID,表示不修改私有网络,仅修改子网。
  • 建议 Redis 实例与需要连接的 ECS 实例在同一私有网络,否则它们无法通过内网互通来实现最佳性能。您可以调用 CreateVpc 接口创建私有网络。
  • 您可以调用 DescribeVpcs 接口查询符合指定条件的私有网络信息,包括私有网络 ID。

SubnetId

String

subnet-1g15t8rj4uigw8ibuxxij****

设置实例的子网 ID。

说明

  • 子网具有可用区属性,必须选择目标私有网络中与实例属于同一可用区下的子网。
  • 子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内,子网为云资源分配私网 IP 地址,您可以调用 CreateSubnet 接口创建子网。
  • 您可以调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息,包括子网 ID。

RetentionDays

Integer

1

设置旧 IP 地址的释放时间。取值范围如下:

  • 0:立即释放。
  • 1(默认值):1 天后释放。
  • 2:2 天后释放。
  • 3:3 天后释放。
  • 7:7 天后释放。

说明

修改私有网络和子网不会改变私网地址或直连地址域名,但其对应的 IP 地址将会发生变化。建议在旧 IP 地址释放前,及时对客户端缓存进行清理,否则可能会出现读写异常的情况。

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

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceSubnet&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****",
	"VpcId": "vpc-1g15j0fvgmt4w8ibuxwjl****",
	"SubnetId": "subnet-1g15t8rj4uigw8ibuxxij****"
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "2022042510294601022524308102C5****",
          "Action": "ModifyDBInstanceSubnet",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing",
     },
     "Result": null
}

错误码

更多详情,请参见错误码