華為云計(jì)算 云知識(shí) 申請(qǐng)彈性公網(wǎng)IPCreatePublicip
申請(qǐng)彈性公網(wǎng)IPCreatePublicip
時(shí)間: 2023-10-12 15:27:27
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

功能介紹

申請(qǐng)EIP，支持IPv4和IPv6。 彈性公網(wǎng)IP （ Elastic IP ）提供獨(dú)立的 公網(wǎng)IP 資源，包括公網(wǎng)IP地址與公網(wǎng)出口帶寬服務(wù)?？梢耘c彈性 云服務(wù)器 、 裸金屬服務(wù)器 、虛擬IP、 彈性負(fù)載均衡 、 NAT網(wǎng)關(guān) 等資源靈活地綁定及解綁。擁有多種靈活的計(jì)費(fèi)方式，可以滿(mǎn)足各種業(yè)務(wù)場(chǎng)景的需要。

調(diào)試

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

URI

POST /v1/{project_id}/publicips

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

project_id

是

String

項(xiàng)目ID，獲取項(xiàng)目ID請(qǐng)參見(jiàn)獲取項(xiàng)目ID

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

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

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

bandwidth

是

CreatePublicipBandwidthOption object

帶寬對(duì)象

enterprise_project_id

否

String

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

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

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

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

缺省值：0

最小長(zhǎng)度：0

最大長(zhǎng)度：36

publicip

是

CreatePublicipOption object

彈性公網(wǎng)IP對(duì)象
表3 CreatePublicipBandwidthOption

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

charge_mode

否

String

  • 功能說(shuō)明：按流量計(jì)費(fèi)還是按帶寬計(jì)費(fèi)。

  • 取值范圍：bandwidth，traffic，不填或者為空時(shí)默認(rèn)是bandwidth。其中IPv6國(guó)外默認(rèn)是bandwidth，國(guó)內(nèi)默認(rèn)是traffic。

缺省值：bandwidth

枚舉值：

  • bandwidth

  • traffic

id

否

String

  • 功能說(shuō)明：帶寬ID,創(chuàng)建WHOLE類(lèi)型帶寬的EIP時(shí)可以指定之前的共享帶寬創(chuàng)建

  • 取值范圍：WHOLE類(lèi)型的帶寬ID

最大長(zhǎng)度：36

name

否

String

  • 功能說(shuō)明：帶寬名稱(chēng)

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

  • 約束：如果share_type是PER，該參數(shù)必須帶,如果share_type是WHOLE并且id有值，該參數(shù)會(huì)忽略。

最小長(zhǎng)度：1

最大長(zhǎng)度：64

share_type

是

String

  • 功能說(shuō)明：帶寬類(lèi)型

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

  • 約束：該字段為WHOLE時(shí)，必須指定帶寬ID。

枚舉值：

  • WHOLE

  • PER

size

否

Integer

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

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

  • 約束：share_type是PER，該參數(shù)必須帶，如果share_type是WHOLE并且id有值，該參數(shù)會(huì)忽略。

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

    • 小于等于300Mbit/s：默認(rèn)最小單位為1Mbit/s。

    • 300Mbit/s~1000Mbit/s：默認(rèn)最小單位為50Mbit/s。

    • 大于1000Mbit/s：默認(rèn)最小單位為500Mbit/s。
表4 CreatePublicipOption

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

ip_address

否

String

  • 功能說(shuō)明：希望申請(qǐng)到的EIP的地址，不指定時(shí)由系統(tǒng)自動(dòng)分配

  • 約束：必須為IPv4地址格式，且必須在可用地址池范圍內(nèi)

最大長(zhǎng)度：15

type

是

String

  • 功能說(shuō)明：EIP的類(lèi)型

  • 取值范圍：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)具體支持的類(lèi)型。

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

ip_version

否

Integer

  • 功能說(shuō)明：彈性公網(wǎng)IP的版本

  • 取值范圍：4、6，ipv6表示開(kāi)啟NAT64能力

  • 約束：

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

    • 不填或空字符串時(shí)，默認(rèn)創(chuàng)建ipv4

缺省值：4

枚舉值：

  • 4

  • 6

alias

否

