為一張彈性網卡分配一個或多個輔助私有 IP 地址。您可以為網卡指定其所屬交換器(vSwitch)中的閒置私有 IP 地址,或透過指定私有 IP 地址數量來自動分配私有 IP 地址。
介面說明
介面說明
僅支援可用(Available)或已附加(InUse)狀態下的彈性網卡。
操作主要網卡時,網卡所附加的執行個體必須處於執行中(Running)或已停止(Stopped)狀態。
當網卡處於可用(Available)狀態時,最多可分配 49 個輔助私有 IP 地址。一旦掛載至執行個體上,網卡可分配的輔助私有 IP 地址數量將受到執行個體規格限制。更多詳情,請參閱執行個體規格族。
成功呼叫此介面後,您可以從傳回結果中取得已分配的輔助私有 IP 地址資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:AssignPrivateIpAddresses |
create |
*NetworkInterface
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 地址時,您不能同時指定 |
10.1.**.** |
|
string |
否 |
從彈性網卡所屬交換器的閒置 IP 地址中選擇一個或多個輔助私有 IP 地址。N 的取值範圍:
說明
分配輔助私有 IP 地址時,您不能同時指定 |
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. | 請求限流,請使用 nextToken 的分頁方式替代 PageNumber 的分頁方式進行查詢。 |
| 400 | InvalidOperation.Unsupported | %s | |
| 400 | UnsupportedParameter | %s | 指定參數不支援。 |
| 400 | InvalidParameter | %s | 指定的參數組合不符合要求。 |
| 400 | InvalidInstanceID.Malformed | %s | |
| 400 | InvalidOperation.InvalidEcsState | %s | 當前執行個體的狀態不支援該操作。 |
| 400 | InvalidOperation.InvalidEniState | %s | 當前 ENI 的狀態不允許修改該網卡屬性。 |
| 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 | 目前操作不允許同時設定 diskId 和 imageId,請確保 diskId 或 imageId 其中一個不為空。 |
| 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". | vSwitch 目前狀態不支援該操作。 |
| 400 | QuotaExceeded.PrivateIpAddress | There are not enough private IPs in the specified VSwitch. | 指定的交換器 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. | |
| 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 | 彈性網卡和 ECS 執行個體的交換器不在同一個可用區內。 |
| 403 | InvalidOperation.VpcMismatch | %s | 該彈性網卡的 VPC 和安全性群組的 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 | 當前 ECS 綁定的彈性網卡上的 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 網卡。如有疑問,請提交工單。 |
| 404 | InvalidEcsId.NotFound | %s | 指定的執行個體 ID 不存在。 |
| 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. | 指定的交換器沒有可用的預留段。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。