華為云計算 云知識 查詢帶寬列表ListBandwidths
查詢帶寬列表ListBandwidths
時間: 2023-10-16 15:58:09
猜你想看：
實時語音識別 云服務(wù)器配置 CDN是什么意思 視頻點播加速 什么是云桌面

 

功能介紹

查詢帶寬列表。

調(diào)試

您可以在API Explorer中調(diào)試該接口，支持自動認證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。

URI

GET /v1/{project_id}/bandwidths

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

是

String

項目ID，獲取項目ID請參見獲取項目ID
表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

marker

否

String

  • 功能說明：取值為上一頁數(shù)據(jù)的最后一條記錄的id，為空時為查詢第一頁

最大長度：36

limit

否

Integer

  • 功能說明：每頁返回的個數(shù)

  • 取值范圍：0~intmax

最小值：0

enterprise_project_id

否

String

  • 功能說明：企業(yè)項目ID。可以使用該字段過濾某個企業(yè)項目下的EIP。

  • 取值范圍：最大長度36字節(jié)，帶“-”連字符的UUID格式，或者是字符串“0”?！?”表示默認企業(yè)項目。若需要查詢當(dāng)前用戶所有企業(yè)項目綁定的 彈性公網(wǎng)IP ，請傳參all_granted_eps。

關(guān)于企業(yè)項目ID的獲取及企業(yè)項目特性的詳細信息，請參見《企業(yè)管理用戶指南》。

share_type

否

String

  • 功能說明：帶寬類型，標(biāo)識是否是共享帶寬

  • 取值范圍：WHOLE，PER

    • WHOLE：共享帶寬

    • PER：獨享帶寬

枚舉值：

  • WHOLE

  • PER

請求參數(shù)

無

響應(yīng)參數(shù)

狀態(tài)碼： 200

表3 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

bandwidths

Array of BandwidthResp objects

帶寬列表對象
表4 BandwidthResp

參數(shù)

參數(shù)類型

描述

bandwidth_type

String

  • 功能說明：帶寬類型，共享帶寬默認為share。

  • 取值范圍：share，bgp，sbgp等。

    • share：共享帶寬

    • bgp：動態(tài)bgp

    • sbgp：靜態(tài)bgp

最小長度：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

  • 功能說明：帶寬唯一標(biāo)識

最大長度：36

name

String

  • 功能說明：帶寬名稱

  • 取值范圍：1-64個字符，支持數(shù)字、字母、中文、_(下劃線)、-（中劃線）、.（點）

最小長度：1

最大長度：64

publicip_info

Array of PublicipInfoResp objects

  • 功能說明：帶寬對應(yīng)的彈性 公網(wǎng)IP 信息

  • 約束：WHOLE類型的帶寬支持多個EIP，PER類型的帶寬只能對應(yīng)一個EIP

share_type

String

  • 功能說明：共享帶寬類型，標(biāo)識是否是共享帶寬

  • 取值范圍：PER，WHOLE（PER為獨占帶寬，WHOLE是共享帶寬）。

枚舉值：

  • WHOLE

  • PER

size

Integer

  • 功能說明：帶寬大小

  • 取值范圍：默認1Mbit/s~2000Mbit/s（具體范圍以各區(qū)域配置為準(zhǔn)，請參見控制臺對應(yīng)頁面顯示）。

tenant_id

String

  • 功能說明：用戶所屬租戶ID

最大長度：36

enterprise_project_id

String

  • 企業(yè)項目ID。最大長度36字節(jié)，帶“-”連字符的UUID格式，或者是字符串“0”。

  • 創(chuàng)建彈性公網(wǎng)IP時，給彈性公網(wǎng)IP綁定企業(yè)項目ID。

  • 不指定該參數(shù)時，默認值是 0

關(guān)于企業(yè)項目ID的獲取及企業(yè)項目特性的詳細信息，請參見《企業(yè)管理用戶指南》。

最大長度：36

status

String

  • 功能說明：帶寬的狀態(tài)

  • 取值范圍：

    • FREEZED：凍結(jié)

    • NORMAL：正常

枚舉值：

  • FREEZED

  • NORMAL

enable_bandwidth_rules

Boolean

  • 功能說明：是否開啟企業(yè)級qos

  • 取值范圍：true/false，該字段僅在上海1局點返回

rule_quota

Integer

  • 功能說明：帶寬支持的最大分組規(guī)則數(shù)。（該字段僅在上海1局點返回）

最小值：0

最大值：1024

bandwidth_rules

Array of BandWidthRules objects

  • 功能說明：帶寬規(guī)則對象（該字段僅在上海1局點返回）

created_at

