文档首页/ 弹性公网IP EIP/ API参考/ API/ 弹性公网IP/ 申请弹性公网IP(包年/包月) - CreatePrePaidPublicip
更新时间：2025-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

申请弹性公网IP(包年/包月) - CreatePrePaidPublicip

功能介绍

1、申请包年包月的弹性公网IP。

2、在成功调用本接口申请包年包月的弹性公网IP后：

如果您需要支付订单，请参考“支付包周期产品订单”进行支付。

如果您想使用优惠券，请将请求中的is_auto_pay字段设置为false，参考“查询订单可用优惠券”进行支付，或者在华为云官网页面使用优惠券进行支付。

如果您需要退订该包周期资源，请参考“退订包周期资源”。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    eip:publicIps:create

    Write

    publicip *

    -
    • vpc:publicIps:create

    -

    -

    g:EnterpriseProjectId

URI

POST /v2.0/{project_id}/publicips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip

是

CreatePrePaidPublicipOption object

弹性公网IP对象

bandwidth

是

CreatePrePaidPublicipBandwidthOption object

带宽对象

extendParam

否

CreatePrePaidPublicipExtendParamOption object

扩展参数，用于包周期资源申请

enterprise_project_id

否

String

  • 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。

  • 不指定该参数时，默认值是 0

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

缺省值：0

最小长度：0

最大长度：36
表3 CreatePrePaidPublicipOption

参数

是否必选

参数类型

描述

type

是

String

  • 功能说明：弹性公网IP的类型

  • 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选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

    • 非洲-约翰内斯堡：5_bgp

    • 西南-贵阳一：5_sbgp

    • 华北-北京四：5_bgp、5_sbgp

    • 拉美-圣地亚哥：5_bgp

    • 拉美-圣保罗一：5_bgp

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

    • 拉美-布宜诺斯艾利一：5_bgp

    • 拉美-利马一：5_bgp

    • 拉美-圣地亚哥二： 5_bgp

  • 约束：

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。

最小长度：0

最大长度：36

ip_version

否

Integer

  • 功能说明：弹性公网IP的版本

  • 取值范围：4、6，IPv6为开启NAT64能力

  • 约束：

    • 必须是系统具体支持的类型

    • 不填或空字符串时，默认创建ipv4

缺省值：4

alias

否

String

  • 功能说明：弹性公网IP名称

  • 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最大长度：64

port_id

否

String

  • 功能说明：端口id

  • 约束：必须是存在的端口id，如果该端口不存在或端口已绑定弹性公网IP则会提示出错。

最小长度：36

最大长度：36
表4 CreatePrePaidPublicipBandwidthOption

参数

是否必选

参数类型

描述

charge_mode

否

String

  • 功能说明：包年包月只支持按带宽计费模式。

  • 取值范围：bandwidth

缺省值：bandwidth

id

否

String

  • 功能说明：带宽ID，创建WHOLE类型带宽的弹性公网IP时可以指定之前的共享带宽创建

  • 取值范围：WHOLE类型的带宽ID

最大长度：36

name

否

String

  • 功能说明：带宽名称

  • 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

  • 约束：如果share_type是PER，该参数必须带，如果share_type是WHOLE并且id有值，该参数会忽略。

最小长度：1

最大长度：64

share_type

是

String

  • 功能说明：带宽类型

  • 取值范围：PER，WHOLE（PER为独占带宽，WHOLE是共享带宽）。

  • 约束：该字段为WHOLE时，必须指定带宽ID。

size

否

Integer

  • 功能说明：带宽大小，当未输入带宽id，创建独占带宽时，该字段为必输

  • 取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。

  • 约束：share_type是PER，该参数必须带，如果share_type是WHOLE并且id有值，该参数会忽略。

  • 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。

    • 小于等于300Mbit/s：默认最小单位为1Mbit/s。

    • 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。

    • 大于1000Mbit/s：默认最小单位为500Mbit/s。
表5 CreatePrePaidPublicipExtendParamOption

参数

是否必选

参数类型

