请求参数
● NORMAL enable_band
4.2.3 更新带宽
}
状态码
状态码 描述
200 GET和PUT操作正常返回 400 服务器未能处理请求
401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许
406 服务器生成的响应无法被客户端所接受
407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间
409 由于冲突,请求无法被完成 500 请求未完成。服务异常
501 请求未完成。服务器不支持所请求的功能
502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常
504 网关超时
错误码
请参见错误码。
4.2.3 更新带宽
功能介绍
更新带宽。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/bandwidths/{bandwidth_id}
表4-161 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取项目ID请参见获取 项目ID
bandwidth_id 是 String 带宽唯一标识
请求参数
表4-162 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)
表4-163 请求 Body 参数
参数 是否必选 参数类型 描述
bandwidth 是 UpdateBand widthOption object
带宽对象
表4-164 UpdateBandwidthOption
参数 是否必选 参数类型 描述
name 否 String ● 取值范围:1-64,支持数
字、字母、中文、_(下划 线)、-(中划线),为空表 示不修改名称
● 功能说明:带宽名称
● 约束:name、size必须有一 个参数有值
参数 是否必选 参数类型 描述
● 约束:share_type是PER,该 参数必须带,如果
– 小于等于300Mbit/s:默 认最小单位为1Mbit/s。
– 300Mbit/s~1000Mbit/s:
默认最小单位为 50Mbit/s。
– 大于1000Mbit/s:默认最 小单位为500Mbit/s。
charge_mode 否 String ● 功能说明:按流量计费,按带 宽计费还是按增强型95计 费。
● 取值范围:bandwidth,
traffic,95peak_plus(按增
● bandwidth
● traffic
● 95peak_plus
响应参数
状态码: 200
表4-165 响应 Body 参数
参数 参数类型 描述
bandwidth BandwidthRe
sp object 带宽对象
表4-166 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 ● 功能说明:共享带宽类型,标识是否是共享带 宽
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-167 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-168 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-169 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 401
表4-170 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 403
表4-171 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 404
表4-172 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 405
表4-173 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 406
表4-174 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 407
表4-175 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 408
表4-176 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 409
表4-177 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 500
表4-178 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述
参数 参数类型 描述
code String 服务异常错误信息编码
状态码: 501
表4-179 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 502
表4-180 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 503
表4-181 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 504
表4-182 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
请求示例
{ "bandwidth" : { "size" : 10,
"name" : "bandwidth123"
}}
响应示例
状态码: 200
GET和PUT操作正常返回
{ "bandwidth" : {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "enterprise_project_id" : "0",
"size" : 10,
"share_type" : "PER", "bandwidth_type" : "bgp", "publicip_info" : [ {
"publicip_id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", "ip_version" : 4,
"publicip_type" : "5_bgp", "publicip_address" : "161.xx.xx.9"
} ],
"name" : "bandwidth123", "charge_mode" : "bandwidth", "enable_bandwidth_rules" : false, "rule_quota" : 0,
"bandwidth_rules" : [ ],
"id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "billing_info" : "",
"status" : "NORMAL"
}}
状态码
状态码 描述
200 GET和PUT操作正常返回 400 服务器未能处理请求
状态码 描述
501 请求未完成。服务器不支持所请求的功能
502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常
504 网关超时
错误码
请参见错误码。