文档首页 > > API参考> API> 带宽> 查询带宽列表

查询带宽列表

分享
更新时间: 2019/11/22 GMT+08:00

功能介绍

查询带宽列表。

URI

GET /v1/{project_id}/bandwidths

样例:
GET https://{Endpoint}/v1/{project_id}/bandwidths?limit={limit}&marker={marker}
参数说明请参见 表1
表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID

marker

String

功能说明:分页查询起始的资源id,为空时为查询第一页

limit

Integer

  • 功能说明:每页返回的个数
  • 取值范围:0~intmax

enterprise_project_id

String

  • 功能说明:企业项目ID。可以使用该字段过滤某个企业项目下的虚拟私有云。
  • 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的虚拟私有云,请传参all_granted_eps
说明:

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

请求消息

  • 请求参数

  • 请求样例

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    bandwidths

    Array of bandwidths objects

    带宽列表对象,请参见表3

    表3 bandwidths字段说明

    名称

    参数类型

    说明

    name

    String

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

    size

    Integer

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

    id

    String

    带宽唯一标识

    share_type

    String

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

    publicip_info

    Array of publicip_info objects

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

    tenant_id

    String

    项目ID

    bandwidth_type

    String

    • 功能说明:带宽类型。
    • 取值范围:bgp,sbgp, telcom, share
      • share:共享带宽
      • bgp:动态BGP
      • telcom:联通
      • sbgp:静态BGP

    charge_mode

    String

    • 功能说明:按流量计费还是按带宽计费。
    • 取值范围:bandwidth(按带宽计费),traffic(按流量计费),不返回或者为空时表示是bandwidth

    billing_info

    String

    账单信息

    如果billing_info不为空,说明是包周期的带宽

    enterprise_project_id

    String

    • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。若需要查询当前用户所有企业项目绑定的带宽,请传参all_granted_eps
    • 创建带宽时,给带宽绑定企业项目ID。

    status

    String

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

    表4 publicip_info对象

    名称

    参数类型

    说明

    publicip_id

    String

    功能说明:带宽对应的弹性公网IP的唯一标识或IPv6端口的唯一标识

    publicip_address

    String

    功能说明:IPv4时是申请到的弹性公网IP地址,IPv6时为IPv6地址对应的IPv4地址

    publicipv6_address

    String

    功能说明:IPv4时无此字段,IPv6时为申请到的弹性公网IP地址

    ip_version

    Integer

    • 功能说明:IP版本信息
    • 取值范围:
      • 4:IPv4
      • 6:IPv6

    publicip_type

    String

    • 功能说明:弹性公网IP的类型
    • 取值范围:5_telcom(电信),5_union(联通),5_bgp(全动态BGP),5_sbgp(静态BGP)
      • 东北-大连:5_telcom、5_union
      • 华南-广州: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
    • 约束:必须是系统具体支持的类型
  • 响应样例
    {
      "bandwidths": [
        {
          "id": "09b99c91-da7c-449f-94e2-f4934c5b2a71",
          "name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977",
          "size": 2000,
          "share_type": "PER",
          "publicip_info": [
            {
              "publicip_id": "2a65923c-7133-415d-ae3b-cf9635a942c5",
              "publicip_address": "10.xx.xx.3",
              "ip_version": 4,
              "publicip_type": "5_bgp"
            }
          ],
          "tenant_id": "26ae5181a416420998eb2093aaed84d9",
          "bandwidth_type": "bgp",
          "charge_mode": "bandwidth",
          "enterprise_project_id": "0",
          "status": "NORMAL"
        },
        {
          "id": "0a583ff1-b43e-4000-ade3-e7af0097f832",
          "name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d",
          "size": 300,
          "share_type": "PER",
          "publicip_info": [
            {
              "publicip_id": "c754bc9a-16d5-4763-9674-d7561917aa80",
              "publicip_address": "10.xx.xx.9",
              "ip_version": 4,
              "publicip_type": "5_bgp"
            }
          ],
          "tenant_id": "26ae5181a416420998eb2093aaed84d9",
          "bandwidth_type": "bgp",
          "charge_mode": "bandwidth",
          "enterprise_project_id": "0",
          "status": "NORMAL"
        },
        {
          "id": "0a673f00-3640-4a13-949e-7049b2916baf",
          "name": "bandwidth123",
          "size": 10,
          "share_type": "PER",
          "publicip_info": [
            {
              "publicip_id": "cec7fb70-2f82-4561-bd83-2121fb642fdc",
              "publicip_address": "10.xx.xx.184",
              "ip_version": 4,
              "publicip_type": "5_bgp"
            }
          ],
          "tenant_id": "26ae5181a416420998eb2093aaed84d9",
          "bandwidth_type": "bgp",
          "charge_mode": "bandwidth",
          "enterprise_project_id": "0",
          "status": "NORMAL"
        },
        {
          "id": "0dde1eae-1783-46dc-998c-930fbe261ff9",
          "name": "bandwidth123",
          "size": 100,
          "share_type": "PER",
          "publicip_info": [
            {
              "publicip_id": "24232038-e178-40ad-80e4-5abb75db84be",
              "publicip_address": "10.xx.xx.101",
              "ip_version": 4,
              "publicip_type": "5_bgp"
            }
          ],
          "tenant_id": "26ae5181a416420998eb2093aaed84d9",
          "bandwidth_type": "bgp",
          "charge_mode": "bandwidth",
          "enterprise_project_id": "0",
          "status": "NORMAL"
        }
      ]
    }

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区