調用AddCommonBandwidthPackageIp接口添加EIP到共享帶寬中。
接口說明
在調用本接口時，請了解以下內容：
- 調用本接口添加 EIP 到共享帶寬中時，EIP 需滿足以下條件：
- EIP 的計費方式為按量付費。
- EIP 的地域與要加入的共享帶寬的地域相同。
- EIP 的線路類型與要加入的共享帶寬的線路類型一致。
- AddCommonBandwidthPackageIp 接口屬于異步接口，即系統會先返回一個請求 ID，但 EIP 并未成功添加到共享帶寬，系統后臺的添加任務仍在進行。您可以調用 DescribeCommonBandwidthPackages 查詢共享帶寬和 EIP 的關聯狀態。
-
當共享帶寬和 EIP 的關聯狀態處于 BINDING 時，表示共享帶寬與 EIP 關聯中，在該狀態下，您只能執行查詢操作，不能執行其他操作。
-
當共享帶寬和 EIP 的關聯狀態處于 BINDED 時，表示共享帶寬與 EIP 關聯完成。
-
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:AddCommonBandwidthPackageIp | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 共享帶寬所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| BandwidthPackageId | string | 是 | 共享帶寬的 ID。 | cbwp-2ze2ic1xd2qeqasdf**** |
| IpInstanceId | string | 是 | EIP 實例的 ID。 您可以通過調用 DescribeEipAddresses 接口查詢 EIP 實例的 ID。 | eip-2zeerraiwb7uqwed**** |
| IpType | string | 否 | IP 類型。取值：EIP，表示將 EIP 添加至共享帶寬。 | EIP |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "01FDDD49-C4B7-4D2A-A8E5-A93915C450A6"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | OperationDenied.SecurityProtectionTypesInconsistent | The operation is not allowed because of SecurityProtectionTypesInconsistent. | - |
| 400 | IpInstanceId.AlreadyInBandwidthPackage | The specified Eip InstanceId already in bandwidthPackage. | 共享帶寬包中已有此彈性公網IP實例。 |
| 400 | IpInstanceId.BizStatusInvalid | The specified Eip BizStatus is Disable, Cannot add to bandwidthPackage. | - |
| 400 | IpInstanceId.ChargeType.NotSupport | The specified Eip instance is PrePaid type, Cannot add to BandwidthPackage. | - |
| 400 | BandwidthPackageId.InvalidBizStatus | The specified BandwidthPackageId has been FinancialLocked, Cannot add Ip. | - |
| 400 | IpInstanceId.QuotaExceeded | The specified BandwidthPackageId has too many ip in it. exceed the quota , Cannot add more. | - |
| 400 | EipOperation.TooFrequently | The specified Eip add into bandwidthPackage too frequently. please add later. | - |
| 400 | TaskConflict | The operation is too frequent, TaskConflict. | 操作太頻繁，請稍后重試 |
| 400 | IncorrectStatus.Eip | Eip status error. | - |
| 400 | OperationUnsupported.IpType | Ip type does not support the operation. | - |
| 400 | ParamExclusive.IpInstanceIdAndBandwidthPackageId | %s | - |
| 400 | InvalidBandwidthPackage.NotExist | Eip bandwidth package not exist. | - |
| 400 | OperationFailed.DistibuteLock | Distibute lock fail. | 操作被其他請求加鎖； |
| 400 | OperationFailed.ZoneIdInconsistent | %s | - |
| 400 | AttrMismatching.BandwidthPackageIpVersion | %s | - |
| 400 | InvalidBandwidthPackageId.NotFound | The specified BandwidthPackageId not exist. | - |
| 400 | InvalidInstanceId.NotFound | The InstanceId is not found. | 實例InstanceId找不到。 |
| 400 | InvalidEIPStatus.BizDisabled | The EIP has been locked. | EIP實例被鎖定 |
| 400 | Forbidden.FinancialLocked | The ip business status is invalid. | 該實例已欠費鎖定，無法操作 |
| 400 | Mismatch.CloudBoxCbwpZoneAndEipZone | The CbwpZone and EipZone are mismatched. | 云盒共享帶寬和EIP的可用區不匹配 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
| 404 | InvalidBandwidthPackageId.NotFound | The specified bandwidthPackageId does not exist in our records. | 指定的帶寬包ID不存在。 |
| 404 | InvalidIpInstanceId.NotFound | The specified Eip InstanceId does not exist in our records. | 指定的eip實例不存在。 |
| 404 | IpInstanceId.InvalidIpInternetChargeType | The hybrid type eip not support add into bandwidthPackage of PayBytraffic type. | - |
| 404 | BandwidthPackageId.InvalidBandwidth | The hybrid type eip can not add into low bandwidth bandwidthPackage. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |