Bind ENI with CVM

Last updated: 2020-06-04 18:08:38

    Note:

    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 (AttachNetworkInterface) is used to request private IP for ENIs.
    Domain for API request: vpc.api.qcloud.com

    1) A CVM can bind multiple ENIs but one primary ENI.
    2) An ENI can only be bound to one CVM.
    3) Only CVMs that are in a running/shutdown status can bind ENIs. For details on the CVM status, refer to Query CVM Information.
    4) ENIs must be bound to a VPC CVM, and the availability zone of the CVM must be the same as that of ENIs.

    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 AttachNetworkInterface.

    Parameter Name Required Type Description
    vpcId Yes String Virtual private cloud ID of ENI, for example: vpc-7t9nf3pu
    networkInterfaceId Yes String ENI ID, for example: eni-m6dyj72l
    instanceId Yes String CVM instance ID, for example: ins-xx44545f

    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. For more information, refer to API for Querying Task Execution Result.

    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
    InvalidInstance.NotFound CVM instance does not exist. Please check the information you entered. You can query the CVM instance via the DescribeInstances API
    InvalidNetworkInterface.AlreadyAssociated The ENI is already bound to a CVM

    5. Example

    Input

    https://vpc.api.qcloud.com/v2/index.php?Action=AttachNetworkInterface
    &>
    &vpcId=vpc-xx44545f
    &networkInterfaceId=eni-m6dyj72l
    &instanceId=ins-xx44545f
    

    Output

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "data":
            {
                "taskId": 16284
            }
    }

    Was this page helpful?

    Was this page helpful?

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