華為云計算 云知識 申請包周期彈性公網(wǎng)IPCreatePrePaidPublicip
申請包周期彈性公網(wǎng)IPCreatePrePaidPublicip

 

功能介紹

申請包年包月的EIP。

在成功調(diào)用本接口申請包年包月的EIP后:

如果您需要支付訂單,請參考“支付包周期產(chǎn)品訂單”進行支付。若想使用優(yōu)惠券,請將請求中的is_auto_pay字段設(shè)置為false,參考“查詢訂單可用優(yōu)惠券”進行支付,或者在華為云官網(wǎng)頁面使用優(yōu)惠券進行支付。

如果您需要退訂該包周期資源,請參考“退訂包周期資源”。

調(diào)試

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

URI

POST /v2.0/{project_id}/publicips

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

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

請求參數(shù)

表2 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

publicip

CreatePrePaidPublicipOption object

EIP對象

bandwidth

CreatePublicipBandwidthOption object

帶寬對象

extendParam

CreatePrePaidPublicipExtendParamOption object

擴展參數(shù),用于包周期資源申請

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è)管理用戶指南》

缺省值:0

最小長度:0

最大長度:36

表3 CreatePrePaidPublicipOption

參數(shù)

是否必選

參數(shù)類型

描述

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。

最小長度:0

最大長度:36

ip_version

Integer

  • 功能說明:EIP的版本

  • 取值范圍:4、6,IPv6為開啟NAT64能力

  • 約束:

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

    • 不填或空字符串時,默認創(chuàng)建ipv4

缺省值:4

枚舉值:

  • 4

  • 6

alias

String

  • 功能說明:EIP名稱

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

最大長度:64

port_id

String

  • 功能說明:端口id

  • 約束:必須是存在的端口id,如果該端口不存在或端口已綁定EIP則會提示出錯。

最小長度:36

最大長度:36

表4 CreatePublicipBandwidthOption

參數(shù)

是否必選

參數(shù)類型

描述

charge_mode

String

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

  • 取值范圍:bandwidth,traffic,不填或者為空時默認是bandwidth。其中IPv6國外默認是bandwidth,國內(nèi)默認是traffic。

缺省值:bandwidth

枚舉值:

  • bandwidth

  • traffic

id

String

  • 功能說明:帶寬ID,創(chuàng)建WHOLE類型帶寬的EIP時可以指定之前的共享帶寬創(chuàng)建

  • 取值范圍:WHOLE類型的帶寬ID

最大長度:36

name

String

  • 功能說明:帶寬名稱

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

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

最小長度:1

最大長度:64

share_type

String

  • 功能說明:帶寬類型

  • 取值范圍:PER,WHOLE(PER為獨占帶寬,WHOLE是共享帶寬)。

  • 約束:該字段為WHOLE時,必須指定帶寬ID。

枚舉值:

  • WHOLE

  • PER

size

Integer

  • 功能說明:帶寬大小

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

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

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

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

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

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

表5 CreatePrePaidPublicipExtendParamOption

參數(shù)

是否必選

參數(shù)類型

描述

charge_mode

String

  • 功能說明:付費方式(預(yù)付費、按需付費;預(yù)付費,即包周期付費)

  • 取值范圍:

    • prePaid -預(yù)付費,即包年包月;

    • postPaid-后付費,即按需付費;

  • 后付費的場景下,extendParam的其他字段都會被忽略。

缺省值:postPaid

枚舉值:

  • prePaid

  • postPaid

period_type

String

  • 功能說明:訂購資源的周期類型(包年、包月等)

  • 取值范圍:

    • month-月

    • year-年

  • 約束:如果用包周期共享帶寬創(chuàng)建時(即攜帶共享帶寬id創(chuàng)建EIP)此字段可不填。付費方式是預(yù)付費且不是使用共享帶寬創(chuàng)建IP時,該字段必選; 使用共享帶寬創(chuàng)建IP時,帶寬資源到期時間與IP的到期時間相同。

