文档

AssignPrivateIpAddresses - 为弹性网卡分配辅助私有IP地址

更新时间:

为一块弹性网卡分配一个或多个辅助私网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:AssignPrivateIpAddressesWrite
  • NetworkInterface
    acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}
  • ecs:tag

请求参数

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

弹性网卡所属的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
NetworkInterfaceIdstring

弹性网卡 ID。

eni-bp67acfmxazb4p****
SecondaryPrivateIpAddressCountinteger

指定私网 IP 地址数量,自动从交换机的空闲 IP 地址中分配 IP 地址。

分配辅助私网 IP 地址时,您不能同时指定PrivateIpAddress.NSecondaryPrivateIpAddressCount

1
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
PrivateIpAddressarray

从弹性网卡所属交换机的空闲 IP 地址中选择一个或多个辅助私网 IP 地址。N 的取值范围:

  • 弹性网卡处于可用(Available)状态:1~32。
  • 弹性网卡处于已附加(InUse)状态:受到实例规格限制,更多信息,请参见实例规格族

分配辅助私网 IP 地址时,您不能同时指定PrivateIpAddress.NSecondaryPrivateIpAddressCount

string

从弹性网卡所属交换机的空闲 IP 地址中选择一个或多个辅助私网 IP 地址。N 的取值范围:

  • 弹性网卡处于可用(Available)状态:1~32。
  • 弹性网卡处于已附加(InUse)状态:受到实例规格限制,更多信息,请参见实例规格族
说明 分配辅助私网 IP 地址时,您不能同时指定PrivateIpAddress.NSecondaryPrivateIpAddressCount
10.1.**.**
Ipv4Prefixarray

为弹性网卡指定一个或多个 IPv4 前缀。N 的取值范围:1~10。

说明 如果您需要为弹性网卡设置 IPv4 前缀,则必须设置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一个,但不能同时设置这两个参数。
string

为弹性网卡指定一个或多个 IPv4 前缀。N 的取值范围:1~10。

说明 如果您需要为弹性网卡设置 IPv4 前缀,则必须设置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一个,但不能同时设置这两个参数。
192.168.**.**/28
Ipv4PrefixCountinteger

为弹性网卡指定随机生成的 IPv4 前缀数量。取值范围:1~10。

说明 如果您需要为弹性网卡设置 IPv4 前缀,则必须设置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一个,但不能同时设置这两个参数。
1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AssignedPrivateIpAddressesSetobject

已分配辅助私网 IP 地址的弹性网卡信息组成的集合。

NetworkInterfaceIdstring

弹性网卡 ID。

eni-bp125p95hhdhn3ot****
PrivateIpSetarray

已分配的私网 IP 地址集合。

string

已分配的私网 IP 地址。

192.168.**.**
Ipv4PrefixSetarray

已分配的 IPv4 前缀集合。

string

已分配的 IPv4 前缀。

