文档首页/ 智能边缘云 IEC/ API参考/ API/ 带宽/ 查询带宽列表
更新时间：2024-01-02 GMT+08:00
查看PDF
分享

查询带宽列表

功能介绍

查询带宽列表。

调试

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

URI

GET /v1/bandwidths

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

查询的数目，取值范围：0~1000。

最小值：0

最大值：1000

offset

否

Integer

查询的偏移量。

site_id

否

String

边缘站点ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

bandwidths

Array of Bandwidth objects

带宽列表对象。

count

Integer

带宽数量。
表4 Bandwidth

参数

参数类型

描述

bandwidth_type

String

带宽类型。

charge_mode

String

计费模式，当前只支持峰值95计费。

取值范围：

  • 95peak_plus：峰值95计费

create_time

String

创建时间。

id

String

带宽ID。

name

String

带宽名称。

最小长度：1

最大长度：64

operator

Operator object

运营商信息。

publicip_info

Array of PublicipInfo objects

弹性公网IP信息。

share_type

String

共享带宽类型，标识是否是共享带宽。

取值范围：

  • WHOLE：共享带宽

site_id

String

边缘站点ID。

site_info

String

站点信息。

size

Integer

带宽大小。

最小值：300

最大值：2000

status

String

带宽的状态。

取值范围：

  • FREEZED：冻结

  • NORMAL：正常

update_time

String

更新时间。

pool_id

String

线路ID。
表5 Operator

参数

参数类型

描述

id

String

运营商ID。

name

String

运营商名称。

取值范围：

  • chinamobile：中国移动；

  • chinaunicom：中国联通；

  • chinatelecom：中国电信。

i18n_name

String

运营商国际化名称。

sa

String

运营商的简写。
表6 PublicipInfo

参数

参数类型

描述

ip_version

Integer

IP版本的信息

publicip_address

String

弹性公网IP

publicip_id

String

弹性公网IP的ID。

publicip_type

String

功能说明：弹性公网IP的类型

请求示例

GET https://{endpoint}/v1/bandwidths

响应示例

状态码： 200

OK

{
  "bandwidths" : [ {
    "id" : "f123b229-8755-4a9d-a050-7d30ee63afab",
    "name" : "bandwidth-3bvf",
    "size" : 500,
    "share_type" : "WHOLE",
    "publicip_info" : [ {
      "publicip_id" : "6aa7c090-d111-40e2-ba2a-2985c833e859",
      "publicip_address" : "122.xxx.xxx.xxx",
      "publicip_type" : "5_bgp_site3",
      "ip_version" : 4
    } ],
    "bandwidth_type" : "share",
    "charge_mode" : "95peak_plus",
    "site_id" : "6813be76-7322-11ea-9ce0-286ed488d287",
    "status" : "NORMAL",
    "create_time" : "2021-01-19T02:21:17.213934Z",
    "site_info" : "中国/华南地区/广东/中山市",
    "operator" : {
      "id" : "2",
      "i18n_name" : "中国联通",
      "sa" : "CUCC"
    },
    "pool_id" : "5_bgp_site3",
    "update_time" : "2021-03-30T01:22:01.679039Z"
  } ],
  "count" : 12
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 带宽

相关文档