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, take note of the following:

  • 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.
    Note If the last start time of the instance (including but not limited to the last start time of the instance if it is newly purchased, the last restart time of the instance, the last reactivation time of the instance) is before April 1, 2018 and the instance stays in the Running state, you must call the RebootInstance operation to restart the instance. Otherwise, the ENI 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

Name Type Required Example Description
RegionId String Yes cn-hangzhou

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

NetworkInterfaceId String Yes eni-bp17pdijfczax1huji*****

The ID of the ENI.

InstanceId String Yes i-bp1ecr********5go2go

The ID of the instance.

Action String No AttachNetworkInterface

The required parameter. Set the value to AttachNetworkInterface.

Response parameters

Name 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-bp1ecr********5go2go
&NetworkInterfaceId=eni-bp17pdijfczax1huji*****
&<Common request parameters>

Sample success responses

XML format

<AttachNetworkInterfaceResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FExxxxx</RequestId>
</AttachNetworkInterfaceResponse>

JSON format

{
	"RequestId":"04F0F334-1335-436C-A1D7-6C044FExxxxx"
}

Error codes

Http status code Error code Error message Description
403 InvalidUserType.NotSupported %s The error message returned because your account type is not supported.
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 a parameter is not supported.
403 Forbidden.SubUser %s The error message returned because a RAM user is not authorized to perform operations on this resource.
400 InvalidParameter %s The error message returned because the parameter format is invalid.
400 InvalidInstanceID.Malformed %s The error message returned because the instance ID format is invalid.
400 InvalidOperation.InvalidRegion %s The error message returned because the specified region ID is invalid.
400 InvalidOperation.InvalidEcsState %s The error message returned because the private IP address cannot be released while the instance is in the current state.
400 InvalidOperation.InvalidEniState %s The error message returned because the private IP address cannot be released while the ENI is in the current state.
400 InvalidOperation.DetachPrimaryEniNotAllowed %s The error message returned because the primary ENI cannot be detached from its 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 maximum number of ENIs that can be attached to the specified instance has been reached.
403 EniPerInstanceLimitExceeded %s The error message returned because the number of ENIs exceeds the upper limit for the specified instance type.
403 InvalidOperation.AvailabilityZoneMismatch %s The error message returned because the specified VSwitch, ENI, and instance do not belong to the same zone.
403 InvalidOperation.VpcMismatch %s The error message returned because the specified ENI and security group do not belong to the same VPC.
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 security group is not of the VPC type.
403 InvalidOperation.InvalidEniType %s The error message returned because the ENI type does not support the operation.
400 Forbidden.RegionId %s The error message returned because this function is not supported in the region.
403 InvalidInstanceId.NotFound %s The error message returned because the specified instance does not exist.
400 InvalidOperation.InvalidGeneration %s The error message returned because the instance type does not support the operation.

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