文档

AttachNetworkInterface - 附加弹性网卡到专有网络VPC类型实例上

更新时间:

调用AttachNetworkInterface附加一个弹性网卡(ENI)到一台专有网络VPC类型ECS实例上。

接口说明

调用该接口时,请注意:

  • 弹性网卡必须处于可用Available)状态,一个弹性网卡只能同时附加到一台相同可用区且相同专有网络的实例上。

  • 实例需处于运行中(Running)或者已停止(Stopped)状态,部分实例规格的实例在附加弹性网卡时必须为已停止(Stopped)状态,更多信息,请参见附加弹性网卡中的需要停止实例的 ECS 实例规格章节。

    说明 如果实例最后一次启动时间在 2018 年 4 月 1 日之前(包括但不限于启动新购的实例、重启、重开机),您必须提前调用 RebootInstance 重启一直保持运行中状态的实例,否则无法附加弹性网卡。
  • 一台实例可以同时附加多个弹性网卡,更多信息,请参见弹性网卡概述

  • 弹性网卡所在的交换机必须与实例所在交换机属于同一可用区且同一专有网络 VPC。

  • 该接口为异步接口,调用成功后,您可以通过查询弹性网卡状态或监听网卡操作事件的方式来感知操作结果。 弹性网卡状态机如下图所示:

    • Attaching 说明附加弹性网卡请求发送成功,弹性网卡正在附加到 ECS 实例中。
    • InUse 说明弹性网卡已附加到 ECS 实例。
    • Available 说明弹性网卡附加到 ECS 实例失败。

调用示例详情参见附加弹性网卡

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:AttachNetworkInterfaceWrite
  • NetworkInterface
    acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • ecs:tag

请求参数

名称类型必填描述示例值
RegionIdstring

实例所在地域的 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
NetworkInterfaceIdstring

弹性网卡 ID。

eni-bp17pdijfczax1huji****
InstanceIdstring

实例 ID。

i-bp16qstyvxj9gpqw****
TrunkNetworkInstanceIdstring

中继网卡 ID。

说明 该参数暂未上线,不支持使用。
eni-f8zapqwj1v1j4ia3****
WaitForNetworkConfigurationReadyboolean
说明 该参数已废弃。
null
NetworkCardIndexinteger

网卡指定的物理网卡索引。

