功能介紹
申請包年包月的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
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
項目ID,獲取項目ID請參見獲取項目ID |
請求參數(shù)
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
publicip |
是 |
EIP對象 |
|
bandwidth |
是 |
帶寬對象 |
|
extendParam |
否 |
擴展參數(shù),用于包周期資源申請 |
|
enterprise_project_id |
否 |
String |
關(guān)于企業(yè)項目ID的獲取及企業(yè)項目特性的詳細信息,請參見《企業(yè)管理用戶指南》。 缺省值:0 最小長度:0 最大長度:36 |
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
type |
是 |
String |
最小長度:0 最大長度:36 |
ip_version |
否 |
Integer |
缺省值:4 枚舉值:
|
alias |
否 |
String |
最大長度:64 |
port_id |
否 |
String |
最小長度:36 最大長度:36 |
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
charge_mode |
否 |
String |
缺省值:bandwidth 枚舉值:
|
id |
否 |
String |
最大長度:36 |
name |
否 |
String |
最小長度:1 最大長度:64 |
share_type |
是 |
String |
枚舉值:
|
size |
否 |
Integer |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
charge_mode |
否 |
String |
缺省值:postPaid 枚舉值:
|
period_type |
否 |
String |
枚舉值:
|
period_num |
否 |
Integer |
最小值:1 最大值:9 |
is_auto_renew |
否 |
Boolean |
缺省值:false |
is_auto_pay |
否 |
Boolean |
缺省值:false |
響應(yīng)參數(shù)
狀態(tài)碼: 200
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
publicip |
EIP對象(后付費場景返回對象) |
|
order_id |
String |
訂單號(預(yù)付費場景返回該字段) 最小長度:0 最大長度:36 |
publicip_id |
String |
EIP的ID(預(yù)付費場景返回該字段) 最小長度:0 最大長度:36 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
bandwidth_size |
Integer |
|
create_time |
String |
|
id |
String |
最大長度:36 |
public_ip_address |
String |
最大長度:15 |
status |
String |
枚舉值:
|
tenant_id |
String |
最大長度:36 |
type |
String |
最大長度:36 |
public_ipv6_address |
String |
最大長度:39 |
ip_version |
Integer |
枚舉值:
|
enterprise_project_id |
String |
關(guān)于企業(yè)項目ID的獲取及企業(yè)項目特性的詳細信息,請參見《企業(yè)管理用戶指南》。 最大長度:36 |
alias |
String |
最大長度: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操作正常返回 |
錯誤碼
請參見錯誤碼。