请求参数
● NORMAL enable_band
4.3 带宽(V2.0)
4.3.4 共享带宽插入 EIP
功能介绍
共享带宽插入EIP。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert
表4-242 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取项目ID请参见获取 项目ID
bandwidth_id 是 String 带宽唯一标识
请求参数
表4-243 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）
表4-244 请求 Body 参数
参数 是否必选 参数类型 描述
bandwidth 是 AddPublicipsI ntoSharedBa ndwidthOpti on object
带宽对象
表4-245 AddPublicipsIntoSharedBandwidthOption
参数 是否必选 参数类型 描述
publicip_info 是 Array of InsertPublici pInfo objects
● 功能说明：要插入共享带宽 的EIP信息或者IPv6端口
● 约束：WHOLE类型的带宽支 持多个EIP或者IPv6端口，跟 租户的配额相关，默认一个 共享带宽的配额为20
表4-246 InsertPublicipInfo
参数 是否必选 参数类型 描述
publicip_type 否 String ● 功能说明：EIP的类型
● 取值范围：5_telcom（电 信），5_union（联通），
– publicip_id为IPv4端口，
所以"type"字段未给定 时，默认为5_bgp。
publicip_id 是 String 功能说明：带宽对应的EIP或者 IPv6端口PORT的唯一标识
响应参数
状态码： 200
表4-247 响应 Body 参数
参数 参数类型 描述
bandwidth BandwidthRe spInsert object
带宽对象
表4-248 BandwidthRespInsert
参数 参数类型 描述
bandwidth_ty
pe String ● 功能说明：带宽类型，共享带宽默认为 share。
● 取值范围：share，bgp，telcom，sbgp等。
– share：共享带宽 – bgp：动态bgp – telcom ：联通 – sbgp：静态bgp
charge_mode String ● 功能说明：按流量计费,按带宽计费还是按增强 型95计费。
● 取值范围：bandwidth（按带宽计费），
traffic（按流量计费），95peak_plus（按增 强型95计费）不返回或者为空时表示是 bandwidth。
● 约束：只有共享带宽支持95peak_plus（按增 强型95计费），按增强型95计费时需要指定保 底百分比，默认是20%。
枚举值：
● bandwidth
● traffic
● 95peak_plus
id String 功能说明：带宽唯一标识
name String ● 功能说明：带宽名称
● 取值范围：1-64个字符，支持数字、字母、中 文、_(下划线)、-（中划线）、.（点）
publicip_info Array of PublicipInfoR esp objects
● 功能说明：带宽对应的弹性公网IP信息
● 约束：WHOLE类型的带宽支持多个弹性公网 IP，PER类型的带宽只能对应一个弹性公网IP
参数 参数类型 描述
billing_info String 功能说明：账单信息 如果billinginfo不为空，说 明是包周期的带宽
share_type String ● 功能说明：带宽类型，标识是否是共享带宽
● 取值范围：WHOLE，PER – WHOLE表示共享带宽
● 取值范围：默认5Mbit/s~2000Mbit/s（具体范 围以各区域配置为准，请参见控制台对应页面 显示）。
tenant_id String 功能说明：用户所属租户ID enterprise_pro
ject_id String ● 企业项目ID。最大长度36字节，带“-”连字 符的UUID格式，或者是字符串“0”。
status String ● 功能说明：带宽的状态
● 取值范围：
– FREEZED：冻结 – NORMAL：正常 枚举值：
● FREEZED
● NORMAL
表4-249 PublicipInfoResp
参数 参数类型 描述
publicip_addr
ess String 功能说明：EIP或者IPv6端口的地址
publicip_id String 功能说明：带宽对应的EIP或者IPv6端口的唯一标 识
参数 参数类型 描述
publicip_type String ● 功能说明：EIP的类型
● 取值范围：5_telcom（电信），5_union（联 通），5_bgp（全动态BGP），5_sbgp（静态 BGP），5_ipv6
– 华南-广州：5_bgp、5_sbgp – 华东-上海一：5_bgp、5_sbgp – 华东-上海二：5_bgp、5_sbgp
– 华北-北京一：5_bgp、5_sbgp、5_ipv6 – 中国-香港：5_bgp
– 亚太-曼谷：5_bgp – 亚太-新加坡：5_bgp – 非洲-约翰内斯堡：5_bgp – 西南-贵阳一：5_bgp、5_sbgp – 华北-北京四：5_bgp、5_sbgp – 拉美-圣地亚哥：5_bgp
– publicip_id为IPv4端口，所以"type"字段未 给定时，默认为5_bgp。
publicipv6_ad
dress String 功能说明：IPv4时无此字段，IPv6时为申请到的 EIP地址
ip_version Integer ● IP版本信息
● 取值范围：
表4-250 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 401
表4-251 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 403
表4-252 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 404
表4-253 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 405
表4-254 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 406
表4-255 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 407
表4-256 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 408
表4-257 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 409
表4-258 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 500
表4-259 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述
参数 参数类型 描述
code String 服务异常错误信息编码
状态码： 501
表4-260 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 502
表4-261 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 503
表4-262 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 504
表4-263 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
请求示例
{ "bandwidth" : { "publicip_info" : [ {
"publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a", "publicip_type" : "5_dualStack"
}, {
"publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
} ]
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
"billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:
35f2b308f5d64441a6fa7999fbcd4321", "size" : 10,
"share_type" : "WHOLE", "bandwidth_type" : "share", "publicip_info" : [ {
"publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a", "ip_version" : 4,
"publicip_type" : "5_dualStack", "publicip_address" : "::ffff:192.168.89.9"
}, {
"publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f", "ip_version" : 4,
"publicip_type" : "5_bgp", "publicip_address" : "99.xx.xx.82"
} ],
"name" : "bandwidth123", "enable_bandwidth_rules" : false, "rule_quota" : 0,
"bandwidth_rules" : [ ], "charge_mode" : "bandwidth",
"id" : "3fa5b383-5a73-4dcb-a314-c6128546d855"
}}
状态码
状态码 描述
200 POST操作正常返回 400 服务器未能处理请求
状态码 描述
407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间
409 由于冲突，请求无法被完成 500 请求未完成。服务异常
501 请求未完成。服务器不支持所请求的功能
502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常
504 网关超时
错误码
请参见错误码。