呼叫AddCommonBandwidthPackageIp介面新增EIP到共享頻寬中。
介面說明
在呼叫本介面時,請瞭解以下內容:
- 呼叫本介面新增 EIP 到共享頻寬中時,EIP 需滿足以下條件:
EIP 的計費方式為按量付費。
EIP 的地域與要加入的共享頻寬的地域相同。
EIP 的線路類型與要加入的共享頻寬的線路類型一致。
- AddCommonBandwidthPackageIp 介面屬於非同步介面,即系統會先傳回一個請求 ID,但 EIP 並未成功新增到共享頻寬,系統背景的添加任務仍在進行。您可以呼叫 DescribeCommonBandwidthPackages 查詢共享頻寬和 EIP 的關聯狀態。
-
當共享頻寬和 EIP 的關聯狀態處於 BINDING 時,表示共享頻寬與 EIP 關聯中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
-
當共享頻寬和 EIP 的關聯狀態處於 BINDED 時,表示共享頻寬與 EIP 關聯完成。
-
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vpc:AddCommonBandwidthPackageIp |
create |
*BandwidthPackage
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
| DryRun |
boolean |
否 |
參數預檢,不實際執行。 |
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
傳回請求清單。 |
||
| RequestId |
string |
請求 ID。 |
01FDDD49-C4B7-4D2A-A8E5-A93915C450A6 |
樣本
正常返回樣本
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. | EIP 操作太頻繁。 |
| 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. | 該執行個體在該地域內不存在。 |
| 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. | CloudBox 共用頻寬和 EIP 的可用區不相符。 |
| 400 | MissingParam.BandwidthPackageId | The parameter bandwidthPackageId is mandatory. | 參數 bandwidthPackageId 為必填項。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | |
| 404 | InvalidBandwidthPackageId.NotFound | The specified bandwidthPackageId does not exist in our records. | |
| 404 | InvalidIpInstanceId.NotFound | The specified Eip InstanceId does not exist in our records. | |
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。