文档首页/ 弹性公网IP EIP/ API参考/ API/ 带宽/ 查询带宽详情
更新时间：2025-02-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询带宽详情

功能介绍

查询单条指定带宽的详细信息

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

bandwidth_id

是

String

带宽的唯一标识

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

bandwidth

BandwidthResp object

带宽对象
表3 BandwidthResp

参数

参数类型

描述

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%。

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是共享带宽）。

size

Integer

  • 功能说明：带宽大小

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

tenant_id

String

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

最大长度：36

enterprise_project_id

String

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

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

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

最大长度：36

status

String

  • 功能说明：带宽的状态

  • 取值范围：

    • FREEZED：冻结

    • NORMAL：正常

enable_bandwidth_rules

Boolean

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

rule_quota

Integer

  • 功能说明：带宽支持的最大分组规则数。

最小值：0

最大值：1024

bandwidth_rules

Array of BandWidthRules objects

  • 功能说明：带宽规则对象。

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
表4 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 PublicipInfoResp objects

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

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

参数

参数类型

描述

publicip_address

String

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

最大长度：15

publicip_id

String

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

最大长度：36

publicip_type

String

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

  • 取值范围：5_bgp

  • 约束：

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口，所以字段未给定时，默认为5_bgp。

最大长度：36

publicipv6_address

String

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

最大长度：39

ip_version

Integer

  • 功能说明：IP版本信息

  • 取值范围：

    • 4：IPv4

    • 6：开启NAT64能力

请求示例

查询id为3fa5b383-5a73-4dcb-a314-c6128546d855的宽带详情

GET https://{Endpoint}/v1/{project_id}/bandwidths/3fa5b383-5a73-4dcb-a314-c6128546d855

响应示例

状态码：200

查询带宽详情正常返回

{
  "bandwidth" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "enterprise_project_id" : "0",
    "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
    "size" : 5,
    "share_type" : "PER",
    "bandwidth_type" : "bgp",
    "publicip_info" : [ {
      "publicip_id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
      "ip_version" : 4,
      "publicip_type" : "5_bgp",
      "publicip_address" : "161.xx.xx.9"
    } ],
    "name" : "2222",
    "charge_mode" : "bandwidth",
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "status" : "NORMAL",
    "created_at" : "2020-06-03T09:01:11Z",
    "updated_at" : "2020-06-03T09:01:11Z"
  }
}

状态码

状态码

描述

200

查询带宽详情正常返回

错误码

请参见错误码。

父主题： 带宽

相关文档