Associates multiple elastic IP addresses (EIPs) with an Internet Shared Bandwidth instance.
Operation description
- 调用本接口批量添加 EIP 到共享带宽中时，EIP 需满足以下条件：
-
EIP 的计费方式为按量付费。
-
EIP 的地域与要加入的共享带宽的地域相同。
-
EIP 的线路类型与要加入的共享带宽的线路类型一致。
-
- AddCommonBandwidthPackageIps 接口属于异步接口，即系统会先返回一个请求 ID，但 EIP 并未成功添加到共享带宽，系统后台的添加任务仍在进行。您可以调用 DescribeCommonBandwidthPackages 查询共享带宽和 EIP 的关联状态。
-
当共享带宽和 EIP 的关联状态处于 BINDING 时，表示共享带宽与 EIP 关联中，在该状态下，您只能执行查询操作，不能执行其他操作。
-
当共享带宽和 EIP 的关联状态处于 BINDED 时，表示共享带宽与 EIP 关联完成。
-
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the Internet Shared Bandwidth instance. You can call the DescribeRegions operation to query the most recent list of regions. |
cn-shanghai |
| BandwidthPackageId |
string |
Yes |
The ID of the Internet Shared Bandwidth instance. |
cbwp-2ze2ic1xd2qeqasdf**** |
| IpType |
string |
No |
The IP type. Set the value to EIP to add an EIP to the Internet Shared Bandwidth instance. |
EIP |
| ClientToken |
string |
No |
A client token used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request. |
123e4567-e89b-12d3-a456-426655440000 |
| IpInstanceIds |
array |
Yes |
The list of EIPs that you want to associate with the Internet Shared Bandwidth instance. You can specify at most 10 EIP IDs at a time. |
|
|
string |
No |
The list of EIPs that you want to associate with the Internet Shared Bandwidth instance. You can specify at most 10 EIP IDs at a time. |
eip-2zeerraiwb7uqwed**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
01FDDD49-C4B7-4D2A-A8E5-A93915C450A6 |
Examples
Success response
JSON format
{
"RequestId": "01FDDD49-C4B7-4D2A-A8E5-A93915C450A6"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | OperationDenied.SecurityProtectionTypesInconsistent | The operation is not allowed because of SecurityProtectionTypesInconsistent. | |
| 400 | InvalidIpInstanceId.NotFound | The specified Eip InstanceId does not exist in our records. | The specified EIP does not exist. |
| 400 | EIP_ALREADY_IN_BANDWIDTHPACKAGE | The Eip already in bandwidthPackage. | |
| 400 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | The specified region ID does not exist. |
| 400 | InvalidBandwidthPackageId.NotFound | The specified bandwidthPackageId does not exist in our records. | The ID of the specified EIP bandwidth plan does not exist. |
| 400 | IpInstanceId.AlreadyInBandwidthPackage | The specified Eip InstanceId already in bandwidthPackage. | 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 | IpInstanceId.InvalidIpInternetChargeType | The hybrid type eip not support add into bandwidthPackage of PayBytraffic type. | |
| 400 | TaskConflict | The operation is too frequent, TaskConflict. | The system is unavailable. Try again later. |
| 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. | The operation is locked by another request; |
| 400 | BandwidthPackageId.InvalidBandwidth | The hybrid type eip can not add into low bandwidth bandwidthPackage. | |
| 400 | OperationFailed.ZoneIdInconsistent | %s | |
| 400 | AttrMismatching.BandwidthPackageIpVersion | %s | |
| 400 | InvalidEIPStatus.BizDisabled | The EIP has been locked. | The EIP is locked. |
| 400 | Forbidden.FinancialLocked | The ip business status is invalid. | The instance has overdue payments. |
| 400 | Mismatch.CloudBoxCbwpZoneAndEipZone | The CbwpZone and EipZone are mismatched. | The EIP bandwidth plan of the cloud box does not match the zone of the EIP. |
| 400 | InvalidInstanceId.NotFound | The InstanceId is not found. | The InstanceId is not found. |
| 400 | MissingParam.BandwidthPackageId | The parameter bandwidthPackageId is mandatory. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.