ModifyInstancesVpcAttribute

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

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

This operation will shut down the instance by default and restart it after modification is completed.
When the specified VPC ID and the subnet ID (which should be in the availability zone of the instance) are inconsistent with the VPC where the specified instance is located, the instance will be migrated to the subnet of the specified VPC. Before performing this operation, make sure there are no ENI and CLB bound on the specified instance.
You can query the result of the instance operation by calling the API DescribeInstances. If the latest operation status (LatestOperationState) of the instance is SUCCESS, it indicates that the operation succeeded.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-10-28 03:50:44.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name	Required	Allow NULL	Type	Description
Action	Yes	No	String	Public parameter, The value of this interface: ModifyInstancesVpcAttribute
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds	Yes	No	Array of String	Instance ID array to be operated. Can be obtained through the `InstanceId` in the returned value from the API DescribeInstances. Example: ["ins-r8hr2upy","ins-5d8a23rs"]
VirtualPrivateCloud	Yes	No	VirtualPrivateCloud	VPC-related information configuration. You can specify information such as VPC ID and subnet ID through this parameter. When the specified VPC ID and subnet ID (the subnet should be in the same availability zone as the instance) are different from the VPC where the instance is located, the instance will be migrated to the subnet under the specified VPC. You can specify the VPC subnet IP through the `PrivateIpAddresses`. If specification is needed, subnet IPs need to be specified for all specified instances. In this case, `InstanceIds` and `PrivateIpAddresses` are in a one-to-one correspondence. When the `PrivateIpAddresses` is not specified, VPC subnet IPs will be randomly assigned. Example:View
ForceStop	No	No	Bool	Whether to perform forced shutdown on the running instance, TRUE by default. Example: true
ReserveHostName	No	No	Bool	Whether to retain the hostname, FALSE by default. Example: true

3. Output Parameters

Parameter name	Type	Description
TaskId	String	Task ID Example: 542324
flowId	Int64	Task Flow ID Example: 5
RequestId	String	Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code	Description
VpcIpIsUsed	The VPC IP has already been used.