说明 NetworkCardIndex 取值与实例规格族有关。如果实例规格不支持 NetworkCard 则不能指定;如果支持,取值请参见实例规格族
0

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidOperation.Ipv6CountExceededThe number of IPv6 supported by the current instance type has reached the upper limit.-
400MissingParameter%s缺失参数,请检查参数是否完整。
400UnsupportedParameter%s不支持参数。
400InvalidParameter%s无效的参数。
400InvalidInstanceID.Malformed%s参数 InstanceId 格式错误。
400InvalidOperation.InvalidRegion%s指定的参数 RegionId 无效。
400InvalidOperation.InvalidEcsState%s实例当前的状态不支持此操作。
400InvalidOperation.InvalidEcsStateThe operation is not allowed in the current ECS state.-
400InvalidOperation.InvalidEniState%s弹性网卡当前的状态不支持此操作。
400InvalidOperation.DetachPrimaryEniNotAllowed%s不允许分离实例的主网卡。
400Forbidden.RegionId%s当前地域暂时没有提供该服务。
400InvalidOperation.InvalidGeneration%s该操作无效。
400InvalidParams.EniId%s指定的参数 EniId 无效。
400InvalidParameter.NetworkCardIndexInvalidInvalid network card index, please check instance type.-
400InvalidOperation.UserNotSupportNetworkCardUser not support network card.-
403InvalidUserType.NotSupported%s您当前的账号不支持此操作。
403Abs.InvalidAccount.NotFound%s您的阿里云账号不存在,或者您的 AccessKey 已经过期。
403Forbidden.NotSupportRAM%s暂不支持RAM用户执行该操作。
403Forbidden.SubUser%s您的账号没有操作此资源的权限,请向主账号申请相关的权限。
403MaxEniCountExceeded%s已超过可以操作的最大弹性网卡数。
403EniPerInstanceLimitExceeded%s实例附加的弹性网卡数量已经达到了最大限度,不能再为实例附加弹性网卡。
403InvalidOperation.AvailabilityZoneMismatch%s该操作无效。
403InvalidOperation.VpcMismatch%s您的操作无效,请确认该操作中的 VPC 与其它参数是否匹配。
403SecurityGroupInstanceLimitExceed%s该安全组内已有的实例数量已达到最大限制。
403InvalidSecurityGroupId.NotVpc%s参数 SecurityGroupId 无效,该安全组的网络类型不是专有网络。
403InvalidOperation.InvalidEniType%s当前弹性网卡的类型不支持此操作。
403InvalidInstanceId.NotFound%s指定的实例不存在,请确认参数 InstanceId 是否正确。
403InvalidEni.NotSameVpc%s指定的资源和指定的ENI不属于同一个VPC。具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.Ipv4CountExceeded%sIPv4 数量达到上限,导致该操作无效。
403InvalidOperation.EniServiceManaged%s操作无效。
403InvalidOperation.MultiGroupTypeThe specified instance can't join different types of security group.-
403InvalidOperation.NotSupportEnterpriseGroupThe specified instance type doesn't support enterprise level security group.-
403InvalidOperation.EniCountExceededThe maximum number of eni in a enterprise level security group is exceeded.-
403InvalidOperation.EipBindModel%s-
403InvalidOperation.Ipv6NotSupport%sIPv6不支持当前操作。
403InvalidOperation.HotPlugNotSupport%s指定的资源处于运行状态,不支持本次操作,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidInstance.NetworkType%s-
403InvalidOperation.InvalidTrunkEniStatus%s指定的中继模式的ENI状态不允许执行本次操作,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.TrunkingIsNotAllowed%s-
403InvalidOperation.InstanceTypeNotSupportEniTrunking%s不支持本次操作。具体信息请参见错误信息%s占位符的实际返回值。
403InvalidOperation.EniTypeNotSupportTrunking%sENI的类型不支持中继模式的相关操作,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.EniTrunkDeviceFull%s-
403InvalidParameter.EniNotBelongTrunk%s指定的ENI不属于中继模式的ENI,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.EniTypeNotSupportAttachToTrunk%s-
403InvalidParameter.EniNotBelongEcs%s指定的ENI不属于指定的ECS实例,具体信息请参见错误信息%s占位符的实际返回结果。您可以调用DescribeInstances查看指定ECS实例已附加的ENI ID。
403InvalidParameter.InvalidEniQueueNumber%s弹性网卡队列数有误,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.MaxEniQueueNumberExceeded%s弹性网卡队列数超过上限,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.ExceedInstanceTypeQueueNumber%s弹性网卡队列总数超过上限,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.HighPerformanceTrafficModeNotSupportTrunkEni%s-
403InvalidOperation.HighPerformanceTrafficModeNotSupportMemberEni%s-
403InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode%s-
403InvalidOperation.EniTrafficModeNotSupportIpv6%s-
403InvalidOperation.MaxEniQueuePairNumberExceed%s-
403InvalidParameter.InvalidQueuePairNumber%s-
403InvalidOperation.EniQueuePairNumberOverflow%s-
403InvalidOperation.HighPerformanceEniPerInstanceLimitExceeded%s-
404InvalidEcsId.NotFound%s指定的实例 ID 不存在。
404InvalidEniId.NotFound%s指定的弹性网卡 ID 不存在。
404InvalidVSwitchId.NotFound%s指定的交换机不存在。
404InvalidSecurityGroupId.NotFound%s指定的安全组 ID 不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-01-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:NetworkCardIndex
  • 本页导读 (1)
文档反馈