String

  • 功能說明：資源創(chuàng)建時間，UTC時間

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

updated_at

String

  • 功能說明：資源更新時間，UTC時間

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

public_border_group

String

  • 功能說明：表示中心站點資源或者邊緣站點資源

  • 取值范圍： center、邊緣站點名稱

  • 約束：共享帶寬只能綁定與該字段相同的publicip

最小長度：1

最大長度：64
表5 BandWidthRules

參數(shù)

參數(shù)類型

描述

id

String

  • 功能說明：帶寬規(guī)則ID

最大長度：36

name

String

  • 功能說明：帶寬規(guī)則名稱

最小長度：0

最大長度：64

admin_state_up

Boolean

  • 功能說明：配置狀態(tài)，為False時配置不生效。

egress_size

Integer

  • 功能說明：出網(wǎng)帶寬最大值，單位Mbps

  • 取值范圍[0,n]，其中n為所屬帶寬的帶寬大小（size字段）。0表示設(shè)置為最大帶寬

最小值：0

缺省值：0

egress_guarented_size

Integer

  • 功能說明：出網(wǎng)保障帶寬大小，單位Mbps

  • 取值范圍[0,x]，其中x為所屬帶寬剩余的保障額

最小值：0

缺省值：0

publicip_info

Array of PublicipInfoResp objects

  • 功能說明：帶寬對應(yīng)的彈性公網(wǎng)IP信息

  • 約束：WHOLE類型的帶寬支持多個彈性公網(wǎng)IP，PER類型的帶寬只能對應(yīng)一個彈性公網(wǎng)IP
表6 PublicipInfoResp

參數(shù)

參數(shù)類型

描述

publicip_address

String

  • 功能說明：功能說明：EIP或者IPv6端口的地址

最大長度：15

publicip_id

String

  • 功能說明：帶寬對應(yīng)的EIP或者IPv6端口的唯一標(biāo)識

最大長度：36

publicip_type

String

  • 功能說明：EIP的類型

  • 取值范圍：5_bgp（全動態(tài)BGP），5_sbgp（靜態(tài)BGP），5_youxuanbgp（優(yōu)選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

    • 非洲-約翰內(nèi)斯堡：5_bgp

    • 西南-貴陽一：5_sbgp

    • 華北-北京四：5_bgp、5_sbgp

    • 拉美-圣地亞哥：5_bgp

    • 拉美-圣保羅一：5_bgp

    • 拉美-墨西哥城一：5_bgp

    • 拉美-布宜諾斯艾利一：5_bgp

    • 拉美-利馬一：5_bgp

    • 拉美-圣地亞哥二： 5_bgp

  • 約束：

    • 必須是系統(tǒng)具體支持的類型。

    • publicip_id為IPv4端口，所以"type"字段未給定時，默認為5_bgp。

最大長度：36

publicipv6_address

String

  • 功能說明：IPv4時無此字段，IPv6時為申請到的EIP地址

最大長度：39

ip_version

Integer

  • 功能說明：IP版本信息

  • 取值范圍：

    • 4：IPv4

    • 6：開啟NAT64能力

枚舉值：

  • 4

  • 6

請求示例

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

響應(yīng)示例

狀態(tài)碼： 200

GET和PUT操作正常返回

{
  "bandwidths" : [ {
    "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" : "80d5b82e-43b9-4f82-809a-37bec5793bd4",
      "ip_version" : 4,
      "publicip_type" : "5_bgp",
      "publicip_address" : "161.xx.xx.10"
    } ],
    "name" : "ddddd",
    "charge_mode" : "bandwidth",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "id" : "a79fd11a-047b-4f5b-8f12-99c178cc780a",
    "status" : "NORMAL"
  }, {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "enterprise_project_id" : "0",
    "size" : 6,
    "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" : "22212",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "charge_mode" : "bandwidth",
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
    "status" : "NORMAL"
  }, {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "enterprise_project_id" : "0",
    "size" : 5,
    "share_type" : "PER",
    "bandwidth_type" : "bgp",
    "publicip_info" : [ {
      "publicip_id" : "4ca21961-8e52-4ff4-b9c5-af2dcc2c7b50",
      "ip_version" : 4,
      "publicip_type" : "5_bgp",
      "publicip_address" : "161.xx.xx.13"
    } ],
    "name" : "2222",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "charge_mode" : "bandwidth",
    "id" : "f54e0df7-422d-4ab6-8d65-fd436151479c",
    "status" : "NORMAL"
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

GET和PUT操作正常返回

錯誤碼

請參見錯誤碼。

 

查詢帶寬列表ListBandwidths

意見反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會繼續(xù)努力做到更好 反饋提交失?。≌埳院笾卦?！