You can call this operation to attach an Elastic Network Interface (ENI) to an ECS instance in a VPC.

Description

When you call this operation, make sure that the following requirements are met:

  • The ENI must be in the Available (Available) state. An ENI can be attached to only one instance.
  • The instance must be in the Running (Running) or Stopped (Stopped) state. When you attach ENIs to instances that use specific instance types, the instances must be in the Stopped (Stopped) state. For more information, see Shared instance families and Burstable instance overview.
    Note If the last time when an instance was started is before April 1, 2018 (including the time when a newly purchased instance was started, the time when an instance was restarted, and the time when an instance was reactivated) and the instance stays in the Running state, you must call the RebootInstance operation to restart the instance. Otherwise, ENIs cannot be attached to the instance.
  • An instance can be attached with multiple ENIs. For more information about the maximum number of ENIs that can be attached to each instance type, see Elastic Network Interface.
  • The instance must be in the same zone and the same VPC as the VSwitch to which the ENI belongs.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No AttachNetworkInterface

The operation that you want to perform. Set the value to AttachNetworkInterface.

InstanceId String Yes i-bp16qstyvxj9gpqw****

The ID of the instance.

NetworkInterfaceId String Yes eni-bp17pdijfczax1huji****

The ID of the ENI.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=AttachNetworkInterface
&RegionId=cn-hangzhou
&InstanceId=i-bp16qstyvxj9gpqw****
&NetworkInterfaceId=eni-bp17pdijfczax1huji****
&<Common request parameters>

Sample success responses

XML format

<AttachNetworkInterfaceResponse>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</AttachNetworkInterfaceResponse>

JSON format

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code Error code Error message Description
403 InvalidUserType.NotSupported %s The error message returned because the specified account does not support this operation.
403 Abs.InvalidAccount.NotFound %s The error message returned because your Alibaba Cloud account does not exist or your AccessKey pair has expired.
400 MissingParameter %s The error message returned because a required parameter is not specified.
403 Forbidden.NotSupportRAM %s The error message returned because RAM users are not allowed to perform this operation.
400 UnsupportedParameter %s The error message returned because the specified parameter is not supported.
403 Forbidden.SubUser %s The error message returned because your account has no permission on this resource. Apply for permissions to the Alibaba Cloud account.
400 InvalidParameter %s The error message returned because the specified parameter is invalid.
400 InvalidInstanceID.Malformed %s The error message returned because the specified InstanceId parameter is invalid.
400 InvalidOperation.InvalidRegion %s The error message returned because the specified RegionId parameter is invalid.
400 InvalidOperation.InvalidEcsState %s The error message returned because the operation is not supported while the instance is in the current state.
400 InvalidOperation.InvalidEniState %s The error message returned because the operation is not supported while the ENI is in the current state.
400 InvalidOperation.DetachPrimaryEniNotAllowed %s The error message returned because the primary ENI cannot be detached from the instance.
404 InvalidEcsId.NotFound %s The error message returned because the specified instance ID does not exist.
404 InvalidEniId.NotFound %s The error message returned because the specified ENI ID does not exist.
404 InvalidVSwitchId.NotFound %s The error message returned because the specified VSwitch ID does not exist.
404 InvalidSecurityGroupId.NotFound %s The error message returned because the specified security group ID does not exist.
403 MaxEniCountExceeded %s The error message returned because the number of ENIs that can be attached exceeds the upper limit.
403 EniPerInstanceLimitExceeded %s The error message returned because the number of ENIs that can be attached to the specified instance exceeds the upper limit.
403 InvalidOperation.AvailabilityZoneMismatch %s The error message returned because this operation is invalid.
403 InvalidOperation.VpcMismatch %s The error message returned because your operation is invalid. Check whether the VPC in the operation matches other parameters.
403 SecurityGroupInstanceLimitExceed %s The error message returned because the number of instances in the specified security group exceeds the upper limit.
403 InvalidSecurityGroupId.NotVpc %s The error message returned because the specified SecurityGroupId parameter is invalid and the network type of the security group is not VPC.
403 InvalidOperation.InvalidEniType %s The error message returned because the current ENI type does not support the operation.
400 Forbidden.RegionId %s The error message returned because the service is not available in the current region.
403 InvalidInstanceId.NotFound %s The error message returned because the specified instance does not exist. Check the value of the InstanceId parameter.
400 InvalidOperation.InvalidGeneration %s The error message returned because this operation is invalid.
400 InvalidParams.EniId %s The error message returned because the specified EniId parameter is invalid.
403 InvalidOperation.Ipv4CountExceeded %s The error message returned because the number of IPv4 addresses exceeds the upper limit.
403 InvalidOperation.EniServiceManaged %s The error message returned because this operation is invalid.
403 InvalidOperation.Ipv6NotSupport %s The error message returned because the IPv6 address does not support the current operation.

For a list of error codes, visit the API Error Center.