枚舉值:

  • month

  • year

period_num

Integer

  • 功能說明:訂購周期數(shù)

  • 取值范圍:(后續(xù)會隨運營策略變化)

    • period_type為month時,為[1,9]

    • period_type為year時,為[1,3]

  • 約束:同period_type約束。

最小值:1

最大值:9

is_auto_renew

Boolean

  • 功能說明:是否自動續(xù)訂

  • 取值范圍: false:不自動續(xù)訂 true:自動續(xù)訂

  • 約束:到期后,默認自動續(xù)訂1個月(自動續(xù)訂時間后續(xù)可能會變化),詳情可聯(lián)系客服咨詢。

缺省值:false

is_auto_pay

Boolean

  • 功能說明:下單訂購后,是否自動從客戶的賬戶中支付

  • 取值范圍:

    • true:自動支付,從賬戶余額自動扣費

    • false:只提交訂單不支付,需要客戶手動去支付

  • 約束:自動支付時,只能使用賬戶的現(xiàn)金支付;如果要使用代金券,請選擇不自動支付,然后在用戶費用中心,選擇代金券支付。

缺省值:false

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

publicip

PublicipCreateResp object

EIP對象(后付費場景返回對象)

order_id

String

訂單號(預(yù)付費場景返回該字段)

最小長度:0

最大長度:36

publicip_id

String

EIP的ID(預(yù)付費場景返回該字段)

最小長度:0

最大長度:36

表7 PublicipCreateResp

參數(shù)

參數(shù)類型

描述

bandwidth_size

Integer

  • 功能說明:帶寬大小,單位為Mbit/s。

create_time

String

  • 功能說明:EIP申請時間(UTC時間)

id

String

  • 功能說明:EIP唯一標識

最大長度:36

public_ip_address

String

  • 功能說明:IPv4時是申請到的EIP地址,IPv6時是IPv6地址對應(yīng)的IPv4地址

最大長度:15

status

String

  • 功能說明: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

  • 功能說明:項目ID

最大長度:36

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

public_ipv6_address

String

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

最大長度:39

ip_version

Integer

  • 功能說明:IP版本信息,取值范圍是4和6,IPv6為開啟NAT64能力

枚舉值:

  • 4

  • 6

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

alias

String

  • 功能說明:彈性公網(wǎng)IP名稱

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

最大長度:64

請求示例

  • 創(chuàng)建包周期獨占帶寬和EIP,大小1Mb,周期1個月。不自動續(xù)費,不自動扣費。

    {
      "publicip" : {
        "type" : "5_bgp"
      },
      "bandwidth" : {
        "name" : "bw_666",
        "size" : 1,
        "share_type" : "PER",
        "charge_mode" : "bandwidth"
      },
      "extendParam" : {
        "charge_mode" : "prePaid",
        "period_type" : "month",
        "period_num" : 1,
        "is_auto_renew" : false,
        "is_auto_pay" : true
      }
    }
  • 創(chuàng)建按需的IP、帶寬;extendParam擴展字段,不填即可。

    {
      "publicip" : {
        "type" : "5_bgp"
      },
      "bandwidth" : {
        "name" : "bw_666",
        "size" : 1,
        "share_type" : "PER",
        "charge_mode" : "bandwidth"
      }
    }

響應(yīng)示例

狀態(tài)碼: 200

POST操作正常返回

{
  "publicip_id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
  "order_id" : "CS1802081410IMDRN",
  "publicip" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "bandwidth_size" : 0,
    "public_ip_address" : "161.17.101.7",
    "create_time" : "2015-07-16 04:10:52",
    "ip_version" : 4,
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "type" : "5_bgp",
    "status" : "PENDING_CREATE",
    "enterprise_project_id" : "0"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

POST操作正常返回

錯誤碼

請參見錯誤碼。