功能介绍
申请包年包月的EIP。
在成功调用本接口申请包年包月的EIP后:
如果您需要支付订单,请参考“支付包周期产品订单”进行支付。若想使用优惠券,请将请求中的is_auto_pay字段设置为false,参考“查询订单可用优惠券”进行支付,或者在华为云官网页面使用优惠券进行支付。
如果您需要退订该包周期资源,请参考“退订包周期资源”。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2.0/{project_id}/publicips
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
publicip |
是 |
EIP对象 |
|
bandwidth |
是 |
带宽对象 |
|
extendParam |
否 |
扩展参数,用于包周期资源申请 |
|
ent erp rise_project_id |
否 |
String |
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 缺省值:0 最小长度:0 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
最小长度:0 最大长度:36 |
ip_version |
否 |
Integer |
缺省值:4 枚举值:
|
alias |
否 |
String |
最大长度:64 |
port_id |
否 |
String |
最小长度:36 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
charge_mode |
否 |
String |
缺省值:bandwidth 枚举值:
|
id |
否 |
String |
最大长度:36 |
name |
否 |
String |
最小长度:1 最大长度:64 |
share_type |
是 |
String |
枚举值:
|
size |
否 |
Integer |
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
charge_mode |
否 |
String |
缺省值:postPaid 枚举值:
|
period_type |
否 |
String |
枚举值:
|
period_num |
否 |
Integer |
最小值:1 最大值:9 |
is_auto_renew |
否 |
Boolean |
缺省值:false |
is_auto_pay |
否 |
Boolean |
缺省值:false |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
publicip |
EIP对象(后付费场景返回对象) |
|
order_id |
String |
订单号(预付费场景返回该字段) 最小长度:0 最大长度:36 |
publicip_id |
String |
EIP的ID(预付费场景返回该字段) 最小长度:0 最大长度:36 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 最大长度:36 |
alias |
String |
最大长度:64 |
请求示例
-
创建包周期独占带宽和EIP,大小1Mb,周期1个月。不自动续费,不自动扣费。
{ "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 } }
-
创建按需的IP、带宽;extendParam扩展字段,不填即可。
{ "publicip" : { "type" : "5_bgp" }, "bandwidth" : { "name" : "bw_666", "size" : 1, "share_type" : "PER", "charge_mode" : "bandwidth" } }
响应示例
状态码: 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" } }
状态码
状态码 |
描述 |
---|---|
200 |
POST操作正常返回 |
错误码
请参见错误码。