Private IP Migration

Last updated: 2020-09-01 11:40:07


    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new VPC API 3.0 which is standardized and faster.

    1. API Description

    This API (MigratePrivateIpAddress) is used to migrate private IPs.
    Domain for API request:

    1) If a user of this API migrates a private IP from one ENI to another ENI, the primary IP address cannot be migrated.
    2) The original ENI and the target ENI must be in the same subnet.

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is MigratePrivateIpAddress.

    Parameter Name Required Type Description
    vpcId Yes String Virtual private cloud ID of ENI, for example: vpc-7t9nf3pu.
    privateIpAddress Yes String The private IP address to be migrated, for example:
    oldNetworkInterfaceId Yes String ID of the ENI before the private IP is migrated, for example: eni-m6dyj72l.
    newNetworkInterfaceId Yes String ID of the ENI to which the private IP is migrated, for example: eni-dfddf454d.

    3. Output Parameters

    Parameter Name Type Description
    code Int Error code. 0: Succeeded; other values: Failed.
    message String Error message.
    taskId Int Task ID. The operation result can be queried with taskId.

    4. Error Codes

    The following error code list only provides the business logic error codes for this API. For additional common error codes, refer to VPC Error Codes.

    Error Code Description
    InvalidVpc.NotFound VPC does not exist. Please check the information you entered. You can query the VPC via the DescribeVpcEx API.
    InvalidNetworkInterface.NotFound ENI does not exist. Please check the information you entered. You can query the ENI via the DescribeNetworkInterfaces API.

    5. Example

    &<Common request parameters>


        "code": 0,
        "message": "",
        "codeDesc": "Success",
                "taskId": 16284

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback