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

请求类型

异步请求。

注意事项

自 2022 年 05 月 17 日起，新开通 Redis 产品的客户以及存量实例都需要进行跨服务访问授权。请您尽快完成授权，否则调用 CreateDBInstance、ModifyDBInstanceSubnet、CreateDBEndpointPublicAddress等接口时将会报错。

跨服务访问授权方法是通过 Redis 控制台授权，详细操作步骤，请参见跨服务访问授权，或调用 CreateServiceLinkedRole（ServiceName 为 Redis）接口完成跨服务授权。

操作影响

变更网络配置（包括修改私有网络或子网）过程中，所有连接地址（如私网地址、直连地址、公网地址）都可能会发生 1~2 次连接闪断，请谨慎操作。建议在业务低峰期执行变更操作，并确保业务具备自动重连机制。

修改私有网络和子网不会改变私网地址或直连地址域名，但其对应的 IP 地址将会发生变化，请确保业务使用域名进行连接，并且业务所在网络环境与新配置的网络环境能够互通。

请及时对客户端缓存进行清理，否则可能会出现读写异常的情况。

修改私有网络和子网会短暂影响 DTS、DBW 等数据库生态产品的使用。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs1111	实例 ID。说明您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
VpcId	String	是	vpc-1g15j0fvgmt4w8ibuxwjl1111	设置实例的私有网络 ID。说明若输入了实例当前所属的私有网络 ID，表示不修改私有网络，仅修改子网。建议 Redis 实例与需要连接的 ECS 实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用 CreateVpc 接口创建私有网络。您可以调用 DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络 ID。
SubnetId	String	是	subnet-1g15t8rj4uigw8ibuxxij1111	设置实例的子网 ID。说明子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址，您可以调用 CreateSubnet 接口创建子网。您可以调用 DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网 ID。
RetentionDays	Integer	否	0	设置旧 IP 地址的释放时间。取值范围如下： 0：立即释放。 1（默认值）：1 天后释放。 2：2 天后释放。 3：3 天后释放。 7：7 天后释放。说明修改私有网络和子网不会改变私网地址或直连地址域名，但其对应的 IP 地址将会发生变化。建议在旧 IP 地址释放前，及时对客户端缓存进行清理，否则可能会出现读写异常的情况。更多详情，请参见修改私有网络或子网。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

缓存数据库 Redis 版