AttachNetworkInterface

最后更新时间：2023-08-23 14:11:33

1. API Description

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

This API is used to bind an ENI to a CVM.

An ENI must be bound with one security group at least. To bind it, see AssociateNetworkInterfaceSecurityGroups.
One CVM can be bound with multiple ENIs, but only one can be the primary ENI. For more information about the limits, see ENI Use Limits.
An ENI can only be bound to one CVM.
Only the running or shutdown CVMs can be bound with ENIs. For more information about the CVM status, see InstanceStatus in the Data Types.
An ENI can only be bound to a VPC-based CVM under the same availability zone as the ENI 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: AttachNetworkInterface.
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.
NetworkInterfaceId	Yes	String	The ID of the ENI instance, such as `eni-m6dyj72l`.
InstanceId	Yes	String	The ID of the CVM instance, such as `ins-r8hr2upy`.
AttachType	No	Integer	ENI mounting type. Valid values: `0` (standard); `1` (extension); default value: `0`

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 Binding an ENI with a CVM

This example shows you how to bind an ENI with a CVM.

Input Example

https://vpc.tencentcloudapi.com/?Action=AttachNetworkInterface
&NetworkInterfaceId=eni-afo43z61
&InstanceId=ins-ins-r8hr2upy
&<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

Tencent Cloud CLI 3.0

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
InternalError.ModuleError	Internal module error
InvalidParameterValue.Malformed	Invalid input parameter format.
LimitExceeded	Quota limit is reached.
LimitExceeded.ActionLimited	Too often API invocations
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.AttachmentAlreadyExists	The EIP is already bound to a CVM.
UnsupportedOperation.InvalidState	Invalid resource status.
UnsupportedOperation.ResourceIsInvalidState	Operation prohibited: The resource is not available.
UnsupportedOperation.UnsupportedInstanceFamily	The specified instance type does not support ENIs.
UnsupportedOperation.VpcMismatch	The resources are not in the same VPC.
UnsupportedOperation.ZoneMismatch	The specified resources are not in the same availability zone.

tencent cloud

Recent Pages