String

  • 功能說(shuō)明：彈性公網(wǎng)IP名稱(chēng)

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

最大長(zhǎng)度：64

port_id

否

String

  • 功能說(shuō)明：端口id

  • 約束：必須是存在的端口id，如果該端口不存在或端口已綁定EIP則會(huì)提示出錯(cuò)。

最小長(zhǎng)度：36

最大長(zhǎng)度：36

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

狀態(tài)碼： 200

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

參數(shù)

參數(shù)類(lèi)型

描述

publicip

PublicipCreateResp object

彈性公網(wǎng)IP對(duì)象
表6 PublicipCreateResp

參數(shù)

參數(shù)類(lèi)型

描述

bandwidth_size

Integer

  • 功能說(shuō)明：帶寬大小，單位為Mbit/s。

create_time

String

  • 功能說(shuō)明：EIP申請(qǐng)時(shí)間（UTC時(shí)間）

id

String

  • 功能說(shuō)明：EIP唯一標(biāo)識(shí)

最大長(zhǎng)度：36

public_ip_address

String

  • 功能說(shuō)明：IPv4時(shí)是申請(qǐng)到的EIP地址，IPv6時(shí)是IPv6地址對(duì)應(yīng)的IPv4地址

最大長(zhǎng)度：15

status

String

  • 功能說(shuō)明：EIP的狀態(tài)

  • 取值范圍：

    • FREEZED：凍結(jié)

    • BIND_ERROR：綁定失敗

    • BINDING：綁定中

    • PENDING_DELETE：釋放中

    • PENDING_CREATE：創(chuàng)建中

    • NOTIFYING：創(chuàng)建中

    • NOTIFY_DELETE：釋放中

    • PENDING_UPDATE：更新中

    • DOWN：未綁定

    • ACTIVE：綁定

    • ELB：綁定ELB

    • VPN：綁定VPN

    • ERROR：失敗

枚舉值：

  • FREEZED

  • BIND_ERROR

  • BINDING

  • PENDING_DELETE

  • PENDING_CREATE

  • NOTIFYING

  • NOTIFY_DELETE

  • PENDING_UPDATE

  • DOWN

  • ACTIVE

  • ELB

  • VPN

  • ERROR

tenant_id

String

  • 功能說(shuō)明：項(xiàng)目ID

最大長(zhǎng)度：36

type

String

  • 功能說(shuō)明：EIP的類(lèi)型

  • 取值范圍：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)具體支持的類(lèi)型。

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

最大長(zhǎng)度：36

public_ipv6_address

String

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

最大長(zhǎng)度：39

ip_version

Integer

  • 功能說(shuō)明：IP版本信息，取值范圍是4和6，IPv6為開(kāi)啟NAT64能力

枚舉值：

  • 4

  • 6

enterprise_project_id

String

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

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

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

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

最大長(zhǎng)度：36

alias

String

  • 功能說(shuō)明：彈性公網(wǎng)IP名稱(chēng)

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

最大長(zhǎng)度：64

請(qǐng)求示例

  • 創(chuàng)建IPv4 EIP獨(dú)享帶寬。

    {
  "bandwidth" : {
    "size" : 10,
    "share_type" : "PER",
    "name" : "bandwidth123"
  },
  "publicip" : {
    "ip_version" : 4,
    "type" : "5_bgp"
  }
}

  • 創(chuàng)建IPv6 EIP獨(dú)享帶寬。

    {
  "bandwidth" : {
    "size" : 5,
    "share_type" : "WHOLE",
    "name" : "bandwidth123"
  },
  "publicip" : {
    "ip_version" : 6,
    "type" : "5_bgp"
  }
}

響應(yīng)示例

狀態(tài)碼： 200

POST操作正常返回

{
  "publicip" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "bandwidth_size" : 0,
    "public_ip_address" : "161.xx.xx.7",
    "ip_version" : 4,
    "create_time" : "2015-07-16 04:10:52",
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "type" : "5_bgp",
    "status" : "PENDING_CREATE"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

POST操作正常返回

錯(cuò)誤碼

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

 

猜你喜歡
申請(qǐng)彈性公網(wǎng)IPCreatePublicip

意見(jiàn)反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失??！請(qǐng)稍后重試！