DetachNetworkInterface

更新时间:
复制 MD 格式

Detach an elastic network interface (ENI) from an Elastic Compute Service (ECS) instance.

Operation description

Take note of the following items:

  • You cannot detach the primary ENI of an instance.

  • Make sure that the ENI to be detached is in the Detaching (Unbinding) or InUse (Bound) state.

  • Make sure that the instance from which you want to detach an ENI is in the Running (Running) or Stopped (Stopped) state.

  • The DetachNetworkInterface operation is an asynchronous operation. After this operation is called to detach an ENI, you can check the status or events of the ENI to determine whether the ENI is detached. The following figure shows the transitions between the states of the ENI.

    • If the ENI is in the Detaching state, the ENI detachment request is sent and the ENI is being detached from the associated instance.

    • If the ENI is in the Available state, the ENI is detached from the associated instance.

    • If the ENI is stuck in the Detaching state, the ENI may fail to be detached from the associated instance due to specific reasons. For example, the ENI may fail to be detached because the operating system of the instance did not respond to the ENI detachment request. If this issue occurs, you can re-initiate the request to detach the ENI. If the issue persists, restart the instance.

For information about examples on how to call the DetachNetworkInterface operation, see Detach an ENI from an ECS instance.

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:DetachNetworkInterface

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 ID of the ENI.

cn-hangzhou

RegionId

string

Yes

The ID of the ENI.

cn-hangzhou

NetworkInterfaceId

string

Yes

The ID of the instance

eni-bp67acfmxazb4p****

InstanceId

string

Yes

The ID of the trunk ENI.

Note

This parameter is unavailable for use.

i-bp67acfmxazb4p****

TrunkNetworkInstanceId

string

No

The ID of the request.

eni-f8zapqwj1v1j4ia3****

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

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

Error response

JSON format

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

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
400 InvalidOperation.InvalidEniState %s
400 InvalidOperation.DetachPrimaryEniNotAllowed %s
400 Forbidden.RegionId %s The service is unavailable in the current region.
400 InvalidParams.EniId %s The specified EniId parameter is invalid.
400 InvalidParameter.EniNotBelongEcs %s
400 InvalidOperation.EniHotPlugNotSupported The ENI with high-performance traffic mode cannot be hot-plugged. Please stop the ECS instance to which the ENI is attached, and try again. An ENI with high-performance communication mode enabled does not support hot unplugging. Stop the ECS instance to which the ENI is mounted and try again.
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
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
403 InvalidOperation.EniServiceManaged %s The operation is invalid.
403 InvalidOperation.EniLinked %s The operation is invalid because the current ENI of the instance is associated with other ENIs. You must disassociate the ENI from the other ENIs before you can unbind the ENI from the instance.
403 InvalidInstanceId.NotFound %s The specified instance does not exist. Check whether the InstanceId parameter is valid.
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 InvalidOperation.InvalidTrunkEniStatus %s
403 InvalidOperation.TrunkingIsNotAllowed %s The trunk network card is not operational.
403 InvalidOperation.InstanceTypeNotSupportEniTrunking %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.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.HasMemberEniAttached %s Other ENIs are attached to the ENI that works in trunk mode. For more information, see the return value of the %s placeholder in the error message.
403 InvalidParameter.EniNotBelongEcs %s
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.