全部产品
Search
文档中心

共享带宽:AddCommonBandwidthPackageIps - 批量添加EIP到共享带宽中

更新时间:Dec 01, 2023

批量添加EIP到共享带宽中。

接口说明

  • 调用本接口批量添加EIP到共享带宽中时,EIP需满足以下条件:
    • EIP的计费方式为按量付费。
    • EIP的地域与要加入的共享带宽的地域相同。
    • EIP的线路类型与要加入的共享带宽的线路类型一致。
  • AddCommonBandwidthPackageIps接口属于异步接口,即系统会先返回一个请求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:AddCommonBandwidthPackageIpsWrite
  • BandwidthPackage
    acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}

请求参数

名称类型必填描述示例值
RegionIdstring

共享带宽所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

cn-shanghai
BandwidthPackageIdstring

共享带宽实例ID。

cbwp-2ze2ic1xd2qeqasdf****
IpTypestring

IP类型。取值:EIP,表示将EIP添加至共享带宽。

EIP
ClientTokenstring

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
123e4567-e89b-12d3-a456-426655440000
IpInstanceIdsarray

待添加的EIP实例ID列表。

一次最多支持添加10个EIP实例ID。

string

待添加的EIP实例ID列表。

一次最多支持添加10个EIP实例ID。

eip-2zeerraiwb7uqwed****

返回参数

名称类型描述示例值
object

返回参数列表。

RequestIdstring

请求ID。

01FDDD49-C4B7-4D2A-A8E5-A93915C450A6

示例

正常返回示例

JSON格式

{
  "RequestId": "01FDDD49-C4B7-4D2A-A8E5-A93915C450A6"
}

错误码

HTTP status code错误码错误信息描述
400OperationDenied.SecurityProtectionTypesInconsistentThe operation is not allowed because of SecurityProtectionTypesInconsistent.-
400InvalidIpInstanceId.NotFoundThe specified Eip InstanceId does not exist in our records.指定的eip实例不存在。
400EIP_ALREADY_IN_BANDWIDTHPACKAGEThe Eip already in bandwidthPackage.-
400InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
400InvalidBandwidthPackageId.NotFoundThe specified bandwidthPackageId does not exist in our records.指定的带宽包ID不存在。
400IpInstanceId.AlreadyInBandwidthPackageThe specified Eip InstanceId does not exist in our records.-
400IpInstanceId.BizStatusInvalidThe specified Eip BizStatus is Disable, Cannot add to bandwidthPackage.-
400IpInstanceId.ChargeType.NotSupportThe specified Eip instance is PrePaid type, Cannot add to BandwidthPackage.-
400BandwidthPackageId.InvalidBizStatusThe specified BandwidthPackageId has been FinancialLocked, Cannot add Ip.-
400IpInstanceId.QuotaExceededThe specified BandwidthPackageId has too many ip in it. exceed the quota , Cannot add more.-
400EipOperation.TooFrequentlyThe specified Eip add into bandwidthPackage too frequently. please add later.-
400IpInstanceId.InvalidIpInternetChargeTypeThe hybrid type eip not support add into bandwidthPackage of PayBytraffic type.-
400TaskConflictThe operation is too frequent, TaskConflict.操作太频繁,请稍后重试
400IncorrectStatus.EipEip status error.-
400OperationUnsupported.IpTypeIp type does not support the operation.-
400ParamExclusive.IpInstanceIdAndBandwidthPackageId%s-
400InvalidBandwidthPackage.NotExistEip bandwidth package not exist.-
400OperationFailed.DistibuteLockDistibute lock fail.-
400BandwidthPackageId.InvalidBandwidthThe hybrid type eip can not add into low bandwidth bandwidthPackage.-
400OperationFailed.ZoneIdInconsistent%s-
400AttrMismatching.BandwidthPackageIpVersion%s-
400InvalidBandwidthPackageId.NotFoundThe specified BandwidthPackageId not exist.-
400InvalidEIPStatus.BizDisabledThe EIP has been locked.EIP实例被锁定
400Forbidden.FinancialLockedThe ip business status is invalid.该实例已欠费锁定,无法操作
400Mismatch.CloudBoxCbwpZoneAndEipZoneThe CbwpZone and EipZone are mismatched.云盒共享带宽和EIP的可用区不匹配
400InvalidInstanceId.NotFoundThe InstanceId is not found.实例InstanceId找不到。

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

变更历史

变更时间变更内容概要操作
2023-08-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-06-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更