為一塊彈性網卡分配一個或多個輔助私網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 錯誤碼發生變更 | 查看變更詳情 |