192.168.**.**/28

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "AssignedPrivateIpAddressesSet": {
    "NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
    "PrivateIpSet": {
      "PrivateIpAddress": [
        "192.168.**.**"
      ]
    },
    "Ipv4PrefixSet": {
      "Ipv4Prefixes": [
        "192.168.**.**/28"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400ThrottlingRequest was denied due to request throttling.请求被流控。
400InvalidOperation.Unsupported%s-
400UnsupportedParameter%s不支持参数。
400InvalidParameter%s无效的参数。
400InvalidInstanceID.Malformed%s参数 InstanceId 格式错误。
400InvalidOperation.InvalidEcsState%s实例当前的状态不支持此操作。
400InvalidOperation.InvalidEniState%s弹性网卡当前的状态不支持此操作。
400InvalidOperation.DetachPrimaryEniNotAllowed%s不允许分离实例的主网卡。
400MissingParameter%s缺失参数,请检查参数是否完整。
400Forbidden.RegionId%s当前地域暂时没有提供该服务。
400InvalidAction%s操作无效。
400InvalidEniId.MalformedThe specified parameter "EniId" is not valid.-
400IncorrectVSwitchStatusThe current status of vSwitch does not support this operation.vSwitch当前状态不支持该操作。
400InvalidPrivateIpAddress.DuplicatedSpecified private IP address is duplicated.指定的私网 IP 已经被使用,请您更换 IP 再重试。
400InvalidPrivateIpAddress.Malformed%s-
400InvalidSecondaryPrivateIpAddressCount.Malformed%s-
400QuotaExceeded.PrivateIpAddressThere is no enough private ip in the specified VSwitch.-
400InvalidOperation.InvalidEniStateThe operation is not allowed in the current ENI state.-
400InvalidParameter.Conflict%s您输入的参数无效,请检查参数之间是否冲突。%s为变量,将根据调用API的实际情况动态返回错误信息。
400InvalidOperation.InstanceNotSupportMulitipleIpAssigning private ip for instance in cloud box is unsupported.云盒环境不支持给实例分配多ip。
400InvalidStatus.InstanceIsMigratingThe instance which eni attached is migrating, please try it later.网卡所挂载的实例正在迁移中,请稍后重试。
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当前弹性网卡的类型不支持此操作。
403InvalidVSwitchId.IpNotEnough%s指定的交换机内 IP 数量不足。
403InvalidVSwitchId.IpInvalid%s指定的私网 IP 无效。
403InvalidIp.IpAssigned%s指定的 IP 已被分配。
403MaxEniPrivateIpsCountExceeded%s指定的ENI分配的辅助私网IP数量超过限制,具体信息请参见错误信息%s占位符的实际返回结果。
403Operation.Conflict%s您当前的操作与其它正在执行的操作有冲突,请稍后重试。
403InvalidOperation.Ipv4CountExceeded%sIPv4 数量达到上限,导致该操作无效。
403InvalidOperation.EniServiceManaged%s操作无效。
403InvalidIp.IpRepeated%s指定的 IP 重复。
403InvalidIp.IpPrefixIllegalThe ip prefixes %s is/are illegal.IP前缀无效,不是cidr格式。
403InvalidIp.IpPrefixMaskIllegalThe ip prefix mask is illegal.IP前缀掩码非法。
403InvalidIp.IpPrefixMaskInvalidThe ip prefixes mask %s is illegal which must be between %s and %s.IP前缀掩码非法,不在有效范围内。
403InvalidIp.IpPrefixMaskNotSameThe ip prefixes %s are illegal which mask must be same.IP前缀掩码不相同。
403InvalidIp.IpPrefixMustInReserveSegmentThe ip prefix must in vswitch reserve segment.IP前缀无效,不在交换机的预留地址段内。
403InvalidIp.IpPrefixNotAvailableThe ip prefix is/are not available.IP前缀非空闲。
403InvalidIp.IpPrefixNotStrictThe ip prefix must be strict cidr format.IP前缀无效,不是严格的cidr。
403InvalidVSwitchId.IpPrefixNotEnoughThe specified vSwitch has not enough ip prefix.指定的交换机内 IP前缀数量不足。
403MissingParameterThese parameters %s cannot be both empty.请求中参数缺失,所需参数不可全部为空
404InvalidEcsId.NotFound%s指定的实例 ID 不存在。
404InvalidEniId.NotFound%s指定的弹性网卡 ID 不存在。
404InvalidVSwitchId.NotFound%s指定的交换机不存在。
404InvalidSecurityGroupId.NotFound%s指定的安全组 ID 不存在。
404InvalidInstanceId.NotFound%s指定的实例不存在,请确认参数 InstanceId 是否正确。
404InvalidOperation.VSwitchCidrReservationNotExistThe specified vSwitch has no cidr reservation.指定的交换机没有可用的预留段。
500InvalidOperation.RegionNotSupportIpPrefixThe current region does not support ip prefix.该地域不支持分配IP前缀。

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

变更历史

变更时间变更内容概要操作
2023-08-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-04-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
  • 本页导读 (1)
文档反馈