更新时间:2026-11-13 GMT+08:00

更新带宽

功能介绍

更新带宽。

URI

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

参数说明请参见表1。
表1 参数说明

名称

是否必选

说明

project_id

是

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

bandwidth_id

是

带宽唯一标识

请求参数

表2 请求参数

名称

是否必选

参数类型

说明

bandwidth

是

bandwidth object

带宽对象,请参见表3。

表3 bandwidth字段说明

名称

是否必选

参数类型

说明

name

否

String

  • 功能说明:带宽名称
  • 取值范围:1-64个字符,支持数字、字母、中文字符、_(下划线)、-(中划线)、.(点),为空表示不修改名称
  • 约束:name、size必须要有一个参数有值

size

否

Integer

  • 功能说明:带宽大小,单位Mbit/s。
  • 取值范围:默认1Mbit/s~300Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示),不带此参数时表示不修改大小。
  • 约束:name、size必须要有一个参数有值
  • 如果传入的参数为小数(如 10.2)或者字符类型(如“10”),会自动强制转换为整数。
  • 调整带宽时的最小单位会根据带宽范围不同存在差异。
    • 小于等于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%

请求样例

PUT https://{Endpoint}/v1/{project_id}/bandwidths/{bandwidth_id} 

{
    "bandwidth":
        {"name": "bandwidth123",
         "size": 10
        }
}

响应参数

表4 响应参数

名称

参数类型

说明

bandwidth

bandwidth object

带宽对象,请参见表5。

表5 bandwidth字段说明

名称

参数类型

说明

name

String

  • 功能说明:带宽名称
  • 取值范围:1-64个字符,支持数字、字母、中文字符、_(下划线)、-(中划线)、.(点)

size

Integer

  • 功能说明:带宽大小,单位Mbit/s。
  • 取值范围:默认1Mbit/s~300Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。

id

String

带宽唯一标识

share_type

String

  • 功能说明:共享带宽类型,标识是否是共享带宽
  • 取值范围:
    • PER:独享带宽
    • WHOLE:共享带宽

publicip_info

Array of publicip_info objects

  • 功能说明:带宽对应的弹性公网IP信息。详见表6。
  • 约束:WHOLE类型的带宽支持多个弹性公网IP,现在默认最多支持20个弹性公网IP,PER类型的带宽只能对应一个弹性公网IP

tenant_id

String

项目ID

bandwidth_type

String

  • 功能说明:带宽类型。
  • 取值范围:bgp,sbgp,share
    • 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”表示默认企业项目。若需要查询当前用户所有企业项目绑定的带宽,请传参all_granted_eps。
  • 创建带宽时,给带宽绑定企业项目ID。
说明:

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

status

String

  • 功能说明:带宽的状态
  • 取值范围:
    • FREEZED:冻结
    • NORMAL:正常

created_at

String

  • 功能说明:资源创建时间,UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ss

updated_at

String

  • 功能说明:资源更新时间,UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ss

enable_bandwidth_rules

boolean

  • 功能说明:是否开启企业级QoS
  • 取值范围:true/false

rule_quota

integer

功能说明:带宽支持的最大分组规则数

bandwidth_rules

Array of bandwidth_rules objects

功能说明:带宽规则对象

public_border_group

String

功能说明:表示中心站点资源或者边缘站点资源。

取值范围:

  • center
  • 边缘站点名称

约束限制:只能绑定与该字段相同的publicip资源

表6 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。
表7 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": "PER",
        "public_border_group": "center",
        "created_at": "2024-04-27T00:14:36Z",
        "updated_at": "2024-04-27T00:14:36Z",
        "publicip_info": [
            {
                "publicip_id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                "publicip_address": "161.xx.xx.9",
                "publicip_type": "5_bgp",
                "ip_version": 4            
            }
        ],
        "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
        "bandwidth_type": "bgp",
        "charge_mode": "bandwidth",
        "status": "NORMAL",
        "enable_bandwidth_rules": false,
        "rule_quota": 0,
        "bandwidth_rules": [],
    }
}

状态码

请参见状态码。

错误码

请参考错误码。