1. 接口描述
修改实例网络配置接口请求域名： redis.tencentcloudapi.com 。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyNetworkConfig。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID |
| Operation | 是 | String | 操作类型：changeVip——修改实例VIP；changeVpc——修改实例子网；changeBaseToVpc——基础网络转VPC网络 |
| Vip | 否 | String | VIP地址，changeVip的时候填写，不填则默认分配 |
| VpcId | 否 | String | 私有网络ID，changeVpc、changeBaseToVpc的时候需要提供 |
| SubnetId | 否 | String | 子网ID，changeVpc、changeBaseToVpc的时候需要提供 |
| Recycle | 否 | Integer | 原VIP保留时间，单位：天，注：需要最新版SDK，否则原VIP立即释放，查看SDK版本，详见 SDK中心 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | Boolean | 执行状态：true|false |
| SubnetId | String | 子网ID |
| VpcId | String | 私有网络ID |
| Vip | String | VIP地址 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求修改实例VIP示例
输入示例
https://redis.tencentcloudapi.com/?Action=ModifyNetworkConfig
&InstanceId=crs-5a4py64p
&Operation=changeVip
&<公共请求参数>输出示例
{
"Response": {
"Status": true,
"Vip": "192.168.1.1",
"VpcId": "vpc-hu6khgap",
"SubnetId": "subnet-6mt7lir6",
"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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 内部系统错误，和业务无关。 |
| FailedOperation.Unknown | weekday输入无效数据。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误，可以是 update insert select..。 |
| InternalError.InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.NotSupported | 参数错误，不支持操作。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |
| InvalidParameterValue.CheckNotPass | 业务校验不通过。 |
| ResourceUnavailable.InstanceLockedError | redis 已经被其它流程锁定。 |
| ResourceUnavailable.InstanceUnLockedError | 实例已经被其它流程锁定。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
| UnauthorizedOperation.UserNotInWhiteList | 用户不在白名单中。 |