ModifyInstancesVpcAttribute
最近更新时间: 2025-10-20 17:06:00
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性，如私有网络ip。
- 此操作默认会关闭实例，完成后再启动。
- 当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定弹性网卡和负载均衡。
- 实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
默认接口请求频率限制：20次/秒。
接口更新时间：2023-07-19 10:40:59。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyInstancesVpcAttribute |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceIds | 是 | 否 | Array of String | 待操作的实例ID数组。可通过DescribeInstances接口返回值中的InstanceId获取。 |
| VirtualPrivateCloud | 是 | 否 | VirtualPrivateCloud | 私有网络相关信息配置，通过该参数指定私有网络的ID，子网ID，私有网络ip等信息。<br><li>当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。<br><li>可通过PrivateIpAddresses指定私有网络子网IP，若需指定则所有已指定的实例均需要指定子网IP，此时InstanceIds与PrivateIpAddresses一一对应。<br><li>不指定PrivateIpAddresses时随机分配私有网络子网IP。 |
| ForceStop | 否 | 否 | Bool | 是否对运行中的实例选择强制关机。默认为TRUE。 |
| ReserveHostName | 否 | 否 | Bool | 是否保留主机名。默认为FALSE。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 此参数对外不可见。 任务ID |
| FlowId | Int64 | 此参数对外不可见。 任务流转ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| VpcIpIsUsed | 私有网络ip已经被使用。 |