描述

charge_mode

否

String

  • 功能说明：付费方式（预付费、按需付费；预付费，即包周期付费）

  • 取值范围：

    • prePaid -预付费，即包年包月；

    • postPaid-后付费，即按需付费；

  • 后付费的场景下，extendParam的其他字段都会被忽略。

缺省值：postPaid

period_type

否

String

  • 功能说明：订购资源的周期类型（包年、包月等）

  • 取值范围：

    • month-月

    • year-年

  • 约束：如果用包周期共享带宽创建时（即携带共享带宽id创建弹性公网IP）此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时，该字段必选；

使用共享带宽创建IP时，带宽资源到期时间与IP的到期时间相同。

period_num

否

Integer

  • 功能说明：订购周期数

  • 取值范围：(后续会随运营策略变化)

    • period_type为month时，为[1,9]

    • period_type为year时，为[1,3]

  • 约束：同period_type约束。

最小值：1

最大值：9

is_auto_renew

否

Boolean

  • 功能说明：是否自动续订

  • 取值范围：

  • 约束：到期后，默认自动续订1个月（自动续订时间后续可能会变化），详情可联系客服咨询。

false：不自动续订

true：自动续订

缺省值：false

is_auto_pay

否

Boolean

  • 功能说明：下单订购后，是否自动从客户的账户中支付

  • 取值范围：

    • true：自动支付，从账户余额自动扣费

    • false：只提交订单不支付，需要客户手动去支付

  • 约束：自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。

缺省值：false

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

publicip

PublicipCreateResp object

弹性公网IP对象（后付费场景返回对象）

order_id

String

订单号（预付费场景返回该字段）

最小长度：0

最大长度：36

publicip_id

String

弹性公网IP的ID（预付费场景返回该字段）

最小长度：0

最大长度：36
表7 PublicipCreateResp

参数

参数类型

描述

bandwidth_size

Integer

  • 功能说明：带宽大小，单位为Mbit/s。

create_time

String

  • 功能说明：弹性公网IP申请时间（UTC时间）

id

String

  • 功能说明：弹性公网IP唯一标识

最大长度：36

public_ip_address

String

  • 功能说明：IPv4时是申请到的弹性公网IP地址，IPv6时是IPv6地址对应的IPv4地址

最大长度：15

status

String

  • 功能说明：弹性公网IP的状态

  • 取值范围：

    • FREEZED：冻结

    • BIND_ERROR：绑定失败

    • BINDING：绑定中

    • PENDING_DELETE：释放中

    • PENDING_CREATE：创建中

    • NOTIFYING：创建中

    • NOTIFY_DELETE：释放中

    • PENDING_UPDATE：更新中

    • DOWN：未绑定

    • ACTIVE：绑定

    • ELB：绑定ELB

    • VPN：绑定VPN

    • ERROR：失败

tenant_id

String

项目ID，如何获取项目ID请参见获取项目ID

最大长度：36

type

String

  • 功能说明：弹性公网IP的类型

  • 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选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

    • 非洲-约翰内斯堡：5_bgp

    • 西南-贵阳一：5_sbgp

    • 华北-北京四：5_bgp、5_sbgp

    • 拉美-圣地亚哥：5_bgp

    • 拉美-圣保罗一：5_bgp

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

    • 拉美-布宜诺斯艾利一：5_bgp

    • 拉美-利马一：5_bgp

    • 拉美-圣地亚哥二： 5_bgp

  • 约束：

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。

最大长度：36

public_ipv6_address

String

  • 功能说明：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址

最大长度：39

ip_version

Integer

  • 功能说明：IP版本信息，取值范围是4和6，IPv6为开启NAT64能力

enterprise_project_id

String

  • 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。

  • 不指定该参数时，默认值是 0

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

最大长度：36

alias

String

  • 功能说明：弹性公网IP名称

  • 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最大长度：64

请求示例

  • 创建包周期独占带宽和弹性公网IP，大小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操作正常返回

错误码

请参见错误码。

父主题： 弹性公网IP

相关文档