云数据库 Redis® 修改实例网络配置-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： redis.tencentcloudapi.com 。

本接口（ModifyNetworkConfig）用于修改实例网络配置。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyNetworkConfig。
Version	是	String	公共参数，本接口取值：2018-04-12。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID。示例值：crs-5a4py64p
Operation	是	String	指预修改网络的类别，包括： - changeVip：指切换私有网络，包含其内网IPv4地址及端口。 - changeVpc：指切换私有网络所属子网。 - changeBaseToVpc：指基础网络切换为私有网络。 - changeVPort：指仅修改实例网络端口。示例值：changeVip
Vip	否	String	指实例私有网络内网 IPv4 地址。当Operation为changeVip时，需配置该参数。示例值：10.1.1.2
VpcId	否	String	指修改后的私有网络 ID，当Operation为changeVpc或changeBaseToVpc时，需配置该参数。示例值：vpc-hu6khgap
SubnetId	否	String	指修改后的私有网络所属子网 ID，当Operation为changeVpc或changeBaseToVpc时，需配置该参数。示例值：subnet-6mt7lir6
Recycle	否	Integer	原内网 IPv4 地址保留时长。 - 单位：天。 - 取值范围：0、1、2、3、7、15。说明：设置原地址保留时长需最新版SDK，否则原地址将立即释放，查看SDK版本，请参见 SDK中心。示例值：7
VPort	否	Integer	指修改后的网络端口。当Operation为changeVPort或changeVip时，需配置该参数。取值范围为[1024,65535]。示例值：6379

3. 输出参数

参数名称	类型	描述
Status	Boolean	执行状态，请忽略该参数。示例值：true
SubnetId	String	指实例新私有网络所属子网 ID。示例值：subnet-6mt7lir6
VpcId	String	指实例新的私有网络ID。示例值：vpc-hu6khgap
Vip	String	指实例新的内网 IPv4 地址。示例值：10.2.3.8
TaskId	Integer	任务 ID。可获取taskId，通过接口 DescribeTaskInfo 查询任务执行状态。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求修改实例网络配置示例。

通过该接口修改实例的私有网络。

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetworkConfig
<公共请求参数>

{
    "InstanceId": "crs-5a4p****",
    "Operation": "changeVip"
}

输出示例

{
    "Response": {
        "Status": true,
        "Vip": "192.168.1.1",
        "VpcId": "vpc-hu6khgap",
        "SubnetId": "subnet-6mt7lir6",
        "TaskId": 0,
        "RequestId": "f1b5aabe-806a-4886-b839-9907baa24c85"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.SystemError	内部系统错误，和业务无关。
FailedOperation.Unknown	weekday输入无效数据。
InternalError.DbOperationFailed	统一的 DB 操作错误，可以是 update insert select..。
InternalError.InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.NotSupported	参数错误，不支持操作。
InvalidParameter.PermissionDenied	接口没有cam权限。
InvalidParameterValue.CheckNotPass	业务校验不通过。
ResourceNotFound.InstanceNotExists	根据 serialId 没有找到对应 redis。
ResourceUnavailable.InstanceLockedError	redis 已经被其它流程锁定。
ResourceUnavailable.InstanceStatusError	实例状态异常，不能执行对应操作。
ResourceUnavailable.InstanceUnLockedError	实例已经被其它流程锁定。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoCAMAuthed	无cam 权限。
UnauthorizedOperation.UserNotInWhiteList	用户不在白名单中。

修改实例网络配置

本页目录：