调用ModifyNetworkInterfaceAttribute接口,并可以指定NetworkInterfaceId、SecurityGroupId等参数,修改一个弹性网卡(ENI)的名称、描述以及所属安全组等属性。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:ModifyNetworkInterfaceAttribute | update | *NetworkInterface acs:ecs:{#regionId}:{#accountId}:eni/{#eniId} *SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 弹性网卡所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
NetworkInterfaceName | string | 否 | 弹性网卡的名称。长度为 2~128 个字符,必须以大小写字母或中文开头,不能以 默认值:空。 | eniTestName |
NetworkInterfaceId | string | 是 | 弹性网卡 ID。 | eni-bp67acfmxazb4p**** |
QueueNumber | integer | 否 | 网卡队列数。取值范围:1~2048。
| 8 |
Description | string | 否 | 弹性网卡的描述信息。长度为 2~255 个英文或中文字符,不能以 http://和 https://开头。 默认值:空。 | testDescription |
SecurityGroupId | array | 否 | SecurityGroupId 列表,辅助弹性网卡最终加入的安全组,并会移出已有的安全组。
| |
string | 否 | SecurityGroupId 列表。
| sg-bp67acfmxazb4p**** | |
DeleteOnRelease | boolean | 否 | 释放实例时是否保留网卡。取值范围:
| true |
RxQueueSize | integer | 否 | 弹性网卡入方向队列深度。 您需要注意:
| 8192 |
TxQueueSize | integer | 否 | 弹性网卡出方向队列深度。 您需要注意:
| 8192 |
NetworkInterfaceTrafficConfig | object | 否 | 弹性网卡通讯参数 | |
NetworkInterfaceTrafficMode | string | 否 | 网卡的通讯模式。参数取值范围:
当弹性网卡处于挂载态时,您需要注意:
说明
该参数正在邀测中,暂未开放使用。
| HighPerformance |
QueueNumber | integer | 否 | 弹性网卡队列数。 当弹性网卡处于挂载态时,您需要注意:
说明
该参数正在邀测中,暂未开放使用。
| 8 |
QueuePairNumber | integer | 否 | RDMA 网卡队列数。 当弹性网卡处于挂载态时,您需要注意:
说明
该参数正在邀测中,暂未开放使用。
| 8 |
RxQueueSize | integer | 否 | 弹性网卡入方向队列深度。 您需要注意:
说明
该参数正在邀测中,暂未开放使用。
| 8192 |
TxQueueSize | integer | 否 | 弹性网卡出方向队列深度。 您需要注意:
说明
该参数正在邀测中,暂未开放使用。
| 8192 |
ConnectionTrackingConfiguration | object | 否 | 说明
该参数正在邀测中,暂未开放使用。
| |
TcpEstablishedTimeout | integer | 否 | 说明
该参数正在邀测中,暂未开放使用。
| 910 |
TcpClosedAndTimeWaitTimeout | integer | 否 | 说明
该参数正在邀测中,暂未开放使用。
| 3 |
UdpTimeout | integer | 否 | 说明
该参数正在邀测中,暂未开放使用。
| 30 |
EnhancedNetwork | object | 否 | 该参数暂未开放使用。 | |
EnableSriov | boolean | 否 | 该参数暂未开放使用。 | true |
SourceDestCheck | boolean | 否 | 说明
该参数正在邀测中,暂未开放使用。
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidOperation.NotSupportModifyQueueNumber | %s | - |
400 | MissingParameter | %s | 缺失参数,请检查参数是否完整。 |
400 | UnsupportedParameter | %s | 不支持参数。 |
400 | InvalidParameter | %s | 无效的参数。 |
400 | InvalidInstanceID.Malformed | %s | 参数 InstanceId 格式错误。 |
400 | InvalidOperation.InvalidEcsState | %s | 实例当前的状态不支持此操作。 |
400 | InvalidOperation.InvalidEniState | %s | 弹性网卡当前的状态不支持此操作。 |
400 | InvalidOperation.DetachPrimaryEniNotAllowed | %s | 不允许分离实例的主网卡。 |
400 | InvalidParams.EniId | %s | 指定的参数 EniId 无效。 |
400 | Forbidden.RegionId | %s | 当前地域暂时没有提供该服务。 |
400 | JoinedGroupLimitExceed | %s | 指定资源所能加入的安全组数量达到上限。具体信息请参见错误信息%s占位符的实际返回结果。 |
400 | InvalidEniQueueSize.RegionOrUserNotSupported | The specified parameter RxQueueSize or TxQueueSize is not supported in this region, or this account is not in the whitelist of using eni QueueSize. | 地域或用户不支持设置网卡队列深度 |
400 | InvalidParameter.EniQueueSize | The specified parameter TxQueueSize and RxQueueSize are not equal or exceed limit. | 出方向和入方向网卡队列深度不相等或超出允许的范围 |
400 | InvalidParameter.Conflict | %s | 您输入的参数无效,请检查参数之间是否冲突。%s为变量,将根据调用API的实际情况动态返回错误信息。 |
400 | InvalidConnectionTrackingConfiguration.RegionOrUserNotSupported | The specified parameter ConnectionTrackingConfiguration is not supported in this region, or this account is not in the whitelist of using network interface ConnectionTrackingConfiguration. | 地域或用户不支持设置网卡连接配置 |
400 | InvalidParameter.InvalidQueuePairNumber | The specified parameter QueuePairNumber exceeds limit. | 指定的RDMA网卡队列数超过限制。 |
400 | InvalidParameter.EniConnectionTrackingConfiguration | The specify network interface connection tracking configuration exceeds limit. | 网卡指定的网络连接配置超出允许的范围 |
400 | InvalidOperation.MaxEniQueuePairNumberExceed | The QueuePairNumber on the RDMA ENI exceeds the upper limit allowed for a single ENI. | 该弹性网卡 RDMA 队列数超过单张弹性网卡允许的上限 |
400 | InvalidOperation.HighPerformanceEniPerInstanceLimitExceeded | The number of RDMA ENIs attached to the ECS instance exceeds the upper limit. | 弹性网卡所在的ECS实例挂载的 RDMA 网卡数超上限 |
400 | InvalidOperation.InstanceTypeNotSupportHighPerformance | The ECS instance type where the ENI is located does not support the RDMA mode. | 弹性网卡所在的ECS实例规格不支持 RDMA 通讯模式 |
400 | InvalidTrafficMode.ModifyToStandardNotSupported | The specified parameter NetworkInterfaceTrafficMode is not supported to modify to Standard. | 不支持将弹性网卡的通讯模式改为 Standard 。 |
400 | InvalidOperation.EniTrafficModeNotSupportIPv6 | The ENI using High Performance traffic mode does not support IPv6. | 使用 RDMA 高性能通讯模式的弹性网卡,不支持使用 IPv6。 |
400 | InvalidOperation.EniQueuePairNumberOverflow | The RDMA QueuePairNumber of the ECS instance associated with the specified ENI exceeds the limit. | 指定的弹性网卡所在的ECS实例 RDMA 网卡队列数超出限制。 |
400 | InvalidParameter.QueuePairNumberMustEmpty | When the traffic mode is set to Standard, the QueuePairNumber must be empty. | 创建TCP通讯模式的弹性网卡时,弹性网卡的RDMA模式队列数必须为空。 |
400 | InvalidParameter.EniTrafficMode | The ENI traffic mode is set incorrectly, it must be either Standard or HighPerformance. | 弹性网卡的通讯模式不合法,取值范围为Standard或HighPerformance。 |
403 | InvalidUserType.NotSupported | %s | 您当前的账号不支持此操作。 |
403 | Abs.InvalidAccount.NotFound | %s | 您的阿里云账号不存在,或者您的 AccessKey 已经过期。 |
403 | Forbidden.NotSupportRAM | %s | 暂不支持RAM用户执行该操作。 |
403 | Forbidden.SubUser | %s | 您的账号没有操作此资源的权限,请向主账号申请相关的权限。 |
403 | MaxEniCountExceeded | %s | 已超过可以操作的最大弹性网卡数。 |
403 | EniPerInstanceLimitExceeded | %s | 实例附加的弹性网卡数量已经达到了最大限度,不能再为实例附加弹性网卡。 |
403 | InvalidOperation.AvailabilityZoneMismatch | %s | 该操作无效。 |
403 | InvalidOperation.VpcMismatch | %s | 您的操作无效,请确认该操作中的 VPC 与其它参数是否匹配。 |
403 | SecurityGroupInstanceLimitExceed | %s | 该安全组内已有的实例数量已达到最大限制。 |
403 | InvalidSecurityGroupId.NotVpc | %s | 参数 SecurityGroupId 无效,该安全组的网络类型不是专有网络。 |
403 | InvalidOperation.InvalidEniType | %s | 当前弹性网卡的类型不支持此操作。 |
403 | InvalidOperation.EniServiceManaged | %s | 操作无效。 |
403 | InvalidOperation.MultiGroupType | The specified instance can't join different types of security group. | - |
403 | InvalidOperation.EniCountExceeded | The maximum number of eni in a enterprise level security group is exceeded. | - |
403 | InvalidParams.NetworkInterfaceName | %s | - |
403 | InvalidOperation.ModifyPrimaryEniQueueNumber | Primary NetworkInterface is not allowed to modify queue number. | - |
403 | InvalidOperation.InvalidEniState | Available status or ECS instance attached is Stopped is allowed to modify network interface queue number. | - |
403 | InvalidOperation.ResourceManagedByCloudProduct | %s | 云产品托管的安全组不支持修改操作。 |
403 | InvalidParameter.InvalidEniQueueNumber | %s | 弹性网卡队列数有误,具体信息请参见错误信息%s占位符的实际返回结果。 |
403 | InvalidOperation.MaxEniQueueNumberExceeded | %s | 弹性网卡队列数超过上限,具体信息请参见错误信息%s占位符的实际返回结果。 |
403 | InvalidOperation.ExceedInstanceTypeQueueNumber | %s | 弹性网卡队列总数超过上限,具体信息请参见错误信息%s占位符的实际返回结果。 |
403 | AclLimitExceed | %s | 网卡或实例的安全组规则数量超过限额值。 |
404 | InvalidEcsId.NotFound | %s | 指定的实例 ID 不存在。 |
404 | InvalidEniId.NotFound | %s | 指定的弹性网卡 ID 不存在。 |
404 | InvalidVSwitchId.NotFound | %s | 指定的交换机不存在。 |
404 | InvalidSecurityGroupId.NotFound | %s | 指定的安全组 ID 不存在。 |
404 | InvalidOperation.PrimaryEniOnlySupportModifyNameAndDesc | Primary NetworkInterface is only allowed to modify name and description. | 主网卡仅支持修改网卡名称和描述。 |
404 | InvalidSecurityGroupId.NotFound | Specified security group not exist. | 指定的安全组在该用户账号下不存在,请您检查安全组 id 是否正确。 |
404 | InvalidParameter.SecurityGroupIdRepeated | The specified security group ids has repeated. | 指定的安全组已重复添加。请检查 SecurityGroupIds 参数值是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-23 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-07-03 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-07-03 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-07 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-01-24 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-10-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-14 | OpenAPI 错误码发生变更 | 查看变更详情 |