華為云計(jì)算 云知識(shí) 共享帶寬插入彈性公網(wǎng)IPAddPublicipsIntoSharedBandwidth
共享帶寬插入彈性公網(wǎng)IPAddPublicipsIntoSharedBandwidth

 

功能介紹

共享帶寬插入EIP。

接口約束

在共享帶寬中批量插入EIP時(shí),一次可批量操作100個(gè)EIP。

調(diào)試

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

URI

POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID,獲取項(xiàng)目ID請(qǐng)參見獲取項(xiàng)目ID

bandwidth_id

String

帶寬唯一標(biāo)識(shí)

請(qǐng)求參數(shù)

表2 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

bandwidth

AddPublicipsIntoSharedBandwidthOption object

帶寬對(duì)象

表3 AddPublicipsIntoSharedBandwidthOption

參數(shù)

是否必選

參數(shù)類型

描述

publicip_info

Array of InsertPublicipInfo objects

  • 功能說(shuō)明:要插入共享帶寬的EIP信息或者IPv6端口

  • 約束:WHOLE類型的帶寬支持多個(gè)EIP或者IPv6端口,跟租戶的配額相關(guān),默認(rèn)一個(gè)共享帶寬的配額為20

表4 InsertPublicipInfo

參數(shù)

是否必選

參數(shù)類型

描述

publicip_type

String

  • 功能說(shuō)明:EIP的類型

  • 取值范圍:5_bgp(全動(dòng)態(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

    • 中國(guó)-香港:5_bgp、5_youxuanbgp

    • 亞太-曼谷:5_bgp

    • 亞太-新加坡:5_bgp

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

    • 西南-貴陽(yáng)一:5_sbgp

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

    • 拉美-圣地亞哥:5_bgp

    • 拉美-圣保羅一:5_bgp

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

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

    • 拉美-利馬一:5_bgp

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

  • 約束:

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

    • publicip_id為IPv4端口,所以"type"字段未給定時(shí),默認(rèn)為5_bgp。

最大長(zhǎng)度:36

publicip_id

String

  • 功能說(shuō)明:帶寬對(duì)應(yīng)的EIP或者IPv6端口PORT的唯一標(biāo)識(shí)

最大長(zhǎng)度:36

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

bandwidth

BandwidthRespInsert object

帶寬對(duì)象

表6 BandwidthRespInsert

參數(shù)

參數(shù)類型

描述

bandwidth_type

String

  • 功能說(shuō)明:帶寬類型,共享帶寬默認(rèn)為share。

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

    • share:共享帶寬

    • bgp:動(dòng)態(tài)bgp

    • sbgp:靜態(tài)bgp

最小長(zhǎng)度:1

最大長(zhǎng)度:36

charge_mode

String

  • 功能說(shuō)明:按流量計(jì)費(fèi),按帶寬計(jì)費(fèi)還是按增強(qiáng)型95計(jì)費(fèi)。

  • 取值范圍:bandwidth(按帶寬計(jì)費(fèi)),traffic(按流量計(jì)費(fèi)),95peak_plus(按增強(qiáng)型95計(jì)費(fèi)),不返回或者為空時(shí)表示是bandwidth。

  • 約束:只有共享帶寬支持95peak_plus(按增強(qiáng)型95計(jì)費(fèi)),按增強(qiáng)型95計(jì)費(fèi)時(shí)需要指定保底百分比,默認(rèn)是20%。

枚舉值:

  • bandwidth

  • traffic

  • 95peak_plus

id

String

  • 功能說(shuō)明:帶寬唯一標(biāo)識(shí)

最大長(zhǎng)度:36

name

String

  • 功能說(shuō)明:帶寬名稱

  • 取值范圍:1-64個(gè)字符,支持?jǐn)?shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點(diǎn))

最小長(zhǎng)度:1

最大長(zhǎng)度:64

publicip_info

Array of PublicipInfoResp objects

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

  • 約束:WHOLE類型的帶寬支持多個(gè)彈性 公網(wǎng)IP ,PER類型的帶寬只能對(duì)應(yīng)一個(gè)彈性公網(wǎng)IP

billing_info

String

  • 功能說(shuō)明:賬單信息,如果billinginfo不為空,說(shuō)明是包周期的帶寬

最小長(zhǎng)度:0

最大長(zhǎng)度:255

share_type

String

  • 功能說(shuō)明:帶寬類型,標(biāo)識(shí)是否是共享帶寬

  • 取值范圍:WHOLE,PER

    • WHOLE表示共享帶寬

    • PER表示獨(dú)享帶寬

枚舉值:

  • WHOLE

  • PER

size

Integer

  • 功能說(shuō)明:帶寬大小。

  • 取值范圍:默認(rèn)5Mbit/s~2000Mbit/s(具體范圍以各區(qū)域配置為準(zhǔn),請(qǐng)參見控制臺(tái)對(duì)應(yīng)頁(yè)面顯示)。

