elastic IP アドレス (EIP) を Internet Shared Bandwidth インスタンスに関連付けます。
操作説明
この API を呼び出す前に、以下の点にご注意ください。
- この API を使用して Internet Shared Bandwidth インスタンスに追加する EIP は、以下の条件を満たしている必要があります。
EIP の課金方法が従量課金であること。
EIP のリージョンが、追加先の Internet Shared Bandwidth インスタンスのリージョンと同一であること。
EIP の回線タイプが、Internet Shared Bandwidth インスタンスの回線タイプと一致すること。
- AddCommonBandwidthPackageIp API は非同期です。この API を呼び出すと、システムはすぐに RequestId を返しますが、EIP はまだ Internet Shared Bandwidth インスタンスに正常に追加されていません。システムはバックグラウンドで追加タスクを処理し続けます。関連付け状態を確認するには、DescribeCommonBandwidthPackages API を呼び出してください。
-
関連付け状態が BINDING の場合、Internet Shared Bandwidth インスタンスと EIP の関連付けが進行中です。この状態では、クエリ操作のみ実行でき、他の操作は実行できません。
-
関連付け状態が BINDED の場合、Internet Shared Bandwidth インスタンスと EIP の関連付けが完了しています。
-
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
Internet Shared Bandwidth インスタンスのリージョン ID。 DescribeRegions API を呼び出して、リージョン ID を取得できます。 |
cn-hangzhou |
| BandwidthPackageId |
string |
必須 |
Internet Shared Bandwidth インスタンスの ID。 |
cbwp-2ze2ic1xd2qeqasdf**** |
| IpInstanceId |
string |
必須 |
EIP インスタンスの ID。 DescribeEipAddresses API を呼び出して、EIP インスタンスの ID をクエリできます。 |
eip-2zeerraiwb7uqwed**** |
| IpType |
string |
任意 |
IP タイプ。有効な値：EIP（EIP を Internet Shared Bandwidth インスタンスに追加することを示します）。 |
EIP |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークン。 異なるリクエスト間での一意性を保証するために、クライアント側でこのパラメーターに一意の値を生成してください。ClientToken は ASCII 文字のみをサポートします。 説明
このパラメーターを指定しない場合、システムは自動的に API リクエストの RequestId を ClientToken として使用します。RequestId は各 API リクエストごとに異なります。 |
0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| DryRun |
boolean |
任意 |
実際の操作を実行せずにドライランを実施します。 |
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
リクエストのリストを返します。 |
||
| RequestId |
string |
リクエスト ID。 |
01FDDD49-C4B7-4D2A-A8E5-A93915C450A6 |
例
成功レスポンス
JSONJSON
{
"RequestId": "01FDDD49-C4B7-4D2A-A8E5-A93915C450A6"
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | OperationDenied.SecurityProtectionTypesInconsistent | The operation is not allowed because of SecurityProtectionTypesInconsistent. | |
| 400 | IpInstanceId.AlreadyInBandwidthPackage | The specified Eip InstanceId already in bandwidthPackage. | |
| 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. | |
| 400 | InvalidEIPStatus.BizDisabled | The EIP has been locked. | |
| 400 | Forbidden.FinancialLocked | The ip business status is invalid. | |
| 400 | Mismatch.CloudBoxCbwpZoneAndEipZone | The CbwpZone and EipZone are mismatched. | |
| 400 | MissingParam.BandwidthPackageId | The parameter bandwidthPackageId is mandatory. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。