為一塊彈性網(wǎng)卡分配一個或多個輔助私網(wǎng)IP地址?？梢詾榫W(wǎng)卡指定在所屬交換機（vSwitch）的空閑私網(wǎng)IP地址，或者通過指定私網(wǎng)地址數(shù)量自動分配私網(wǎng)IP地址。
接口說明
- 只支持可用（Available）或者已附加（InUse）狀態(tài)下的彈性網(wǎng)卡。
- 操作主網(wǎng)卡時，網(wǎng)卡附加的實例必須處于運行中（Running）或者已停止（Stopped）狀態(tài)。
- 網(wǎng)卡處于可用（Available）狀態(tài)時，最多可以分配 49 個輔助私網(wǎng) IP 地址。一旦掛載到實例上，網(wǎng)卡能分配的輔助私網(wǎng) IP 地址數(shù)將受到實例規(guī)格限制。更多詳情，請參見實例規(guī)格族。
- 成功調(diào)用該接口后，您可以從返回結(jié)果中獲取已分配的輔助私網(wǎng) IP 地址信息。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:AssignPrivateIpAddresses | create | *NetworkInterface acs:ecs:{#regionId}:{#accountId}:eni/{#eniId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 彈性網(wǎng)卡所屬的地域。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| NetworkInterfaceId | string | 是 | 彈性網(wǎng)卡 ID。 | eni-bp67acfmxazb4p**** |
| SecondaryPrivateIpAddressCount | integer | 否 | 指定私網(wǎng) IP 地址數(shù)量，自動從交換機的空閑 IP 地址中分配 IP 地址。 分配輔助私網(wǎng) IP 地址時，您不能同時指定 | 1 |
| ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符，且不能超過 64 個字符。更多信息，請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
| PrivateIpAddress | array | 否 | 從彈性網(wǎng)卡所屬交換機的空閑 IP 地址中選擇一個或多個輔助私網(wǎng) IP 地址。N 的取值范圍：
分配輔助私網(wǎng) IP 地址時，您不能同時指定 | |
| string | 否 | 從彈性網(wǎng)卡所屬交換機的空閑 IP 地址中選擇一個或多個輔助私網(wǎng) IP 地址。N 的取值范圍：
說明
分配輔助私網(wǎng) IP 地址時，您不能同時指定 PrivateIpAddress.N和SecondaryPrivateIpAddressCount。
| 10.1.**.** | |
| Ipv4Prefix | array | 否 | 為彈性網(wǎng)卡指定一個或多個 IPv4 前綴。N 的取值范圍：1~10。 說明
如果您需要為彈性網(wǎng)卡設(shè)置 IPv4 前綴，則必須設(shè)置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一個，但不能同時設(shè)置這兩個參數(shù)。
| |
| string | 否 | 為彈性網(wǎng)卡指定一個或多個 IPv4 前綴。N 的取值范圍：1~10。 說明
如果您需要為彈性網(wǎng)卡設(shè)置 IPv4 前綴，則必須設(shè)置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一個，但不能同時設(shè)置這兩個參數(shù)。
| 192.168.**.**/28 | |
| Ipv4PrefixCount | integer | 否 | 為彈性網(wǎng)卡指定隨機生成的 IPv4 前綴數(shù)量。取值范圍：1~10。 說明
如果您需要為彈性網(wǎng)卡設(shè)置 IPv4 前綴，則必須設(shè)置 Ipv4Prefix.N 或者 Ipv4PrefixCount 的其中一個，但不能同時設(shè)置這兩個參數(shù)。
| 1 |
返回參數(shù)
示例
正常返回示例
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 | 不支持參數(shù)。 |
| 400 | InvalidParameter | %s | 無效的參數(shù)。 |
| 400 | InvalidInstanceID.Malformed | %s | 參數(shù) InstanceId 格式錯誤。 |
| 400 | InvalidOperation.InvalidEcsState | %s | 實例當前的狀態(tài)不支持此操作。 |
| 400 | InvalidOperation.InvalidEniState | %s | 彈性網(wǎng)卡當前的狀態(tài)不支持此操作。 |
| 400 | InvalidOperation.DetachPrimaryEniNotAllowed | %s | 不允許分離實例的主網(wǎng)卡。 |
| 400 | MissingParameter | %s | 缺失參數(shù)，請檢查參數(shù)是否完整。 |
| 400 | Forbidden.RegionId | %s | 當前地域暫時沒有提供該服務(wù)。 |
| 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. | 當前狀態(tài)下的網(wǎng)卡不可操作。 |
| 400 | InvalidParameter.Conflict | %s | 您輸入的參數(shù)無效，請檢查參數(shù)之間是否沖突。%s為變量，將根據(jù)調(diào)用API的實際情況動態(tài)返回錯誤信息。 |
| 400 | InvalidOperation.InstanceNotSupportMulitipleIp | Assigning private ip for instance in cloud box is unsupported. | 云盒環(huán)境不支持給實例分配多ip。 |
| 400 | IncorrectVSwitchStatus | The operation is not allowed in the current VSwitch state. Expecting state includes "Created Available", but current state is "%s". | vSwitch當前狀態(tài)不支持該操作。 |
| 400 | InvalidPrivateIpAddress.Duplicated | The specified private IP address "%s" is duplicated. | 指定的IP地址已經(jīng)被使用。 |
| 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. | 網(wǎng)卡所掛載的實例正在遷移中，請稍后重試。 |
| 400 | InvalidEniId.Malformed | The specified parameter "NetworkInterfaceId" is not valid. Ensure you provide the full ENI id in the form eni-xxx. | 網(wǎng)卡Id輸入不符合規(guī)范 |
| 403 | InvalidUserType.NotSupported | %s | 您當前的賬號不支持此操作。 |
| 403 | Abs.InvalidAccount.NotFound | %s | 您的阿里云賬號不存在，或者您的 AccessKey 已經(jīng)過期。 |
| 403 | Forbidden.NotSupportRAM | %s | 暫不支持RAM用戶執(zhí)行該操作。 |
| 403 | Forbidden.SubUser | %s | 您的賬號沒有操作此資源的權(quán)限，請向主賬號申請相關(guān)的權(quán)限。 |
| 403 | MaxEniCountExceeded | %s | 已超過可以操作的最大彈性網(wǎng)卡數(shù)。 |
| 403 | EniPerInstanceLimitExceeded | %s | 實例附加的彈性網(wǎng)卡數(shù)量已經(jīng)達到了最大限度，不能再為實例附加彈性網(wǎng)卡。 |
| 403 | InvalidOperation.AvailabilityZoneMismatch | %s | 該操作無效。 |
| 403 | InvalidOperation.VpcMismatch | %s | 您的操作無效，請確認該操作中的 VPC 與其它參數(shù)是否匹配。 |
| 403 | SecurityGroupInstanceLimitExceed | %s | 該安全組內(nèi)已有的實例數(shù)量已達到最大限制。 |
| 403 | InvalidSecurityGroupId.NotVpc | %s | 參數(shù) SecurityGroupId 無效，該安全組的網(wǎng)絡(luò)類型不是專有網(wǎng)絡(luò)。 |
| 403 | InvalidOperation.InvalidEniType | %s | 當前彈性網(wǎng)卡的類型不支持此操作。 |
| 403 | InvalidVSwitchId.IpNotEnough | %s | 指定的交換機內(nèi) IP 數(shù)量不足。 |
| 403 | InvalidVSwitchId.IpInvalid | %s | 指定的私網(wǎng) IP 無效。 |
| 403 | InvalidIp.IpAssigned | %s | 指定的 IP 已被分配。 |
| 403 | MaxEniPrivateIpsCountExceeded | %s | 指定的ENI分配的輔助私網(wǎng)IP數(shù)量超過限制，具體信息請參見錯誤信息%s占位符的實際返回結(jié)果。 |
| 403 | Operation.Conflict | %s | 您當前的操作與其它正在執(zhí)行的操作有沖突，請稍后重試。 |
| 403 | InvalidOperation.Ipv4CountExceeded | %s | IPv4 數(shù)量達到上限，導(dǎo)致該操作無效。 |
| 403 | InvalidOperation.EniServiceManaged | %s | 操作無效。 |
| 403 | InvalidIp.IpRepeated | %s | 指定的 IP 重復(fù)。 |
| 403 | InvalidIp.IpPrefixIllegal | The ip prefixes %s is/are illegal. | IP前綴無效，不是cidr格式。 |
| 403 | MissingParameter | These parameters %s cannot all be empty. | 這些參數(shù)不能都為空 |
| 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. | 指定的交換機內(nèi) IP前綴數(shù)量不足。 |
| 403 | InvalidIp.IpPrefixMaskInvalid | The IP prefixes mask "%s" is illegal.Ensure the mask is between %s and %s. | IP前綴掩碼非法，不在有效范圍內(nèi)。 |
| 403 | InvalidIp.IpPrefixMustInReserveSegment | The IP prefix must be in VSwitch reserved segment. Ensure you create reserved segment for the VSwitch. | IP前綴無效，不在交換機的預(yù)留地址段內(nèi)。 |
| 404 | InvalidEcsId.NotFound | %s | 指定的實例 ID 不存在。 |
| 404 | InvalidEniId.NotFound | %s | 指定的彈性網(wǎng)卡 ID 不存在。 |
| 404 | InvalidVSwitchId.NotFound | %s | 指定的交換機不存在。 |
| 404 | InvalidSecurityGroupId.NotFound | %s | 指定的安全組 ID 不存在。 |
| 404 | InvalidInstanceId.NotFound | %s | 指定的實例不存在，請確認參數(shù) InstanceId 是否正確。 |
| 404 | InvalidOperation.VSwitchCidrReservationNotExist | The specified VSwitch does not have CIDR reservation. | 指定的交換機沒有可用的預(yù)留段。 |
| 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. | 內(nèi)部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-08-20 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-08-17 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-04-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |