更新时间:2024-03-05 GMT+08:00

查询带宽

功能介绍

查询带宽。

URI

GET /v1/{project_id}/bandwidths/{bandwidth_id}

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

名称

是否必选

说明

project_id

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

bandwidth_id

带宽唯一标识

请求消息

  • 请求参数

  • 请求样例
    Get https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id}

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    bandwidth

    bandwidth object

    带宽对象

    表3 bandwidth字段说明

    名称

    参数类型

    说明

    name

    String

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

    size

    Integer

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

    id

    String

    带宽唯一标识

    share_type

    String

    • 取值为PER,表示独享带宽

    publicip_info

    Array of publicip_info objects

    • 功能说明:带宽对应的弹性IP信息,请参见表4

    tenant_id

    String

    项目ID

    bandwidth_type

    String

    • 功能说明:带宽类型
    • 取值范围:取值为bgp

    charge_mode

    String

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

    status

    String

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

    名称

    参数类型

    说明

    publicip_id

    String

    功能说明:带宽对应的弹性IP的唯一标识

    publicip_address

    String

    功能说明:IPv4时是申请到的弹性IP地址

    publicip_type

    String

    • 功能说明:弹性IP的类型
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。
  • 响应样例
    {
      "bandwidth": {
        "id": "3cbd5ae9-368f-4bc8-8841-f2ecc322c64a",
        "name": "EIPResourceSetup_1553594229",
        "size": 5,
        "share_type": "PER",
        "publicip_info": [
          {
            "publicip_id": "22b02f40-b95f-465a-ae9b-7c8b0f042a41",
            "publicip_address": "10.xx.xx.62",
            "ip_version": 4,
            "publicip_type": "5_bgp",
          }
        ],
        "tenant_id": "26ae5181a416420998eb2093aaed84d9",
        "bandwidth_type": "bgp",
        "charge_mode": "bandwidth",
        "status": "NORMAL",
        "created_at": "2020-04-21T07:58:02Z",
        "updated_at": "2020-04-21T07:58:02Z"
      }
    }

状态码

请参见状态码

错误码

请参考错误码