共享带宽插入弹性公网IP
功能介绍
共享带宽插入弹性公网IP。
URI
POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert
请求消息
- 请求参数
表3 bandwidth字段说明 名称
是否必选
参数类型
说明
publicip_info
是
Array of publicip_info objects
- 功能说明:要插入共享带宽的弹性公网IP信息,请参见表4。
- 约束:WHOLE类型的带宽支持多个弹性公网IP,跟租户的配额相关,默认一个共享带宽的配额为20。
表4 publicip_info对象 名称
是否必选
参数类型
说明
publicip_id
是
String
带宽对应的弹性公网IP的唯一标识
publicip_type
否
String
- 功能说明:弹性公网IP的类型
- 取值范围:5_bgp(全动态BGP),5_sbgp(静态BGP)
- 华南-广州:5_bgp、5_sbgp
- 华东-上海一:5_bgp、5_sbgp
- 华东-上海二:5_bgp、5_sbgp
- 华北-北京一:5_bgp、5_sbgp
- 中国-香港:5_bgp
- 亚太-曼谷:5_bgp
- 亚太-新加坡:5_bgp
- 非洲-约翰内斯堡:5_bgp
- 西南-贵阳一:5_sbgp
- 华北-北京四:5_bgp、5_sbgp
- 拉美-圣地亚哥:5_bgp
- 拉美-圣保罗一:5_bgp
- 拉美-墨西哥城一:5_bgp
- 拉美-布宜诺斯艾利一:5_bgp
- 拉美-利马一:5_bgp
- 拉美-圣地亚哥二:5_bgp
- 约束:
- 必须是系统具体支持的类型
- publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。
- 请求样例
POST https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}/insert { "bandwidth": { "publicip_info": [ { "publicip_id": "29b114d1-2d41-4741-a1f0-b6f80aabceff", "publicip_type": "5_bgp", } ] } }
响应消息
- 响应参数
表6 bandwidth字段说明 名称
参数类型
说明
name
String
- 功能说明:带宽名称
- 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)
size
Integer
- 功能说明:带宽大小。
- 取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。
id
String
带宽唯一标识
share_type
String
- 功能说明:带宽类型,标识是否是共享带宽
- 取值范围:WHOLE,PER
- WHOLE表示共享带宽
- PER表示独享带宽
publicip_info
Array of publicip_info objects
- 功能说明:带宽对应的弹性公网IP信息,请参见表7。
- 约束:WHOLE类型的带宽支持多个弹性公网IP,PER类型的带宽只能对应一个弹性公网IP
tenant_id
String
项目ID
bandwidth_type
String
- 功能说明:带宽类型,共享带宽默认为share。
- 取值范围:share,bgp,sbgp等
- share:共享带宽
- bgp:动态bgp
- sbgp:静态bgp
charge_mode
String
- 功能说明:按流量计费还是按带宽计费。
- 取值范围:bandwidth(按带宽计费),traffic(按流量计费),不返回或者为空时表示是bandwidth。
- 约束:共享带宽仅支持按带宽计费。
billing_info
String
账单信息。
如果billing_info不为空,说明是包周期的带宽。
enterprise_project_id
String
- 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。
- 创建共享带宽时,给共享带宽绑定企业项目ID。
说明:关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。
status
String
- 功能说明:带宽的状态
- 取值范围:
- FREEZED:冻结
- NORMAL:正常
enable_bandwidth_rules
boolean
- 功能说明:是否开启企业级QoS
- 取值范围:true/false
rule_quota
integer
功能说明:带宽支持的最大分组规则数
bandwidth_rules
Array of bandwidth_rules objects
功能说明:带宽规则对象
表7 publicip_info对象 名称
参数类型
说明
publicip_id
String
功能说明:带宽对应的弹性公网IP的唯一标识
publicip_address
String
功能说明:IPv4时是申请到的弹性公网IP地址
publicipv6_address
String
功能说明:IPv4时无此字段,IPv6时为申请到的弹性公网IP地址
ip_version
Integer
- 功能说明:IP版本信息
- 取值范围:
- 4:IPv4
- 6:IPv6
publicip_type
String
- 功能说明:弹性公网IP的类型
- 取值范围:5_bgp(全动态BGP),5_sbgp(静态BGP)
- 华南-广州:5_bgp、5_sbgp
- 华东-上海一:5_bgp、5_sbgp
- 华东-上海二:5_bgp、5_sbgp
- 华北-北京一:5_bgp、5_sbgp
- 中国-香港:5_bgp
- 亚太-曼谷:5_bgp
- 亚太-新加坡:5_bgp
- 非洲-约翰内斯堡:5_bgp
- 西南-贵阳一:5_sbgp
- 华北-北京四:5_bgp、5_sbgp
- 拉美-圣地亚哥:5_bgp
- 拉美-圣保罗一:5_bgp
- 拉美-墨西哥城一:5_bgp
- 拉美-布宜诺斯艾利一:5_bgp
- 拉美-利马一:5_bgp
- 拉美-圣地亚哥二:5_bgp
- 约束:
- 必须是系统具体支持的类型
- publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。
表8 bandwidth_rules对象 字段名称
类型
描述
id
string
带宽规则ID
name
string
带宽规则名称
admin_state_up
boolean
配置状态,为False时配置不生效
egress_size
integer
- 功能说明:出网带宽最大值,单位Mbps
- 取值范围[0,n],其中n为所属带宽的带宽大小(size字段)。0表示设置为最大带宽
egress_guarented_size
integer
- 功能说明:出网保障带宽大小,单位Mbps
- 取值范围[0,x],其中x为所属带宽剩余的保障额
publicip_info
Array of publicip_info objects
- 功能说明:带宽对应的弹性公网IP信息
- 约束:WHOLE类型的带宽支持多个弹性公网IP,PER类型的带宽只能对应一个弹性公网IP
- 响应样例
{ "bandwidth": { "id": "3fa5b383-5a73-4dcb-a314-c6128546d855", "name": "bandwidth123", "size": 10, "share_type": "WHOLE", "publicip_info": [ { "publicip_id": "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f", "publicip_address": "99.xx.xx.82", "publicip_type": "5_bgp", "ip_version": 4 } ], "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "charge_mode": "traffic", "billing_info": "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321", "bandwidth_type": "share", "status": "NORMAL" } }
状态码
请参见状态码。
错误码
请参考错误码。