更新时间:2023-01-20 GMT+08:00
分享

更新带宽

功能介绍

更新带宽。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/bandwidths/{bandwidth_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

bandwidth_id

String

带宽唯一标识

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表3 请求Body参数

参数

是否必选

参数类型

描述

bandwidth

UpdateBandwidthOption object

带宽对象

表4 UpdateBandwidthOption

参数

是否必选

参数类型

描述

name

String

  • 取值范围:1-64,支持数字、字母、中文、_(下划线)、-(中划线),为空表示不修改名称

  • 功能说明:带宽名称

  • 约束:name、size必须有一个参数有值

最小长度:1

最大长度:64

size

Integer

  • 功能说明:带宽大小,单位Mbit/s。

  • 取值范围:默认1Mbit/s~500Mbit/s1Mbit/s~1000Mbit/s1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。

  • 约束:share_type是PER,该参数必须带,如果share_type是WHOLE并且id有值,该参数会忽略。

  • 注意:调整带宽时的最小单位会根据带宽范围不同存在差异。

    • 小于等于300Mbit/s:默认最小单位为1Mbit/s。

    • 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。

    • 大于1000Mbit/s:默认最小单位为500Mbit/s。

charge_mode

String

  • 功能说明:按流量计费,按带宽计费还是按增强型95计费。

  • 取值范围:bandwidth,traffic,95peak_plus(按增强型95计费)不返回或者为空时表示是bandwidth。

  • 约束:只有共享带宽支持95peak_plus(按增强型95计费),按增强型95计费时需要指定保底百分比,默认是20%。

枚举值:

  • bandwidth

  • traffic

  • 95peak_plus

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

bandwidth

BandwidthResp object

带宽对象

表6 BandwidthResp

参数

参数类型

描述

bandwidth_type

String

  • 功能说明:带宽类型,共享带宽默认为share。

  • 取值范围:

    • eu-de: share(共享带宽)、bgp(动态BGP)、gray(Dedicated Load Balancer)

    • eu-nl: share(共享带宽)、bgp(动态BGP)

  • 取值范围:bgp,share

    • share: 共享带宽

    • bgp: 动态BGP

  • 取值范围:share,bgp,sbgp等。

    • share:共享带宽

    • bgp:动态bgp

    • sbgp:静态bgp

最小长度:1

最大长度:36

billing_info

String

  • 功能说明:账单信息,如果billinginfo不为空,说明是包周期的带宽

最小长度:0

最大长度:255

charge_mode

String

  • 功能说明:按流量计费,按带宽计费还是按增强型95计费。

  • 取值范围:bandwidth(按带宽计费),traffic(按流量计费),95peak_plus(按增强型95计费),不返回或者为空时表示是bandwidth。

  • 约束:只有共享带宽支持95peak_plus(按增强型95计费),按增强型95计费时需要指定保底百分比,默认是20%。取值为traffic,表示流量计费

枚举值:

  • bandwidth

  • traffic

  • 95peak_plus

id

String

  • 功能说明:带宽唯一标识

最大长度:36

name

String

  • 功能说明:带宽名称

  • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

最小长度:1

最大长度:64

publicip_info

Array of PublicipInfoResp objects

  • 功能说明:带宽对应的弹性公网IP信息

  • 约束:WHOLE类型的带宽支持多个EIP,PER类型的带宽只能对应一个EIP

share_type

String

  • 功能说明:共享带宽类型,标识是否是共享带宽

  • 取值范围:PER,WHOLE(PER为独占带宽,WHOLE是共享带宽)。

枚举值:

  • WHOLE

  • PER

size

Integer

  • 功能说明:带宽大小

  • 取值范围:默认1Mbit/s~500Mbit/s1Mbit/s~1000Mbit/s1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。

tenant_id

String

  • 功能说明:用户所属租户ID

最大长度:36

enterprise_project_id

String

  • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。

  • 创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

  • 不指定该参数时,默认值是 0

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

暂不支持该参数,请勿使用。

最大长度:36

status

String

  • 功能说明:带宽的状态

  • 取值范围:

    • FREEZED:冻结

    • NORMAL:正常

枚举值:

  • FREEZED

  • NORMAL

enable_bandwidth_rules

Boolean

  • 功能说明:是否开启企业级qos

  • 取值范围:true/false,该字段仅在上海1局点返回 暂不支持该参数,请勿使用

rule_quota

Integer

  • 功能说明:带宽支持的最大分组规则数。(该字段仅在上海1局点返回) 暂不支持该参数,请勿使用

最小值:0

最大值:1024

bandwidth_rules

Array of BandWidthRules 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

最小长度:1

最大长度:64

表7 BandWidthRules

参数

参数类型

描述

id

String

  • 功能说明:带宽规则ID

最大长度:36

name

String

  • 功能说明:带宽规则名称

最小长度:0

最大长度:64

admin_state_up

Boolean

  • 功能说明:配置状态,为False时配置不生效。

egress_size

Integer

  • 功能说明:出网带宽最大值,单位Mbps

  • 取值范围[0,n],其中n为所属带宽的带宽大小(size字段)。0表示设置为最大带宽

最小值:0

缺省值:0

egress_guarented_size

Integer

  • 功能说明:出网保障带宽大小,单位Mbps

  • 取值范围[0,x],其中x为所属带宽剩余的保障额

最小值:0

缺省值:0

publicip_info

Array of PublicipInfoResp objects

  • 功能说明:带宽对应的弹性公网IP信息

  • 约束:WHOLE类型的带宽支持多个弹性公网IP,PER类型的带宽只能对应一个弹性公网IP

表8 PublicipInfoResp

参数

参数类型

描述

publicip_address

String

  • 功能说明:功能说明:EIP或者IPv6端口的地址

最大长度:15

publicip_id

String

  • 功能说明:带宽对应的EIP或者IPv6端口的唯一标识

最大长度:36

publicip_type

String

  • 功能说明:EIP的类型

  • 取值范围:5_bgp(Dynamic BGP)、5_mainbgp(Mail BGP)

  • 取值范围:

    • eu-de: 5_bgp(Dynamic BGP)、5_mainbgp(Mail BGP)、5_gray(Dedicated Load Balancer)

    • eu-nl: 5_bgp(Dynamic BGP)、5_mainbgp(Mail BGP)

  • 取值范围: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_bgp、5_sbgp

    • 华北-北京四:5_bgp、5_sbgp

    • 拉美-圣地亚哥:5_bgp

    • 拉美-圣保罗一:5_bgp

    • 拉美-墨西哥城一:5_bgp

    • 拉美-布宜诺斯艾利一:5_bgp

    • 拉美-利马一:5_bgp

    • 拉美-圣地亚哥二: 5_bgp

  • 约束:

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口,所以"publicip_type""type"字段未给定时,默认为5_bgp。

最大长度:36

publicipv6_address

String

  • 功能说明:IPv4时无此字段,IPv6时为申请到的EIP地址

最大长度:39

ip_version

Integer

  • 功能说明:IP版本信息

  • 取值范围:

    • 4:IPv4

    • 6:IPv6暂不支持IPv6

枚举值:

  • 4

  • 6

状态码: 400

表9 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 401

表10 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 403

表11 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 404

表12 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 405

表13 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 406

表14 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 407

表15 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 408

表16 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 409

表17 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 500

表18 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 501

表19 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 502

表20 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 503

表21 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 504

表22 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

请求示例

{
  "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

服务器未能处理请求

401

被请求的页面需要用户名和密码

403

对被请求页面的访问被禁止

404

服务器无法找到被请求的页面

405

请求中指定的方法不被允许

406

服务器生成的响应无法被客户端所接受

407

用户必须首先使用代理服务器进行验证,这样请求才会被处理

408

请求超出了服务器的等待时间

409

由于冲突,请求无法被完成

500

请求未完成。服务异常

501

请求未完成。服务器不支持所请求的功能

502

请求未完成。服务器从上游服务器收到一个无效的响应

503

请求未完成。系统暂时异常

504

网关超时

错误码

请参见错误码

分享:

    相关文档

    相关产品