请求参数
● NORMAL enable_band
4.3 带宽(V2.0)
4.3.1 创建共享带宽
功能介绍
创建共享带宽。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2.0/{project_id}/bandwidths
表4-183 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取项目ID请参见获取 项目ID
请求参数
表4-184 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）
表4-185 请求 Body 参数
参数 是否必选 参数类型 描述
bandwidth 是 CreateShared BandwidthO ption object
带宽对象
表4-186 CreateSharedBandwidthOption
参数 是否必选 参数类型 描述
enterprise_pro
ject_id 否 String ● 企业项目ID。最大长度36字 节，带“-”连字符的UUID
name 是 String 取值范围：1-64，支持数字、字
母、中文、_(下划线)、-（中划
– 小于等于300Mbit/s：默 认最小单位为1Mbit/s。
– 300Mbit/s~1000Mbit/s：
默认最小单位为 50Mbit/s。
– 大于1000Mbit/s：默认最 小单位为500Mbit/s。
参数 是否必选 参数类型 描述
charge_mode 否 String ● 功能说明：按带宽计费还是 按增强型95计费。
● 取值范围：bandwidth，
95peak_plus（按增强型95计
● bandwidth
● 95peak_plus public_border – 边缘站点: edgeshare
响应参数
状态码： 200
表4-187 响应 Body 参数
参数 参数类型 描述
bandwidth BandwidthRe
sp object 带宽对象
表4-188 BandwidthResp
参数 参数类型 描述
bandwidth_ty
pe String ● 功能说明：带宽类型，共享带宽默认为 share。
● 取值范围：share，bgp，telcom，sbgp等。
– share：共享带宽 – bgp：动态bgp – telcom ：联通 – sbgp：静态bgp
billing_info String 功能说明：账单信息 如果billinginfo不为空，说 明是包周期的带宽
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类型的带宽支持多个EIP，PER 类型的带宽只能对应一个EIP
share_type String ● 功能说明：共享带宽类型，标识是否是共享带 宽
参数 参数类型 描述
size Integer ● 功能说明：带宽大小
取值范围：默认1Mbit/s~2000Mbit/s（具体范围 以各区域配置为准，请参见控制台对应页面显 示）。
tenant_id String 功能说明：用户所属租户ID enterprise_pro
ject_id String ● 企业项目ID。最大长度36字节，带“-”连字 符的UUID格式，或者是字符串“0”。
status String ● 功能说明：带宽的状态
● 取值范围：
– FREEZED：冻结 – NORMAL：正常 枚举值：
● FREEZED
● NORMAL enable_band
width_rules Boolean ● 功能说明：是否开启企业级qos
● 取值范围：true/false 该字段仅在上海1局点返 回
rule_quota Integer 功能说明：带宽支持的最大分组规则数。（该字 段仅在上海1局点返回）
bandwidth_ru
les Array of BandWidthR ules objects
功能说明：带宽规则对象（该字段仅在上海1局点 返回）
created_at String ● 功能说明：资源创建时间，UTC时间
● 格式： yyyy-MM-ddTHH:mm:ss updated_at String ● 功能说明：资源更新时间，UTC时间
● 格式： yyyy-MM-ddTHH:mm:ss public_border
_group String 功能说明：表示中心站点资源或者边缘站点资源 取值范围： center、边缘站点名称 约束：共享带 宽只能绑定与该字段相同的publicip
表4-189 BandWidthRules
参数 参数类型 描述
id String 带宽规则ID
name String 带宽规则名称 admin_state_
up Boolean 配置状态，为False时配置不生效。
egress_size Integer ● 功能说明：出网带宽最大值，单位Mbps
● 取值范围[0,n]，其中n为所属带宽的带宽大小
（size字段）。0表示设置为最大带宽 egress_guaren
ted_size Integer ● 功能说明：出网保障带宽大小，单位Mbps
● 取值范围[0,x]，其中x为所属带宽剩余的保障 额
publicip_info Array of PublicipInfoR esp objects
● 功能说明：带宽对应的弹性公网IP信息
● 约束：WHOLE类型的带宽支持多个弹性公网 IP，PER类型的带宽只能对应一个弹性公网IP
表4-190 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-191 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 401
表4-192 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 403
表4-193 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 404
表4-194 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 405
表4-195 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 406
表4-196 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 407
表4-197 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 408
表4-198 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 409
表4-199 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 500
表4-200 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述
参数 参数类型 描述
code String 服务异常错误信息编码
状态码： 501
表4-201 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 502
表4-202 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 503
表4-203 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 504
表4-204 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
请求示例
{ "bandwidth" : {
"enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439", "size" : 10,
"name" : "bandwidth123"
}}
响应示例
状态码： 200 POST操作正常返回
{ "bandwidth" : {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
"enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439", "billing_info" : "",
"size" : 10,
"share_type" : "WHOLE", "bandwidth_type" : "share", "publicip_info" : [ ], "name" : "bandwidth123", "charge_mode" : "bandwidth", "enable_bandwidth_rules" : false, "rule_quota" : 0,
"bandwidth_rules" : [ ],
"id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "status" : "NORMAL"
}}
状态码
状态码 描述
200 POST操作正常返回 400 服务器未能处理请求
状态码 描述
502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常
504 网关超时
错误码
请参见错误码。