调用AddCommonBandwidthPackageIps接口批量添加EIP到共享带宽中。

使用说明

  • 调用本接口批量添加EIP到共享带宽中时,EIP需满足以下条件:
    • EIP的计费方式为按量付费。
    • EIP的地域与要加入的共享带宽的地域相同。
    • EIP的线路类型与要加入的共享带宽的线路类型一致。
  • AddCommonBandwidthPackageIps接口属于异步接口,即系统会先返回一个请求ID,但EIP并未成功添加到共享带宽,系统后台的添加任务仍在进行。您可以调用DescribeCommonBandwidthPackages查询共享带宽和EIP的关联状态。
    • 当共享带宽和EIP的关联状态处于BINDING时,表示共享带宽与EIP关联中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当共享带宽和EIP的关联状态处于BINDED时,表示共享带宽与EIP关联完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String AddCommonBandwidthPackageIps

系统规定参数。取值:AddCommonBandwidthPackageIps

RegionId String cn-shanghai

共享带宽所在的地域ID。

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

BandwidthPackageId String cbwp-2ze2ic1xd2qeqasdf****

共享带宽实例ID。

IpType String EIP

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

ClientToken String 123e4567-e89b-12d3-a456-426655440000

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
IpInstanceIds.N String eip-2zeerraiwb7uqwed****

待添加的EIP实例ID列表。

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

返回数据

名称 类型 示例值 描述
RequestId String 01FDDD49-C4B7-4D2A-A8E5-A93915C450A6

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AddCommonBandwidthPackageIps
&RegionId=cn-shanghai
&BandwidthPackageId=cbwp-2ze2ic1xd2qeqasdf****
&IpType=EIP
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&IpInstanceIds=["eip-2zeerraiwb7uqwed****"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AddCommonBandwidthPackageIpsResponse>
    <RequestId>01FDDD49-C4B7-4D2A-A8E5-A93915C450A6</RequestId>
</AddCommonBandwidthPackageIpsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidIpInstanceId.NotFound The specified Eip InstanceId does not exist in our records. 指定的eip实例不存在。
400 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的RegionId不存在。
400 InvalidBandwidthPackageId.NotFound The specified bandwidthPackageId does not exist in our records. 指定的带宽包ID不存在。

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