为一块弹性网卡分配一个或多个辅助私网IP地址。可以为网卡指定在所属交换机(vSwitch)的空闲私网IP地址,或者通过指定私网地址数量自动分配私网IP地址。
接口说明
- 只支持可用(Available)或者已附加(InUse)状态下的弹性网卡。
- 操作主网卡时,网卡附加的实例必须处于运行中(Running)或者已停止(Stopped)状态。
- 网卡处于可用(Available)状态时,最多可以分配 49 个辅助私网 IP 地址。一旦挂载到实例上,网卡能分配的辅助私网 IP 地址数将受到实例规格限制。更多详情,请参见实例规格族。
- 成功调用该接口后,您可以从返回结果中获取已分配的辅助私网 IP 地址信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:AssignPrivateIpAddresses | create | *NetworkInterface acs:ecs:{#regionId}:{#accountId}:eni/{#eniId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 弹性网卡所属的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
NetworkInterfaceId | string | 是 | 弹性网卡 ID。 | eni-bp67acfmxazb4p**** |
SecondaryPrivateIpAddressCount | integer | 否 | 指定私网 IP 地址数量,自动从交换机的空闲 IP 地址中分配 IP 地址。 分配辅助私网 IP 地址时,您不能同时指定 | 1 |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
PrivateIpAddress | array | 否 | 从弹性网卡所属交换机的空闲 IP 地址中选择一个或多个辅助私网 IP 地址。N 的取值范围:
分配辅助私网 IP 地址时,您不能同时指定 | |
string | 否 | 从弹性网卡所属交换机的空闲 IP 地址中选择一个或多个辅助私网 IP 地址。N 的取值范围:
说明
分配辅助私网 IP 地址时,您不能同时指定 PrivateIpAddress.N 和SecondaryPrivateIpAddressCount 。
| 10.1.**.** | |
Ipv4Prefix | array | 否 | 为弹性网卡指定一个或多个 IPv4 前缀。N 的取值范围:1~10。 说明
如果您需要为弹性网卡设置 IPv4 前缀,则必须设置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一个,但不能同时设置这两个参数。
| |
string | 否 | 为弹性网卡指定一个或多个 IPv4 前缀。N 的取值范围:1~10。 说明
如果您需要为弹性网卡设置 IPv4 前缀,则必须设置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一个,但不能同时设置这两个参数。
| 192.168.**.**/28 | |
Ipv4PrefixCount | integer | 否 | 为弹性网卡指定随机生成的 IPv4 前缀数量。取值范围:1~10。 说明
如果您需要为弹性网卡设置 IPv4 前缀,则必须设置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一个,但不能同时设置这两个参数。
| 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"AssignedPrivateIpAddressesSet": {
"NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
"PrivateIpSet": {
"PrivateIpAddress": [
"192.168.**.**"
]
},
"Ipv4PrefixSet": {
"Ipv4Prefixes": [
"192.168.**.**/28"
]
}
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Throttling | Request was denied due to request throttling. | 请求被流控。 |
400 | InvalidOperation.Unsupported | %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 | MissingParameter | %s | 缺失参数,请检查参数是否完整。 |
400 | Forbidden.RegionId | %s | 当前地域暂时没有提供该服务。 |
400 | InvalidAction | %s | 操作无效。 |
400 | InvalidPrivateIpAddress.Duplicated | Specified private IP address is duplicated. | - |
400 | InvalidPrivateIpAddress.Malformed | %s | - |
400 | InvalidSecondaryPrivateIpAddressCount.Malformed | %s | - |
400 | InvalidOperation.InvalidEniState | The operation is not allowed in the current ENI state. | 当前状态下的网卡不可操作。 |
400 | InvalidParameter.Conflict | %s | 您输入的参数无效,请检查参数之间是否冲突。%s为变量,将根据调用API的实际情况动态返回错误信息。 |
400 | InvalidOperation.InstanceNotSupportMulitipleIp | Assigning private ip for instance in cloud box is unsupported. | 云盒环境不支持给实例分配多ip。 |
400 | IncorrectVSwitchStatus | The operation is not allowed in the current VSwitch state. Expecting state includes "Created Available", but current state is "%s". | vSwitch当前状态不支持该操作。 |
400 | InvalidPrivateIpAddress.Duplicated | The specified private IP address "%s" is duplicated. | 指定的IP地址已经被使用。 |
400 | QuotaExceeded.PrivateIpAddress | There are not enough private IPs in the specified VSwitch. | 当前交换机没有足够的Ip |
400 | InvalidStatus.InstanceIsMigrating | The ECS which ENI is attached to is migrating. Please try again later. | 网卡所挂载的实例正在迁移中,请稍后重试。 |
400 | InvalidEniId.Malformed | The specified parameter "NetworkInterfaceId" is not valid. Ensure you provide the full ENI id in the form eni-xxx. | 网卡Id输入不符合规范 |
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 | InvalidVSwitchId.IpNotEnough | %s | 指定的交换机内 IP 数量不足。 |
403 | InvalidVSwitchId.IpInvalid | %s | 指定的私网 IP 无效。 |
403 | InvalidIp.IpAssigned | %s | 指定的 IP 已被分配。 |
403 | MaxEniPrivateIpsCountExceeded | %s | 指定的ENI分配的辅助私网IP数量超过限制,具体信息请参见错误信息%s占位符的实际返回结果。 |
403 | Operation.Conflict | %s | 您当前的操作与其它正在执行的操作有冲突,请稍后重试。 |
403 | InvalidOperation.Ipv4CountExceeded | %s | IPv4 数量达到上限,导致该操作无效。 |
403 | InvalidOperation.EniServiceManaged | %s | 操作无效。 |
403 | InvalidIp.IpRepeated | %s | 指定的 IP 重复。 |
403 | InvalidIp.IpPrefixIllegal | The ip prefixes %s is/are illegal. | IP前缀无效,不是cidr格式。 |
403 | MissingParameter | These parameters %s cannot all be empty. | 这些参数不能都为空 |
403 | InvalidIp.IpPrefixMaskIllegal | The current IP prefix mask is illegal. | IP前缀掩码非法。 |
403 | InvalidIp.IpPrefixMaskNotSame | The IP prefixes %s are illegal.The IP prefix mask must be the same. | IP前缀掩码不相同。 |
403 | InvalidIp.IpPrefixNotAvailable | The IP prefix is not available. | IP前缀非空闲。 |
403 | InvalidIp.IpPrefixNotStrict | The IP prefix "%s" must be strict CIDR format. | IP前缀无效,不是严格的cidr。 |
403 | InvalidVSwitchId.IpPrefixNotEnough | The specified VSwitch does not have enough IP prefixes. | 指定的交换机内 IP前缀数量不足。 |
403 | InvalidIp.IpPrefixMaskInvalid | The IP prefixes mask "%s" is illegal.Ensure the mask is between %s and %s. | IP前缀掩码非法,不在有效范围内。 |
403 | InvalidIp.IpPrefixMustInReserveSegment | The IP prefix must be in VSwitch reserved segment. Ensure you create reserved segment for the VSwitch. | IP前缀无效,不在交换机的预留地址段内。 |
404 | InvalidEcsId.NotFound | %s | 指定的实例 ID 不存在。 |
404 | InvalidEniId.NotFound | %s | 指定的弹性网卡 ID 不存在。 |
404 | InvalidVSwitchId.NotFound | %s | 指定的交换机不存在。 |
404 | InvalidSecurityGroupId.NotFound | %s | 指定的安全组 ID 不存在。 |
404 | InvalidInstanceId.NotFound | %s | 指定的实例不存在,请确认参数 InstanceId 是否正确。 |
404 | InvalidOperation.VSwitchCidrReservationNotExist | The specified VSwitch does not have CIDR reservation. | 指定的交换机没有可用的预留段。 |
500 | InvalidOperation.RegionNotSupportIpPrefix | The current region does not support IP prefix feature. | 该地域不支持分配IP前缀。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误,请重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-20 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-17 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-04-26 | OpenAPI 错误码发生变更 | 查看变更详情 |