申請彈性公網(wǎng)IP（Elastic IP Address，簡稱EIP）。
接口說明
請確保在使用本接口前，您已充分了解 EIP 的收費方式和價格。更多信息，請參見計費概述。
調(diào)用本接口后將在指定的地域內(nèi)隨機獲取一個狀態(tài)為 Available 的彈性公網(wǎng) IP。彈性公網(wǎng) IP 在傳輸層目前只支持解析 ICMP、TCP 和 UDP 協(xié)議內(nèi)容，不支持解析 IGMP 和 SCTP 等協(xié)議內(nèi)容。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| vpc:AllocateEipAddress | create | *Address acs:vpc:{#regionId}:{#accountId}:eip/* |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 彈性公網(wǎng) IP 所在的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 枚舉值：
| cn-hangzhou |
| Bandwidth | string | 否 | EIP 的帶寬峰值。單位：Mbps。
默認值：5 Mbps。 | 5 |
| Period | integer | 否 | 購買時長。 當 PricingCycle 取值 Month 時，Period 取值范圍為 1~9。 當 PricingCycle 取值 Year 時，Period 取值范圍為 1~5。 當 InstanceChargeType 參數(shù)的值為 PrePaid 時，該參數(shù)必選，當 InstanceChargeType 參數(shù)的值為 PostPaid 時，該參數(shù)不填。 | 1 |
| ISP | string | 否 | 線路類型。取值：
關于 BGP（多線）線路和 BGP（多線）_精品線路的更多信息，請參見 EIP 線路類型。
| BGP |
| ActivityId | long | 否 | 特殊活動 ID，無需配置此參數(shù)。 | 123456 |
| Netmode | string | 否 | 網(wǎng)絡類型，僅取值為 public（默認值），表示公網(wǎng)。 | public |
| AutoPay | boolean | 否 | 是否自動付費，取值：
當 InstanceChargeType 參數(shù)的值為 PrePaid 時，該參數(shù)必選；當 InstanceChargeType 參數(shù)的值為 PostPaid 時，該參數(shù)可不填。 | false |
| PricingCycle | string | 否 | 包年包月的計費周期，取值：
當 InstanceChargeType 參數(shù)的值為 PrePaid 時，該參數(shù)必選；當 InstanceChargeType 參數(shù)的值為 PostPaid 時，該參數(shù)可不填。 | Month |
| InstanceChargeType | string | 否 | EIP 的計費方式，取值：
當 InstanceChargeType 取值為 PrePaid 時，InternetChargeType 必須取值 PayByBandwidth；當 InstanceChargeType 取值為 PostPaid 時，InternetChargeType 可取值 PayByBandwidth 或 PayByTraffic。 | PostPaid |
| InternetChargeType | string | 否 | EIP 的計量方式，取值：
當 InstanceChargeType 取值為 PrePaid 時，InternetChargeType 必須取值 PayByBandwidth。 當 InstanceChargeType 取值為 PostPaid 時，InternetChargeType 可取值 PayByBandwidth 或 PayByTraffic。 | PayByTraffic |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmxazffggds**** |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| Name | string | 否 | EIP 實例的名稱。 長度為 0-128 個字符，不能以 說明
創(chuàng)建預付費的 EIP 實例時，不支持設置該參數(shù)。
| EIP1 |
| Description | string | 否 | EIP 實例的描述。 長度為 0-256 個字符，不能以 說明
創(chuàng)建預付費的 EIP 實例時，不支持設置該參數(shù)。
| test |
| SecurityProtectionTypes | array | 否 | 安全防護級別。
您最多可以設置 10 個安全防護級別。 | |
| string | 否 | 安全防護級別。
您最多可以設置 10 個安全防護級別。 | AntiDDoS_Enhanced | |
| PublicIpAddressPoolId | string | 否 | pippool-2vc0kxcedhquybdsz**** | |
| Zone | string | 否 | EIP 的可用區(qū)。 當 PublicIpAddressPoolId 中指定的 IP 地址池為云盒業(yè)務類型時，該參數(shù)默認與 IP 地址池的可用區(qū)一致。 如何查看 IP 地址池業(yè)務類型，請參見 ListPublicIpAddressPools | ap-southeast-1-lzdvn-cb |
| IpAddress | string | 否 | 要指定申請的 EIP 的 IP 地址。 IpAddress 和 InstanceId 參數(shù)僅需傳入一個，如果都不傳，系統(tǒng)會隨機申請 EIP。 | 192.0.XX.XX |
| InstanceId | string | 否 | 要指定申請的 EIP 的實例 ID。 IpAddress 和 InstanceId 參數(shù)僅需傳入一個，如果都不傳，系統(tǒng)會隨機申請 EIP。 | eip-25877c70gddh**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"OrderId": 10,
"ResourceGroupId": "rg-acfmxazfdgdg****",
"EipAddress": "192.0.XX.XX",
"AllocationId": "eip-25877c70gddh****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | COMMODITY_NO_EXIST | commodity is not exist | - |
| 400 | QuotaExceeded.Eip | Elastic IP address quota exceeded | - |
| 400 | InvalidParameter | Specified value of "InternetChargeType" is not valid | - |
| 400 | InvalidParameter | Specified value of "Bandwidth" is not valid. | 該帶寬不合法。 |
| 400 | InsufficientBalance | Your account does not have enough balance. | 賬戶余額不足，請先充值再操作。 |
| 400 | QuotaExceeded.Eip | Elastic IP address quota exceeded. | 彈性公網(wǎng)IP的個數(shù)超過額度限制，如果您有更多額度的需求，建議您考慮使用NAT網(wǎng)關。 |
| 400 | ReserveIpFail | Reserve eip failed. | EIP預留失敗。 |
| 400 | InvalidRegion.NotSupport | The specified region does not support. | 該 RegionId 不支持此操作。 |
| 400 | InvalidBandwidth.Malformed | The specified Bandwidth is invalid. | - |
| 400 | INSTANCE_TYPE_NOT_SUPPORT | The instance type is invalid. | - |
| 400 | QueryParameter.Illegal | query parameter illegal | - |
| 400 | TokenVerfiy.Failed | token verify failed. | - |
| 400 | OrderFailed | The Account failed to create order. | - |
| 400 | QuotaExceeded.LargeSpecEip | Elastic IP address with large spec quota exceeded. | - |
| 400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 資源組ID不存在。 |
| 400 | PAYFOR.CREDIT_PAY_INSUFFICIENT_BALANCE | Your account does not have enough balance. | - |
| 400 | SYSTEM.SALE_VALIDATE_UNEXPECTED_ERROR | You have arrears and do not meet the purchase conditions. | - |
| 400 | Trade_Sync_Create_Sub_ERROR | SyncOrderToSub error. | - |
| 400 | InvalidComponent.EipBandwidthMax | The eip_bandwidth_max component is invalid. | - |
| 400 | OperationFailed.RiskControl | Risk control check failed. | 我們檢測到您的付款方式存在安全風險。請通過電子郵件或控制臺消息中的鏈接繼續(xù)驗證，并在驗證后重新提交訂單。 |
| 400 | OperationFailed.SaleValidate | Validate sale condition with subArticle failed. | 使用子項目驗證銷售條件失敗。 |
| 400 | IllegalParam.OrderParamComponent | Product order param has invalid component. | - |
| 400 | OperationFailed.SaleExpression | Get the sales expression exception attached to the item. | - |
| 400 | OperationFailed.CompleteUserInfo | Complete user info failed. | - |
| 400 | OperationFailed.QueryPrice | Query price failed when create order. | 創(chuàng)建訂單時查詢價格失敗。 |
| 400 | OperationFailed.InsufficientEIP | Eip resource is not enough. | - |
| 400 | OperationFailed.InvokeInnerApi | Failed to invoke inner api. | - |
| 400 | OperationFailed.AccountMoneyInvalid | Account money is invalid. | - |
| 400 | OperationFailed.QueryCredtiInfo | Failed to query credit info. | - |
| 400 | FrequentPurchase.EIP | eip frequent purchase | - |
| 400 | OperationFailed.QueryUserLabel | Failed to query user label info. | - |
| 400 | PAY.INSUFFICIENT_BALANCE | Your account does not have enough balance. | 賬號余額不足 |
| 400 | PAY.MAYI_WITHHOLDING_AGREEMENT_ILLEGAL | User withhoding argeement is illegal. | - |
| 400 | OrderError.EIP | FThe Account failed to create order. | - |
| 400 | IellgalParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 指定參數(shù) OwnerAccount 不合法 |
| 400 | OrderError.EIP | The Account failed to create order. | 下單失敗 |
| 400 | ResourceNotFound.PublicIpAddressPool | The specified resource of PublicIpAddressPool is not found. | - |
| 400 | ResourceNotEnough.PublicIpAddressPool | The specified resource of PublicIpAddressPool is not enough. | - |
| 400 | Mismatch.IpAndPublicIpAddressPool | The Ip and PublicIpAddressPool are mismatched. | - |
| 400 | CreditPayInsufficientBalance | The balance is insufficient, please contact your channel partner to increase the balance | 額度不足,請聯(lián)系您的渠道合作伙伴提升額度。 |
| 400 | OperationDenied.NotOpenDdosOriginProtectService | The operation is not allowed because of you do not open Ddos Origin Protection Service | 無法創(chuàng)建DDoS防護（增強版）Eip，因為沒有購買DDoS原生防護服務 |
| 400 | IncorrectStatus.PublicIpAddressPool | The status of PublicIpAddressPool is incorrect. | 地址池實例未處于穩(wěn)態(tài)，不允許分配EIP。 |
| 400 | IncorrectStatus.PublicIpAddressPool | The status of %s [%s] is incorrect. | 無法分配EIP，因為IP地址池狀態(tài)不對 |
| 400 | IllegalParam.Isp | The param of %s is illegal. | 無法分配EIP，因為ISP參數(shù)非法 |
| 400 | AccountMoneyValidateError | The available amount of the account is insufficient. | 賬號可用金額不足 |
| 400 | OrderFailed.ConcurrentOperate | Failed to create the order due to concurrent operations. | 創(chuàng)建訂單失敗，因為并發(fā)操作。 |
| 400 | OperationFailed.BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 您的基本信息尚未完成，請先完成信息填寫。 |
| 400 | OperationFailed.QuotaNotEnough | Your quota is insufficient. Please contact your channel partner to increase your quota | 您當前quota配額不足，請您可以聯(lián)系渠道伙伴為您增加額度 |
| 400 | ExclusiveParam.ZoneAndPublicIpAddressPoolId | The Zone and PublicIpAddressPoolId parameters are mutually exclusive. | 不允許同時傳入?yún)?shù)Zone和PublicIpAddressPoolId |
| 400 | IllegalParam.Zone | The specified zone is invalid. | 參數(shù)Zone非法 |
| 400 | OperationFailed.AllocateUnfamiliarIp | The operation failed because only IP addresses used within the last seven days can be allocated. | 指定EIP申請只允許申請7天內(nèi)使用過的IP |
| 400 | Ip.Allocated | The reserve ip has been allocated. | 已分配保留ip。 |
| 400 | IncorrectStatus.Ip | The status of ip is incorrect. | IP的狀態(tài)不正確。 |
| 400 | UnsupportedFeature.AllocateEipAddressWithZone | The feature of AllocateEipAddressWithZone is not supported. | 當前地域不支持指定Zone創(chuàng)建實例 |
| 400 | ResourceNotFound.Ip | The specified ip is not found. | 找不到指定的IP。 |
| 400 | OperationFailed.CreditPayInsufficientBalance | Your account does not have enough balance. | 您的賬戶可用額度小于0，請先充值后再嘗試購買。 |
| 400 | OperationFailed.ResourceNotEnough | The resources you have applied for are insufficient. | 您申請的資源不足，如仍需申請，請?zhí)峁翁幚?/span> |
| 400 | IllegalParam.Bandwidth | The param of bandwidth is illegal. | Bandwidth參數(shù)非法 |
| 400 | OperationFailed.IpIsLocked | The operation is failed because of ip is locked. | 申請失敗，IP已經(jīng)被鎖定 |
| 400 | Mismatch.EipSecurityProtectionTypeAndPoolSecurityProtectionType | The EipSecurityProtectionType and PoolSecurityProtectionType are mismatched. | EIP安全防護類型與地址池安全防護類型不匹配。 |
| 400 | IllegalParam.SecurityProtectionTypes | The param of securityProtectionTypes is illegal. | 傳入的SecurityProtectionTypes參數(shù)非法 |
| 400 | IllegalParam.ServiceLocation | The param of serviceLocation is illegal. | ServiceLocation參數(shù)非法。 |
| 400 | UnsupportedFeature.Isp | The feature of Isp is not supported. | 您指定的Isp暫未支持 |
| 400 | ExclusiveParam.ZoneAndIpAddress | The specified param Zone and IpAddress or InstanceId are mutually exclusive. | 指定的入?yún)one和IpAddress或InstanceId存在沖突 |
| 400 | InvalidDescription.Malformed | The Description is illeagl. | 指定的資源描述格式不合法。長度為2～256個字符，不能以http://和https://開頭。 |
| 400 | InvalidName.Malformed | The attribute name is illegal. | 該名稱格式不合法。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有權限操作指定資源，請申請權限后再操作。 |
| 404 | InvalidRegionId.NotFound | Specified value of "RegionId" is not supported. | 指定的 RegionId 不存在，請您檢查此產(chǎn)品在該地域是否可用。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 指定的RegionId不存在。請檢查該參數(shù)是否正確。 |
| 404 | FUWU_BIZ_COMMODITY_VERIFY_FAIL | ????????, ????????PD. | - |
| 409 | OperationConflict | Request was denied due to conflict with a previous request. | 請求沖突，請稍后重試。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內(nèi)部錯誤 |
| 500 | OperationFailed.SystemBusy | Operation failed because system is busy. | 系統(tǒng)繁忙，請稍后重試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-07-16 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-05-17 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-03-14 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-03-14 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-02-02 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-01-22 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-12-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-08-29 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-07-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-07-24 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-07-08 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-07-06 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-06-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-06-19 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-04-20 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-03-09 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-12-02 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |