查询带宽列表

project_id

是

String

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

marker

否

String

• 功能说明：取值为上一页数据的最后一条记录的id，为空时为查询第一页

最大长度：36

limit

否

Integer

• 功能说明：每页返回的个数

• 取值范围：0~intmax

最小值：0

enterprise_project_id

否

String

• 功能说明：企业项目ID。可以使用该字段过滤某个企业项目下的弹性公网IP。

• 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。如果需要查询当前用户所有企业项目绑定的弹性公网IP，请传参all_granted_eps。

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

share_type

否

String

• 功能说明：带宽类型，标识是否是共享带宽

• 取值范围：WHOLE，PER

  • WHOLE：共享带宽

  • PER：独享带宽

枚举值：

• WHOLE

• PER

bandwidths

Array of BandwidthResp objects

带宽列表对象

bandwidth_type

String

• 功能说明：带宽类型，共享带宽默认为share。

• 取值范围：share,share_sbgp

  • share: 通用共享带宽

  • share_sbgp: 静态共享带宽

最小长度：1

最大长度：36

billing_info

String

• 功能说明：账单信息，如果billinginfo不为空，说明是包周期的带宽

最小长度：0

最大长度：255

charge_mode

String

• 功能说明：按流量计费,按带宽计费还是按增强型95计费。

• 取值范围：bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。

• 约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。

枚举值：

• bandwidth

• traffic

• 95peak_plus

id

String

• 功能说明：带宽唯一标识

最大长度：36

name

String

• 功能说明：带宽名称

• 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最小长度：1

最大长度：64

publicip_info

Array of PublicipInfoResp objects

• 功能说明：带宽对应的弹性公网IP信息

• 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP

share_type

String

• 功能说明：共享带宽类型，标识是否是共享带宽

• 取值范围：PER，WHOLE（PER为独占带宽，WHOLE是共享带宽）。

枚举值：

• WHOLE

• PER

size

Integer

• 功能说明：带宽大小

• 取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。

tenant_id

String

• 功能说明：用户所属租户ID

最大长度：36

enterprise_project_id

String

• 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

• 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。

• 不指定该参数时，默认值是 0

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

最大长度：36

status

String

• 功能说明：带宽的状态

• 取值范围：

  • FREEZED：冻结

  • NORMAL：正常

枚举值：

• FREEZED

• NORMAL

enable_bandwidth_rules

Boolean

• 功能说明：是否开启企业级qos

• 取值范围：true/false，该字段仅在上海1局点返回

rule_quota

Integer

• 功能说明：带宽支持的最大分组规则数。（该字段仅在上海1局点返回）

最小值：0

最大值：1024

bandwidth_rules

Array of BandWidthRules objects

• 功能说明：带宽规则对象（该字段仅在上海1局点返回）

created_at

String

• 功能说明：资源创建时间，UTC时间

• 格式： yyyy-MM-ddTHH:mm:ss

updated_at

String

• 功能说明：资源更新时间，UTC时间

• 格式： yyyy-MM-ddTHH:mm:ss

public_border_group

String

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

• 取值范围： center、边缘站点名称

• 约束：共享带宽只能绑定与该字段相同的publicip

最小长度：1

最大长度：64

id

String

• 功能说明：带宽规则ID

最大长度：36

name

String

• 功能说明：带宽规则名称

最小长度：0

最大长度：64

admin_state_up

Boolean

• 功能说明：配置状态，为False时配置不生效。

egress_size

Integer

• 功能说明：出网带宽最大值，单位Mbps

• 取值范围[0,n]，其中n为所属带宽的带宽大小（size字段）。0表示设置为最大带宽

最小值：0

缺省值：0

egress_guarented_size

Integer

• 功能说明：出网保障带宽大小，单位Mbps

• 取值范围[0,x]，其中x为所属带宽剩余的保障额

最小值：0

缺省值：0

publicip_info

Array of PublicipInfoResp objects

• 功能说明：带宽对应的弹性公网IP信息

• 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP

publicip_address

String

• 功能说明：功能说明：弹性公网IP或者IPv6端口的地址

最大长度：15

publicip_id

String

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

最大长度：36

publicip_type

String

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

• 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP）

  • 华南-广州：5_bgp、5_sbgp

  • 华东-上海一：5_bgp、5_sbgp

  • 华东-上海二：5_bgp、5_sbgp

  • 华北-北京一：5_bgp、5_sbgp

  • 中国-香港：5_bgp、5_youxuanbgp

  • 亚太-曼谷：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端口，所以"type"字段未给定时，默认为5_bgp。

最大长度：36

publicipv6_address

String

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

最大长度：39

ip_version

Integer

• 功能说明：IP版本信息

• 取值范围：

  • 4：IPv4

  • 6：开启NAT64能力

枚举值：

• 4

• 6

200

GET和PUT操作正常返回