AddCommonBandwidthPackageIp - 添加EIP到共享带宽中 - 共享带宽

调用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

*BandwidthPackage

acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}

无

请求参数

名称	类型	必填	描述	示例值
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.	操作太频繁，请稍后重试
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的可用区不匹配
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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。