ModifyInstancesVpcAttribute

Last updated: 2020-03-16 18:27:22

PDF

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to modify the VPC attributes of an instance, such as the VPC IP address.

  • By default, the instances will shut down when you perform this operation and restart upon completion.
  • If the specified VPC ID and subnet ID (the subnet must be in the same availability zone as the instance) are different from the VPC where the specified instance resides, the instance will be migrated to a subnet of the specified VPC. Before performing this operation, make sure that the specified instance is not bound with an ENI or CLB.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyInstancesVpcAttribute.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N Yes Array of String Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response.
VirtualPrivateCloud Yes VirtualPrivateCloud VPC configurations. You can use this parameter to specify the VPC ID, subnet ID, VPC IP, etc. If the specified VPC ID and subnet ID (the subnet must be in the same availability zone as the instance) are different from the VPC where the specified instance resides, the instance will be migrated to a subnet of the specified VPC. You can use PrivateIpAddresses to specify the VPC subnet IP. If you want to specify the subnet IP, you will need to specify a subnet IP for each of the specified instances, and each InstanceIds will match a PrivateIpAddresses. If PrivateIpAddresses is not specified, the VPC subnet IP will be assigned randomly.
ForceStop No Boolean Whether to force shut down a running instances. Default value: TRUE.
ReserveHostName No Boolean Whether to keep the host name. Default value: FALSE.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Migrating an instance to a VPC and specifying the instance IP

This example shows you how to migrate the instances r8hr2upy and 5d8a23rs to the subnet dcs9x3gz of the VPC 1urkhbj4 and specify 10.0.0.18 as the private IP of the instance r8hr2upy and 10.0.0.19 as that of the instance 5d8a23rs.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=ModifyInstancesVpcAttribute
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&VirtualPrivateCloud.SubnetId=subnet-dcs9x3gz
&VirtualPrivateCloud.VpcId=vpc-1urkhbj4
&VirtualPrivateCloud.PrivateIpAddresses.0=10.0.0.18
&VirtualPrivateCloud.PrivateIpAddresses.1=10.0.0.19
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c14def19-cfes-470e-b241-90787u6jf5uj"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
EniNotAllowedChangeSubnet ENIs do not support changing subnets.
InvalidInstance.NotSupported This instance is not supported.
InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
VpcAddrNotInSubNet The VPC IP address is not in the subnet.
VpcIpIsUsed The VPC IP address is already occupied.