連續EIP是一組按序排列的彈性公網IP地址,您可以在進行網絡設計時,為需要連續公網IP地址的云資源批量申請和使用這些IP地址。您可以通過調用AllocateEipSegmentAddress接口申請連續EIP。
接口說明
AllocateEipSegmentAddress 接口屬于異步接口,即系統會先返回一個連續 EIP 組的實例 ID,但該連續 EIP 組并未創建完成,系統后臺的創建任務仍在進行。您可以調用 DescribeEipSegment 查詢連續 EIP 組的狀態。
-
當連續 EIP 組處于 Allocating 狀態時,表示連續 EIP 組分配中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
-
當連續 EIP 組處于 Allocated 狀態時,表示連續 EIP 組已分配完成。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:AllocateEipSegmentAddress | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
Bandwidth | string | 否 | EIP 的帶寬峰值。單位:Mbps。
默認值為 5 Mbps。 | 5 |
RegionId | string | 是 | 連續 EIP 所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
EipMask | string | 是 | 連續 EIP 的掩碼,取值:
說明
由于 IP 地址保留,實際申請到的連續 EIP 可能缺少 1、3 或者 4 個 EIP。
| 28 |
Netmode | string | 否 | 網絡類型,僅取值:public,表示公網。 | public |
InternetChargeType | string | 否 | 連續 EIP 的計費方式,取值:
| PayByBandwidth |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-bp67acfmxazb4ph**** |
Isp | string | 否 | 線路類型。取值:
關于 BGP(多線)線路和 BGP(多線)_精品線路的更多信息,請參見 EIP 線路類型。 如果您是單線帶寬的白名單用戶,您還可以選擇以下類型:
如果您是杭州金融云用戶,該字段必填,取值:BGP_FinanceCloud。 | BGP |
Zone | string | 否 | 連續 EIP 組的可用區。 | cn-hangzhou-a |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "F7A6301A-64BA-41EC-8284-8F4838C15D1F",
"EipSegmentInstanceId": "eipsg-2zett8ba055tbsxme****"
}
錯誤碼
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. | 彈性公網IP的個數超過額度限制,如果您有更多額度的需求,建議您考慮使用NAT網關。 |
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. | 我們檢測到您的付款方式存在安全風險。請通過電子郵件或控制臺消息中的鏈接繼續驗證,并在驗證后重新提交訂單。 |
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. | 創建訂單時查詢價格失敗。 |
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 | ORDER.QUANTITY_INVALID | User quota has exceeded the limit. | 您當前保有的EIP數量已達上限,可前往配額管理提升EIP數量配額 |
400 | PAY.MAYI_WITHHOLDING_AGREEMENT_ILLEGAL | User withhoding argeement is illegal. | - |
400 | OperationFailed.ChargeTypeInvalid | Operation failed because hybrid netmode do not support PayByTraffic. | - |
400 | IllegalParam.EipMask | EipMask is illegal. | - |
400 | IllegalParam.Name | Name is illegal. | - |
400 | IllegalParam.Description | Description is illegal. | - |
400 | InstanceExist.EipSegment | The eipSegment instance already exists. | - |
400 | OperationFailed.QuotaExceed | Operation failed because over threshold bandwidth quota exceed. | - |
400 | OperationFailed.FrequentPurchase | Operation failed because eip frequent purchase. | - |
400 | OperationFailed.AllocateEipSegment | Operation failed because eip segment is out of stock. | 連續EIP庫存不足。 |
400 | OperationFailed.CreateOrderFailed | Operation failed because create order failed. | - |
400 | MissingParam.Bandwidth | The parameter Bandwidth is mandatory when allocate hybrid EipSegment. | - |
400 | OperationFailed.EipQuotaExceed | Operation failed because eip quota exceed. | - |
400 | OrderError.EIP | The Account failed to create order. | 下單失敗 |
400 | OperationConflict | Request was denied due to conflict with a previous request. | 請求沖突,請稍后重試。 |
400 | Forbidden | User not authorized to operate on the specified resource. | 您沒有權限操作指定資源,請申請權限后再操作。 |
400 | UnsupportedFeature.AllocateEipAddressWithZone | The feature of AllocateEipAddressWithZone is not supported. | 當前地域不支持指定Zone創建實例 |
400 | IllegalParam.Zone | The specified zone is invalid. | 參數Zone非法 |
400 | Forbidden.AllocateEipSegmentAddress | Authentication is failed for allocating eip segment address. | 申請連續EIP失敗,該服務已下線,請使用IP地址池服務。 |
404 | InvalidRegionId.NotFound | Specified value of "RegionId" is not supported. | 指定的 RegionId 不存在,請您檢查此產品在該地域是否可用。 |
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 指定的RegionId不存在。請檢查該參數是否正確。 |
404 | FUWU_BIZ_COMMODITY_VERIFY_FAIL | ????????, ????????PD. | - |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-16 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-07-26 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-05-22 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-17 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |