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

返回參數

名稱	類型	描述	樣本值
	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.	CloudBox 環境不支援為執行個體分配多個 IP。
400	IncorrectVSwitchStatus	The operation is not allowed in the current VSwitch state. Expecting state includes "Created Available", but current state is "%s".	指定的虛擬交換器處於 pending 狀態，無法刪除。
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 輸入不符合規範。
400	InvalidVSwitch.IllegalStatus	The operation is not allowed in the current VSwitch state. Expecting state includes "Created", but current state is "%s".	目前交換器狀態不支援該操作。
400	InvalidVSwitch.Ipv4NotEnabled	The specify VSwitch of ECS does not support IPv4.
400	InvalidOperation.CidrAllocateNotEnough	There is no enough cidr to allocate.	沒有足夠的 CIDR 可供分配。
400	TaskConflict	The operation is too frequent, please wait a moment and try again.	EIP 操作過於頻繁。
400	InvalidEniId.NotFound	The specified ENI ID does not exist.	無效的執行個體。
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.	內部錯誤，請重試。
500	InvalidParameter.PrivateIpCount	The current privateIpCount is not in the range 1.0 through 100.0.	目前 privateIpCount 不在 1.0 到 100.0 的範圍內。
403	InvalidUserType.NotSupported	%s	無效的使用者類型。
403	Abs.InvalidAccount.NotFound	%s	該帳號未找到或者 AccessKey 已過期。
403	MissingParameter	%s
403	Forbidden.NotSupportRAM	%s	暫不支援 RAM 使用者執行此操作。
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	指定的交換器內 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	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 首碼無效，不在交換器的預留地址段內。
403	InvalidOperation.TrunkingIsNotAllowed	The account is not authorized to use trunk ENI or perform trunking operation.	不允許操作中繼網卡。您需要確保您的帳號允許操作 Trunk 網卡。如有疑問，請提交工單。
403	InvalidOperation.InvalidEcsState	The status of current instances does not support this operation.	目前雲端服務狀態，不允許此操作。
404	InvalidEcsId.NotFound	%s	無效的執行個體。
404	InvalidEniId.NotFound	%s
404	InvalidVSwitchId.NotFound	%s	指定的虛擬交換器 ID 不存在。
404	InvalidSecurityGroupId.NotFound	%s	指定的安全性群組在該使用者帳號下不存在，請您檢查安全性群組 id 是否正確。
404	InvalidInstanceId.NotFound	%s
404	InvalidOperation.VSwitchCidrReservationNotExist	The specified VSwitch does not have CIDR reservation.	指定的交換器沒有可用的預留段。

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

變更歷史

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