文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 带宽/ 查询带宽列表

更新时间：2024-10-15 GMT+08:00

在线调试

CLI示例

查看PDF

查询带宽列表

功能介绍

查询带宽列表

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/eip/bandwidths

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取项目ID请参见获取项目ID 最大长度：32

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	String	功能说明：每页返回的个数取值范围：取值范围：1~[2000]，其中2000为局点差异项，具体取值由局点决定
marker	否	String	功能说明：分页查询起始的资源ID，为空时为查询第一页最小长度：0 最大长度：36
id	否	String	功能说明：带宽唯一标识
bandwidth_type	否	String	功能说明：带宽类型，共享带宽默认为share。取值范围：share，bgp，telcom，sbgp等。 share：共享带宽 bgp：动态bgp telcom ：联通 sbgp：静态bgp
name	否	String	功能说明：宽带名称，按照宽带名称过滤
name_like	否	String	功能说明：根据宽带名称模糊查询过滤
project_id	否	String	功能说明：根据project_id过滤
ingress_size	否	String	功能说明：根据入云大小过滤
admin_state	否	String	功能说明：根据宽带状态过滤
billing_info	否	String	功能说明：根据计费信息过滤
tags	否	String	功能说明：根据标签过滤
enable_bandwidth_rules	否	String	功能说明：根据是否带宽分组使能过滤取值范围：true、false
rule_quota	否	Integer	功能说明：根据规则数值过滤
public_border_group	否	String	功能说明：根据站点信息过滤
charge_mode	否	String	功能说明：按流量计费,按带宽计费还是按增强型95计费取值范围：bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth 约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%
size	否	String	功能说明：带宽大小。共享带宽的大小有最小值限制，默认为5M，可能因局点不同而不同。取值范围：默认5Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。调整带宽时的最小单位会根据带宽范围不同存在差异。小于等于300Mbit/s：默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。大于1000Mbit/s：默认最小单位为500Mbit/s。
type	否	String	功能说明：带宽类型，标识是否是共享带宽取值范围：WHOLE，PER。 WHOLE表示共享带宽 PER表示独享带宽

请求参数

无

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
eip_bandwidths	Array of BandwidthResponseBody objects	带宽列表对象
page_info	PageInfoDict object	分页页码信息
request_id	String	本次请求的编号

表4 BandwidthResponseBody
参数	参数类型	描述
admin_state	String	功能说明：带宽状态取值范围：normal，freezed
ingress_size	Integer	功能说明：入网大小，单位Mbit/s
rule_quota	Integer	功能说明：规则数值，最低阈值可调节
ratio_95peak_plus	Integer	功能说明：增强型95带宽保底率，最低保底率为20
enable_bandwidth_rules	Boolean	功能说明：带宽分组使能，表明开启带宽分组限速功能。
bandwidth_rules	Array of BandWidthRules objects	功能说明：带宽规则对象（该字段仅在上海1局点返回）
public_border_group	String	功能说明：带宽AZ属性，表征中心和边缘。中心带宽默认为center
bandwidth_type	String	功能说明：带宽类型，共享带宽默认为share。取值范围：share，bgp，telcom，sbgp等。 share：共享带宽； bgp：动态bgp； telcom ：联通； sbgp：静态bgp。最小长度：1 最大长度：36
billinginfo	String	功能说明：账单信息，最小长度：0 最大长度：255
id	String	功能说明：带宽唯一标识最小长度：1 最大长度：36
name	String	功能说明：带宽名称取值范围：1-64个字符，支持数字、字母、中文字符、_(下划线)、-（中划线）、.（点）最小长度：1 最大长度：64
publicip_info	Array of PublicipInfoResponseBody objects	功能说明：带宽对应的弹性公网IP信息约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP
type	String	功能说明：带宽类型，标识是否是共享带宽取值范围：WHOLE，PER。 WHOLE表示共享带宽；PER表示独享带宽枚举值： WHOLE PER
size	Integer	功能说明：带宽大小取值范围：默认5Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。最小值：5 最大值：2000
project_id	String	功能说明：用户所属项目ID
tags	Array of strings	功能说明："公网弹性公网IP标签"
created_at	String	功能说明：资源创建时间，采用UTC时间，格式：YYYY-MM-DDTHH:MM:SS
updated_at	String	功能说明：资源更新时间，采用UTC时间，格式：YYYY-MM-DDTHH:MM:SS

表5 BandWidthRules
参数	参数类型	描述
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 PublicipInfoResponseBody objects	功能说明：带宽对应的弹性公网IP信息约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP

表6 PublicipInfoResponseBody
参数	参数类型	描述
publicip_address	String	功能说明：弹性公网IPV4或IPv6的公网地址
publicip_id	String	功能说明：带宽对应的弹性公网IPV4或IPv6的唯一标识最小长度：1 最大长度：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地址
ip_version	Integer	功能说明：IP版本信息取值范围： 4：IPv4； 6：IPv6 枚举值： 4 6

表7 PageInfoDict
参数	参数类型	描述
previous_marker	String	翻页时，作为前一页的marker取值
next_marker	String	翻页时，作为后一页的marker取值
current_count	Integer	当前页的数据总数

请求示例

查询带宽列表，可根据query字段过滤

GET https://{Endpoint}/v3/{project_id}/bandwidths?limit=3&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d

响应示例

状态码： 200

GET操作正常返回

{
  "request_id" : "4e5945ddd409f306b3cb4fd921a45390",
  "eip_bandwidths" : [ {
    "name" : "bandwidth-838f",
    "id" : "08b4700e-cc3c-4aed-a35a-66022bcbd0f6",
    "project_id" : "cb576f8cf0df40b8bb6cea0a1765c569",
    "size" : 10,
    "bandwidth_type" : "bgp",
    "ratio_95peak_plus" : null,
    "admin_state" : "NORMAL",
    "ingress_size" : 10,
    "type" : "PER",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "created_at" : "2023-05-17T02:06:49Z",
    "updated_at" : "2023-05-17T02:06:49Z",
    "bandwidth_rules" : [ ],
    "publicip_info" : [ {
      "publicip_address" : "10.83.15.65",
      "publicip_type" : "5_bgp",
      "publicip_id" : "e73fcc26-c009-4ea3-9b57-d546359bda38",
      "ip_version" : 4,
      "publicipv6_address" : null
    } ],
    "tags" : [ ],
    "public_border_group" : "center"
  } ],
  "page_info" : [ {
    "next_marker" : "08b4700e-cc3c-4aed-a35a-66022bcbd0f6",
    "previous_marker" : "08b4700e-cc3c-4aed-a35a-66022bcbd0f6",
    "current_count" : 1
  } ]
}

状态码

状态码	描述
200	GET操作正常返回

错误码

请参见错误码。

父主题：带宽

上一篇：查询带宽列表（老接口）

下一篇：查看租户带宽限制

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

查询带宽列表

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线