弹性公网IP EIP-查询带宽列表:响应参数

时间:2023-12-01 14:24:42

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

eip_bandwidths

Array of EipBandwidthResponseBody objects

带宽列表对象

page_info

PageInfoDict object

分页页码信息

request_id

String

本次请求的编号

表4 EipBandwidthResponseBody

参数

参数类型

描述

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

tenant_id

String

  • 功能说明:用户所属项目ID

tags

Array of strings

  • 功能说明:"公网EIP标签"

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

  • 功能说明:EIP的类型

  • 取值范围: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

当前页的数据总数

support.huaweicloud.com/api-eip/ListEipBandwidths.html