tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

MigratePrivateIpAddress

Last updated: 2023-05-19 17:19:04

1. API Description

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

This API is used to migrate the private IPs between ENIs.

  • Note that primary IPs cannot be migrated.
  • The source and destination ENI must be within the same subnet.

This API is completed asynchronously. If you need to query the execution result of an async task, please use the RequestId returned by this API to poll the DescribeVpcTaskResult API.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: MigratePrivateIpAddress.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
SourceNetworkInterfaceId Yes String ID of the ENI instance bound with the private IP, such as eni-m6dyj72l.
DestinationNetworkInterfaceId Yes String ID of the destination ENI instance to be migrated.
PrivateIpAddress Yes String The private IP to be migrated, such as 10.0.0.6.

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 private IP between ENIs

This example shows you how to migrate a private IP between ENIs.

Input Example

https://vpc.tencentcloudapi.com/?Action=MigratePrivateIpAddress
&SourceNetworkInterfaceId=eni-afo43z61
&DestinationNetworkInterfaceId=eni-g0n2axhd
&PrivateIpAddress=172.16.33.109
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
    }
}

5. Developer Resources

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
InvalidParameterValue.Malformed Invalid input parameter format.
LimitExceeded Quota limit is reached.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.AttachmentNotFound The binding relationship does not exist.
UnauthorizedOperation.PrimaryIp The operation is not allowed for a primary IP.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.MutexOperationTaskRunning The resource mutual exclusion operation is being executed.
UnsupportedOperation.PrimaryIp The specified value is a primary IP.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy