AttachNetworkInterface

Updated at:

Invokes the AttachNetworkInterface operation to attach an Elastic Network Interface (ENI) network interface controller (NIC) to a VPC-type ECS instance by specifying parameters such as NetworkInterfaceId, InstanceId, and NetworkCardIndex.

Operation description

Take note of the following items when you call this operation:

  • The Elastic Network Interface (ENI) network interface controller (NIC) must be in the active (Available) state. An Elastic Network Interface (ENI) network interface controller (NIC) can be attached to only one instance in the same zone and VPC at a time.

  • The instance must be in the Running or Stopped state. Instances of certain instance types must be in the Stopped state when an Elastic Network Interface (ENI) network interface controller (NIC) is attached. For more information, see the "ECS instance types that require the instance to be stopped" section in Attach an Elastic Network Interface (ENI).

    Note

    If the instance was last started before April 1, 2018, including but not limited to starting a newly purchased instance, restarting, or rebooting, you must invoke the RebootInstance operation in advance to restart the instance that has been continuously running. Otherwise, the Elastic Network Interface (ENI) network interface controller (NIC) cannot be attached.

  • An instance can have multiple Elastic Network Interface (ENI) network interface controller (NIC) attached at the same time. For more information, see Elastic Network Interface (ENI) network interface controller (NIC) overview.

  • The vSwitch to which the Elastic Network Interface (ENI) network interface controller (NIC) belongs must be in the same zone (active) and VPC as the vSwitch to which the instance belongs.

  • This operation is asynchronous. After you invoke the operation successfully, you can query the Elastic Network Interface (ENI) status or listen for network interface controller (NIC) operation events to obtain the operation result. The Elastic Network Interface (ENI) state machine is shown in the following figure:

    • Attaching indicates that you send the request to attach the Elastic Network Interface (ENI) successfully, and the Elastic Network Interface (ENI) is being attached to the ECS instance.

    • InUse indicates that the Elastic Network Interface (ENI) is attached to the ECS instance.

    • Available indicates that the Elastic Network Interface (ENI) failed to be attached to the ECS instance.

For details about examples on how to invoke the operation, see Attach an Elastic Network Interface (ENI) network interface controller (NIC).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:AttachNetworkInterface

update

*NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

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

cn-hangzhou

NetworkInterfaceId

string

Yes

The ID of the Elastic Network Interface (ENI) network interface controller (NIC).

eni-bp17pdijfczax1huji****

InstanceId

string

Yes

The instance ID.

i-bp16qstyvxj9gpqw****

TrunkNetworkInstanceId

string

No

The ID of the trunk ENI.

Note

This parameter is not available.

eni-f8zapqwj1v1j4ia3****

WaitForNetworkConfigurationReady

boolean

No

Note

[Deprecated]

null

NetworkCardIndex

integer

No

The index of the physical network card specified for the ENI.

Note

The valid values of NetworkCardIndex depend on the instance family. If the instance type does not support NetworkCard, this parameter cannot be specified. If it is supported, see Instance families for valid values.

0

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 MissingParameter %s A parameter is not specified.
400 UnsupportedParameter %s The parameter is not supported.
400 InvalidParameter %s The specified parameter is invalid.
400 InvalidInstanceID.Malformed %s The specified InstanceId parameter is invalid.
400 InvalidOperation.InvalidRegion %s The specified RegionId parameter is invalid.
400 InvalidOperation.InvalidEcsState %s This operation is not allowed in the current state of the cloud service.
400 InvalidOperation.InvalidEniState %s This operation is not allowed in the current state of the ENI.
400 InvalidOperation.EniInstanceNotSupported %s Please attach the ENI to an instance that supports it and try again.
400 InvalidOperation.DetachPrimaryEniNotAllowed %s The primary ENI of an instance cannot be detached.
400 Forbidden.RegionId %s The service is unavailable in the current region.
400 InvalidOperation.InvalidGeneration %s This operation is invalid.
400 InvalidParams.EniId %s The specified EniId parameter is invalid.
400 InvalidOperation.UserNotSupportNetworkCard User not support network card.
400 InvalidOperation.ConnectionTrackingConfigNotSupportMemberEni Member eni not support ConnectionTrackingConfiguration. Network connection configurations cannot be specified for member network interfaces.
400 InvalidParameter.NetworkCardIndexInvalid The network card index is invalid or the current ECS/ENI type does not support the value. Physical NIC properties do not meet the NIC or instance type restrictions
400 InvalidOperation.InstanceTypeNotSupportRss The ECS instance type does not support Rss. The ECS instance type does not support Rss.
400 OperationDenied.NoEniStock The requested resource of ENI is insufficient in the specified ECS, please retry or upgrade to enterprise-level computing instance types. The requested resource of ENI is insufficient in the specified ECS, please retry or upgrade to enterprise-level computing instance types.
400 InvalidOperation.InstanceTypeNotSupportSriov The specified instance type does not support ENI Sriov. The specified instance type does not support ENI Sriov.
500 InternalError The request processing has failed due to some unknown error, exception or failure. An internal error has occurred. Try again later.
500 InvalidSecurityGroupId.EniMustHaveSecurityGroup The specified network card does not have an associated security group. The specified NIC is not associated with a security group.
403 InvalidUserType.NotSupported %s Your account does not support this operation.
403 Abs.InvalidAccount.NotFound %s Your Alibaba Cloud account does not exist or your AccessKey pair has expired.
403 Forbidden.NotSupportRAM %s RAM users are not authorized to perform this operation.
403 Forbidden.SubUser %s You are not authorized to manage this resource. Contact the owner of the Alibaba Cloud account for authorization.
403 MaxEniCountExceeded %s The maximum number of ENIs that can be managed has been reached.
403 EniPerInstanceLimitExceeded %s The maximum number of ENIs that can be attached to the specified instance has been reached.
403 InvalidOperation.AvailabilityZoneMismatch %s The operation is invalid.
403 InvalidOperation.VpcMismatch %s The operation is invalid. Check whether the VPC in the operation corresponds to other parameters.
403 SecurityGroupInstanceLimitExceed %s The maximum number of instances in the security group has been reached.
403 InvalidSecurityGroupId.NotVpc %s The specified SecurityGroupId parameter is invalid and the network type of the security group is not VPC.
403 InvalidOperation.InvalidEniType %s This operation is not allowed for the current network interface type.
403 InvalidInstanceId.NotFound %s The specified instance does not exist. Check whether the InstanceId parameter is valid.
403 InvalidEni.NotSameVpc %s The specified resource and the specified ENI do not belong to the same VPC. For more information, see the return value of the %s placeholder in the error message.
403 InvalidOperation.Ipv4CountExceeded %s The operation is valid because the maximum number of IPv4 addresses has been reached.
403 InvalidOperation.EniServiceManaged %s The operation is invalid.
403 InvalidOperation.MultiGroupType The specified instance can't join different types of security group. The specified instance cannot be added to security groups of different types.
403 InvalidOperation.NotSupportEnterpriseGroup The specified instance type doesn't support enterprise level security group.
403 InvalidOperation.EniCountExceeded The maximum number of eni in a enterprise level security group is exceeded. The number of NICs in the enterprise security group exceeds the limit.
403 InvalidOperation.EipBindModel %s
403 InvalidOperation.Ipv6NotSupport %s The current operation is not supported for IPv6.
403 InvalidOperation.HotPlugNotSupport %s The operation is not supported while the specified resource is running. For more information, see the return value of the %s placeholder in the error message.
403 InvalidInstance.NetworkType %s
403 InvalidOperation.InvalidTrunkEniStatus %s The state of the specified trunk ENI does not allow this operation. For more information, see the actual return result of the %s placeholder in the error message.
403 InvalidOperation.TrunkingIsNotAllowed %s The trunk network card is not operational.
403 InvalidOperation.InstanceTypeNotSupportEniTrunking %s The current operation is not supported. For more information, see the actual return value of the %s placeholder in the error message.
403 InvalidOperation.EniTypeNotSupportTrunking %s The type of the ENI does not support operations related to the trunk mode. For more information, see the return value of the %s placeholder in the error message.
403 InvalidOperation.EniTrunkDeviceFull %s
403 InvalidParameter.EniNotBelongTrunk %s The specified ENI is not in trunk mode. For more information, see the return value of the %s placeholder in the error message.
403 InvalidOperation.EniTypeNotSupportAttachToTrunk %s
403 InvalidParameter.EniNotBelongEcs %s
403 InvalidParameter.InvalidEniQueueNumber %s The number of elastic network interface controller (NIC) queues is incorrect. For more information, see the actual return result of the %s placeholder in the error message.
403 InvalidOperation.MaxEniQueueNumberExceeded %s The number of elastic network interface controller (NIC) queues exceeds the upper limit. For more information, see the actual return result of the %s placeholder in the error message.
403 InvalidOperation.ExceedInstanceTypeQueueNumber %s The maximum number of queues for all ENIs on an instance has been exceeded. For more information, see the return value of the %s placeholder in the error message.
403 InvalidOperation.HighPerformanceTrafficModeNotSupportTrunkEni %s
403 InvalidOperation.HighPerformanceTrafficModeNotSupportMemberEni %s
403 InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode %s The instance type of the specified instance does not support the NIC of the RDMA communication mode.
403 InvalidOperation.EniTrafficModeNotSupportIpv6 %s
403 InvalidOperation.MaxEniQueuePairNumberExceed %s
403 InvalidParameter.InvalidQueuePairNumber %s
403 InvalidOperation.EniQueuePairNumberOverflow %s
403 InvalidOperation.HighPerformanceEniPerInstanceLimitExceeded %s
403 InvalidOperation.Ipv6CountExceeded %s. The operation is invalid because the number of IPv6 has reached the upper limit.
403 InvalidOperation.PrimaryEniNotExist Primary Eni Not Exist. The primary NIC of the instance does not exist.
404 InvalidEcsId.NotFound %s The specified instance ID does not exist.
404 InvalidEniId.NotFound %s
404 InvalidVSwitchId.NotFound %s The specified vSwitch does not exist.
404 InvalidSecurityGroupId.NotFound %s The specified security group ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.