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

批量创建共享带宽

功能介绍

批量创建共享带宽。

URI

POST /v2.0/{project_id}/batch-bandwidths

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

名称

是否必选

说明

project_id

是

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

请求参数

表2 请求参数

名称

是否必选

参数类型

说明

bandwidth

是

bandwidth object

带宽对象,请参见表3。

表3 bandwidth字段说明

名称

是否必选

参数类型

说明

name

是

String

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

size

是

Integer

  • 功能说明:带宽大小。共享带宽的大小有最小值限制,默认为5Mbit/s,可能因局点不同而不同。
  • 取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。
  • 注意:调整带宽时的最小单位会根据带宽范围不同存在差异。
    • 小于等于300Mbit/s:默认最小单位为1Mbit/s。
    • 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。
    • 大于1000Mbit/s:默认最小单位为500Mbit/s。

count

是

Integer

  • 功能说明:批创的共享带宽的个数
  • 取值范围:正整数
  • 说明: 如果传入的参数为小数(如 2.2)或者字符类型(如“2”),会自动强制转换为整数。

public_border_group

否

String

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

取值范围:

  • center
  • 边缘站点名称

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

请求样例

POST https://{Endpoint}/v2.0/{project_id}/batch-bandwidths

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

响应参数

表4 响应参数

名称

参数类型

说明

bandwidths

Array of bandwidths objects

批创的带宽对象的列表,请参见表5。

表5 bandwidths字段说明

名称

参数类型

说明

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信息,请参见表6。
  • 约束: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不为空,说明是包周期的带宽。

status

String

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

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。

响应样例

{
  "bandwidths": [
    {
      "id": "7e5a1a30-6e88-4ce5-b5fa-1d6c6864e084",
      "name": "bandwidth123",
      "size": 10,
      "share_type": "WHOLE",
      "publicip_info": [],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "share",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "status": "NORMAL"
    },
    {
      "id": "ed2da50a-3ce9-4d86-9f17-e8f3801299a5",
      "name": "bandwidth123",
      "size": 10,
      "share_type": "WHOLE",
      "publicip_info": [],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "share",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "status": "NORMAL"
    }
  ]
}

状态码

请参见状态码。

错误码

请参考错误码。