華為云計算 云知識 批量創(chuàng)建共享帶寬BatchCreateSharedBandwidths
批量創(chuàng)建共享帶寬BatchCreateSharedBandwidths

 

功能介紹

批量創(chuàng)建共享帶寬。

調(diào)試

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

URI

POST /v2.0/{project_id}/batch-bandwidths

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID,獲取項目ID請參見獲取項目ID

請求參數(shù)

表2 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

bandwidth

BatchCreateBandwidthOption object

帶寬對象

表3 BatchCreateBandwidthOption

參數(shù)

是否必選

參數(shù)類型

描述

count

Integer

  • 取值范圍:正整數(shù)

  • 功能說明:批創(chuàng)的共享帶寬的個數(shù)

  • 說明: 如果傳入的參數(shù)為小數(shù)(如 2.2)或者字符類型(如“2”),會自動強制轉(zhuǎn)換為整數(shù)。

  • 約束:表示批量創(chuàng)建的共享帶寬數(shù)目, 該參數(shù)和租戶配額數(shù)目有關,默認配額為5,批創(chuàng)個數(shù)不大于租戶共享帶寬的可用配額。

最小值:1

name

String

  • 取值范圍:1-64,支持數(shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點)

  • 功能說明:帶寬名稱

最小長度:1

最大長度:64

size

Integer

  • 功能說明:帶寬大小。共享帶寬的大小有最小值限制,默認為5M,可能因局點不同而不同。

  • 取值范圍:默認5Mbit/s~2000Mbit/s(具體范圍以各區(qū)域配置為準,請參見控制臺對應頁面顯示)。

  • 約束:如果傳入的參數(shù)為小數(shù)(如 10.2)或者字符類型(如“10”),會自動強制轉(zhuǎn)換為整數(shù)。

  • 注意:調(diào)整帶寬時的最小單位會根據(jù)帶寬范圍不同存在差異。

    • 小于等于300Mbit/s:默認最小單位為1Mbit/s。

    • 300Mbit/s~1000Mbit/s:默認最小單位為50Mbit/s。

    • 大于1000Mbit/s:默認最小單位為500Mbit/s。

public_border_group

String

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

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

  • 約束:共享帶寬只能插入與該字段相同的publicip

最小長度:1

最大長度:64

響應參數(shù)

狀態(tài)碼: 200

表4 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

bandwidths

Array of BatchBandwidthResp objects

批創(chuàng)的帶寬對象的列表

表5 BatchBandwidthResp

參數(shù)

參數(shù)類型

描述

bandwidth_type

String

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

  • 取值范圍:share,bgp,sbgp等。

    • share:共享帶寬

    • bgp:動態(tài)bgp

    • sbgp:靜態(tài)bgp

最小長度:1

最大長度:36

billing_info

String

  • 功能說明:賬單信息,如果billing_info不為空,說明是包周期的帶寬

最小長度:0

最大長度:255

charge_mode

String

  • 功能說明:按流量計費還是按帶寬計費

  • 取值范圍:bandwidth(按帶寬計費),traffic(按流量計費),不返回或者為空時表示是bandwidth。

  • 約束:共享帶寬僅支持按帶寬計費。

枚舉值:

  • bandwidth

  • traffic

  • 95peak_plus

id

String

  • 功能說明:帶寬唯一標識

最大長度:36

name

String

  • 功能說明:帶寬名稱

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

最小長度:1

最大長度:64

publicip_info

Array of PublicipInfoResp objects

share_type

String

  • 功能說明:帶寬類型,標識是否是共享帶寬

  • 取值范圍:WHOLE,PER

    • WHOLE表示共享帶寬

    • PER表示獨享帶寬

枚舉值:

  • WHOLE

  • PER

size

Integer

  • 功能說明:帶寬大小

  • 取值范圍:5Mbit/s~2000Mbit/s(具體范圍以各區(qū)域配置為準,請參見控制臺對應頁面顯示)

tenant_id

String

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

最大長度:36

status

String

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

  • 取值范圍:

    • FREEZED:凍結(jié)

    • NORMAL:正常

枚舉值:

  • FREEZED

  • NORMAL

public_border_group

String

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

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

  • 約束限制:只能綁定與該字段相同的publicip資源

最小長度:1

最大長度:64

表6 PublicipInfoResp

參數(shù)

參數(shù)類型

描述

publicip_address

String

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

最大長度:15

publicip_id

String

  • 功能說明:帶寬對應的EIP或者IPv6端口的唯一標識

最大長度: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

請求示例

批量創(chuàng)建2個大小為10M、名稱為bandwidth123的共享帶寬。

{
  "bandwidth" : {
    "size" : 10,
    "name" : "bandwidth123",
    "count" : 2
  }
}

響應示例

狀態(tài)碼: 200

POST操作正常返回

{
  "bandwidths" : [ {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
    "size" : 10,
    "share_type" : "WHOLE",
    "bandwidth_type" : "share",
    "publicip_info" : [ ],
    "name" : "bandwidth123",
    "charge_mode" : "bandwidth",
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
    "status" : "NORMAL"
  }, {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
    "size" : 10,
    "share_type" : "WHOLE",
    "bandwidth_type" : "share",
    "publicip_info" : [ ],
    "name" : "bandwidth123",
    "charge_mode" : "bandwidth",
    "id" : "d91b0028-6f6b-4478-808a-297b75b6812a",
    "status" : "NORMAL"
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

POST操作正常返回

錯誤碼

請參見錯誤碼。