文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 带宽/ 查询带宽列表(老接口)
更新时间:2024-10-15 GMT+08:00
分享

查询带宽列表(老接口)

功能介绍

查询带宽列表

调用方法

请参见如何调用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

  • 功能说明:根据宽带名称模糊查询过滤

tenant_id

String

  • 功能说明:根据tenant_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 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

  • 功能说明:"公网弹性公网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}/eip-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",
    "tenant_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
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.eip.v3.region.EipRegion;
import com.huaweicloud.sdk.eip.v3.*;
import com.huaweicloud.sdk.eip.v3.model.*;


public class ListEipBandwidthsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        ListEipBandwidthsRequest request = new ListEipBandwidthsRequest();
        request.withLimit("<limit>");
        request.withMarker("<marker>");
        request.withId("<id>");
        request.withBandwidthType("<bandwidth_type>");
        request.withName("<name>");
        request.withNameLike("<name_like>");
        request.withTenantId("<tenant_id>");
        request.withIngressSize("<ingress_size>");
        request.withAdminState("<admin_state>");
        request.withBillingInfo("<billing_info>");
        request.withTags("<tags>");
        request.withEnableBandwidthRules("<enable_bandwidth_rules>");
        request.withRuleQuota(<rule_quota>);
        request.withPublicBorderGroup("<public_border_group>");
        request.withChargeMode("<charge_mode>");
        request.withSize("<size>");
        request.withType("<type>");
        try {
            ListEipBandwidthsResponse response = client.listEipBandwidths(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v3.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = EipClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EipRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListEipBandwidthsRequest()
        request.limit = "<limit>"
        request.marker = "<marker>"
        request.id = "<id>"
        request.bandwidth_type = "<bandwidth_type>"
        request.name = "<name>"
        request.name_like = "<name_like>"
        request.tenant_id = "<tenant_id>"
        request.ingress_size = "<ingress_size>"
        request.admin_state = "<admin_state>"
        request.billing_info = "<billing_info>"
        request.tags = "<tags>"
        request.enable_bandwidth_rules = "<enable_bandwidth_rules>"
        request.rule_quota = <rule_quota>
        request.public_border_group = "<public_border_group>"
        request.charge_mode = "<charge_mode>"
        request.size = "<size>"
        request.type = "<type>"
        response = client.list_eip_bandwidths(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListEipBandwidthsRequest{}
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	bandwidthTypeRequest:= "<bandwidth_type>"
	request.BandwidthType = &bandwidthTypeRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	nameLikeRequest:= "<name_like>"
	request.NameLike = &nameLikeRequest
	tenantIdRequest:= "<tenant_id>"
	request.TenantId = &tenantIdRequest
	ingressSizeRequest:= "<ingress_size>"
	request.IngressSize = &ingressSizeRequest
	adminStateRequest:= "<admin_state>"
	request.AdminState = &adminStateRequest
	billingInfoRequest:= "<billing_info>"
	request.BillingInfo = &billingInfoRequest
	tagsRequest:= "<tags>"
	request.Tags = &tagsRequest
	enableBandwidthRulesRequest:= "<enable_bandwidth_rules>"
	request.EnableBandwidthRules = &enableBandwidthRulesRequest
	ruleQuotaRequest:= int32(<rule_quota>)
	request.RuleQuota = &ruleQuotaRequest
	publicBorderGroupRequest:= "<public_border_group>"
	request.PublicBorderGroup = &publicBorderGroupRequest
	chargeModeRequest:= "<charge_mode>"
	request.ChargeMode = &chargeModeRequest
	sizeRequest:= "<size>"
	request.Size = &sizeRequest
	typeRequest:= "<type>"
	request.Type = &typeRequest
	response, err := client.ListEipBandwidths(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码

相关文档