tenant_id

String

功能說(shuō)明:用戶所屬租戶ID

最大長(zhǎng)度:36

enterprise_project_id

String

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

  • 創(chuàng)建共享帶寬時(shí),給共享帶寬綁定企業(yè)項(xiàng)目ID。

  • 不指定該參數(shù)時(shí),默認(rèn)值是 0

關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參見《企業(yè)管理用戶指南》

最大長(zhǎng)度:36

status

String

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

  • 取值范圍:

    • FREEZED:凍結(jié)

    • NORMAL:正常

枚舉值:

  • FREEZED

  • NORMAL

enable_bandwidth_rules

Boolean

  • 功能說(shuō)明:是否開啟企業(yè)級(jí)qos

  • 取值范圍:true/false

rule_quota

Integer

  • 功能說(shuō)明:帶寬支持的最大分組規(guī)則數(shù)。

最小值:0

最大值:1024

bandwidth_rules

Array of BandWidthRules objects

  • 功能說(shuō)明:帶寬規(guī)則對(duì)象

表7 BandWidthRules

參數(shù)

參數(shù)類型

描述

id

String

  • 功能說(shuō)明:帶寬規(guī)則ID

最大長(zhǎng)度:36

name

String

  • 功能說(shuō)明:帶寬規(guī)則名稱

最小長(zhǎng)度:0

最大長(zhǎng)度:64

admin_state_up

Boolean

  • 功能說(shuō)明:配置狀態(tài),為False時(shí)配置不生效。

egress_size

Integer

  • 功能說(shuō)明:出網(wǎng)帶寬最大值,單位Mbps

  • 取值范圍[0,n],其中n為所屬帶寬的帶寬大?。╯ize字段)。0表示設(shè)置為最大帶寬

最小值:0

缺省值:0

egress_guarented_size

Integer

  • 功能說(shuō)明:出網(wǎng)保障帶寬大小,單位Mbps

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

最小值:0

缺省值:0

publicip_info

Array of PublicipInfoResp objects

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

  • 約束:WHOLE類型的帶寬支持多個(gè)彈性公網(wǎng)IP,PER類型的帶寬只能對(duì)應(yīng)一個(gè)彈性公網(wǎng)IP

表8 PublicipInfoResp

參數(shù)

參數(shù)類型

描述

publicip_address

String

  • 功能說(shuō)明:功能說(shuō)明:EIP或者IPv6端口的地址

最大長(zhǎng)度:15

publicip_id

String

  • 功能說(shuō)明:帶寬對(duì)應(yīng)的EIP或者IPv6端口的唯一標(biāo)識(shí)

最大長(zhǎng)度:36

publicip_type

String

  • 功能說(shuō)明:EIP的類型

  • 取值范圍:5_bgp(全動(dòng)態(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

    • 中國(guó)-香港:5_bgp、5_youxuanbgp

    • 亞太-曼谷:5_bgp

    • 亞太-新加坡:5_bgp

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

    • 西南-貴陽(yáng)一:5_sbgp

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

    • 拉美-圣地亞哥:5_bgp

    • 拉美-圣保羅一:5_bgp

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

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

    • 拉美-利馬一:5_bgp

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

  • 約束:

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

    • publicip_id為IPv4端口,所以"type"字段未給定時(shí),默認(rèn)為5_bgp。

最大長(zhǎng)度:36

publicipv6_address

String

  • 功能說(shuō)明:IPv4時(shí)無(wú)此字段,IPv6時(shí)為申請(qǐng)到的EIP地址

最大長(zhǎng)度:39

ip_version

Integer

  • 功能說(shuō)明:IP版本信息

  • 取值范圍:

    • 4:IPv4

    • 6:開啟NAT64能力

枚舉值:

  • 4

  • 6

請(qǐng)求示例

將id為d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的彈性公網(wǎng)IP插入共享帶寬,支持多個(gè)彈性公網(wǎng)IP插入共享帶寬。

{
  "bandwidth" : {
    "publicip_info" : [ {
      "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a",
      "publicip_type" : "5_dualStack"
    }, {
      "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
    } ]
  }
}

響應(yīng)示例

狀態(tài)碼: 200

POST操作正常返回

{
  "bandwidth" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
    "size" : 10,
    "share_type" : "WHOLE",
    "bandwidth_type" : "share",
    "publicip_info" : [ {
      "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a",
      "ip_version" : 4,
      "publicip_type" : "5_dualStack",
      "publicip_address" : "::ffff:192.168.89.9"
    }, {
      "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f",
      "ip_version" : 4,
      "publicip_type" : "5_bgp",
      "publicip_address" : "99.xx.xx.82"
    } ],
    "name" : "bandwidth123",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "charge_mode" : "bandwidth",
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

POST操作正常返回

錯(cuò)誤碼

請(qǐng)參見錯(cuò)誤碼。