AssignPrivateIpAddresses - Elastic Compute Service

為一塊彈性網卡分配一個或多個輔助私網 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
RegionId	string	是	彈性網卡 ID。	cn-hangzhou
NetworkInterfaceId	string	是	指定私網 IP 位址數量，自動從交換機的空閒 IP 位址中分配 IP 位址。分配輔助私網 IP 位址時，您不能同時指定`PrivateIpAddress.N`和`SecondaryPrivateIpAddressCount`。	eni-bp67acfmxazb4p****
SecondaryPrivateIpAddressCount	integer	否	保證請求冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證冪等性。	1
ClientToken	string	否	從彈性網卡所屬交換機的空閒 IP 位址中選擇一個或多個輔助私網 IP 位址。N 的取值範圍：彈性網卡處於可用（`Available`）狀態：1~32。彈性網卡處於已附加（`InUse`）狀態：受到執行個體規格限制，更多資訊，請參見執行個體規格族。分配輔助私網 IP 位址時，您不能同時指定`PrivateIpAddress.N`和`SecondaryPrivateIpAddressCount`。	123e4567-e89b-12d3-a456-426655440000
PrivateIpAddress	array	否	為彈性網卡指定一個或多個 IPv4 前綴。N 的取值範圍：1~10。說明如果您需要為彈性網卡設定 IPv4 前綴，則必須設定 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一個，但不能同時設定這兩個參數。	10.1..
	string	否	為彈性網卡指定一個或多個 IPv4 前綴。N 的取值範圍：1~10。說明如果您需要為彈性網卡設定 IPv4 前綴，則必須設定 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一個，但不能同時設定這兩個參數。	10.1..
Ipv4Prefix	array	否	為彈性網卡指定隨機產生的 IPv4 前綴數量。取值範圍：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

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AssignedPrivateIpAddressesSet	object	已分配輔助私網 IP 位址的彈性網卡資訊組成的集合。
NetworkInterfaceId	string	彈性網卡 ID。	eni-bp125p95hhdhn3ot****
PrivateIpSet	object
PrivateIpAddress	array	已指派的私網 IP 位址集合。
	string	已指派的私網 IP 位址。	192.168..
Ipv4PrefixSet	object
Ipv4Prefixes	array	已指派的 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	錯誤碼	錯誤資訊
400	Throttling	Request was denied due to request throttling.
400	InvalidOperation.Unsupported	%s
400	UnsupportedParameter	%s
400	InvalidParameter	%s
400	InvalidInstanceID.Malformed	%s
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	InvalidParameter.Conflict	%s
400	InvalidOperation.InstanceNotSupportMulitipleIp	Assigning private ip for instance in cloud box is unsupported.
400	IncorrectVSwitchStatus	The operation is not allowed in the current VSwitch state. Expecting state includes "Created Available", but current state is "%s".
400	QuotaExceeded.PrivateIpAddress	There are not enough private IPs in the specified VSwitch.
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.
400	InvalidVSwitch.IllegalStatus	The operation is not allowed in the current VSwitch state. Expecting state includes "Created", but current state is "%s".
500	InvalidOperation.RegionNotSupportIpPrefix	The current region does not support IP prefix feature.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
500	InvalidParameter.PrivateIpCount	The current privateIpCount is not in the range 1.0 through 100.0.
403	InvalidUserType.NotSupported	%s
403	Abs.InvalidAccount.NotFound	%s
403	MissingParameter	%s
403	Forbidden.NotSupportRAM	%s
403	Forbidden.SubUser	%s
403	MaxEniCountExceeded	%s
403	EniPerInstanceLimitExceeded	%s
403	InvalidOperation.AvailabilityZoneMismatch	%s
403	InvalidOperation.VpcMismatch	%s
403	SecurityGroupInstanceLimitExceed	%s
403	InvalidSecurityGroupId.NotVpc	%s
403	InvalidOperation.InvalidEniType	%s
403	InvalidVSwitchId.IpNotEnough	%s
403	InvalidVSwitchId.IpInvalid	%s
403	InvalidIp.IpAssigned	%s
403	MaxEniPrivateIpsCountExceeded	%s
403	Operation.Conflict	%s
403	InvalidOperation.Ipv4CountExceeded	%s
403	InvalidOperation.EniServiceManaged	%s
403	InvalidIp.IpRepeated	%s
403	InvalidIp.IpPrefixIllegal	The ip prefixes %s is/are illegal.
403	InvalidIp.IpPrefixMaskIllegal	The current IP prefix mask is illegal.
403	InvalidIp.IpPrefixMaskNotSame	The IP prefixes %s are illegal.The IP prefix mask must be the same.
403	InvalidIp.IpPrefixNotAvailable	The IP prefix is not available.
403	InvalidIp.IpPrefixNotStrict	The IP prefix "%s" must be strict CIDR format.
403	InvalidVSwitchId.IpPrefixNotEnough	The specified VSwitch does not have enough IP prefixes.
403	InvalidIp.IpPrefixMaskInvalid	The IP prefixes mask "%s" is illegal.Ensure the mask is between %s and %s.
403	InvalidIp.IpPrefixMustInReserveSegment	The IP prefix must be in VSwitch reserved segment. Ensure you create reserved segment for the VSwitch.
404	InvalidEcsId.NotFound	%s
404	InvalidEniId.NotFound	%s
404	InvalidVSwitchId.NotFound	%s
404	InvalidSecurityGroupId.NotFound	%s
404	InvalidInstanceId.NotFound	%s
404	InvalidOperation.VSwitchCidrReservationNotExist	The specified VSwitch does not have CIDR reservation.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。