华为云首页用户手册

弹性公网IP EIP-申请EIP(包年/包月):请求参数

弹性公网IP EIP-申请EIP(包年/包月):请求参数

时间：2023-12-01 14:24:56

弹性公网IP EIP

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
publicip	是	CreatePrePaidPublicipOption object	EIP对象
bandwidth	是	CreatePublicipBandwidthOption object	带宽对象
extendParam	否	CreatePrePaidPublicipExtendParamOption object	扩展参数，用于包周期资源申请
enterprise_project_id	否	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。创建弹性公网IP时，给弹性公网IP绑定企业项目ID。不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。缺省值：0 最小长度：0 最大长度：36

表3 CreatePrePaidPublicipOption
参数	是否必选	参数类型	描述
type	是	String	功能说明：EIP的类型取值范围：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	功能说明：EIP的版本取值范围：4、6，IPv6为开启NAT64能力约束：必须是系统具体支持的类型不填或空字符串时，默认创建ipv4 缺省值：4 枚举值： 4 6
alias	否	String	功能说明：EIP名称取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最大长度：64
port_id	否	String	功能说明：端口id 约束：必须是存在的端口id，如果该端口不存在或端口已绑定EIP则会提示出错。最小长度：36 最大长度：36

表4 CreatePublicipBandwidthOption
参数	是否必选	参数类型	描述
charge_mode	否	String	功能说明：按流量计费还是按带宽计费。取值范围：bandwidth，traffic，不填或者为空时默认是bandwidth。其中IPv6国外默认是bandwidth，国内默认是traffic。缺省值：bandwidth 枚举值： bandwidth traffic
id	否	String	功能说明：带宽ID,创建WHOLE类型带宽的EIP时可以指定之前的共享带宽创建取值范围：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。枚举值： WHOLE PER
size	是	Integer	功能说明：带宽大小取值范围：默认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 枚举值： prePaid postPaid
period_type	否	String	功能说明：订购资源的周期类型（包年、包月等）取值范围： month-月 year-年约束：如果用包周期共享带宽创建时（即携带共享带宽id创建EIP）此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时，该字段必选；使用共享带宽创建IP时，带宽资源到期时间与IP的到期时间相同。枚举值： month year
period_num	否	Integer	功能说明：订购周期数取值范围：(后续会随运营策略变化) period_type为month时，为[1,9] period_type为year时，为[1,3] 约束：同period_type约束。最小值：1 最大值：9
is_auto_renew	否	Boolean	功能说明：是否自动续订取值范围： false：不自动续订 true：自动续订约束：到期后，默认自动续订1个月（自动续订时间后续可能会变化），详情可联系客服咨询。缺省值：false
is_auto_pay	否	Boolean	功能说明：下单订购后，是否自动从客户的账户中支付取值范围： true：自动支付，从账户余额自动扣费 false：只提交订单不支付，需要客户手动去支付约束：自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。缺省值：false

上一篇：弹性公网IP EIP-申请EIP(包年/包月):响应参数

下一篇：弹性公网IP EIP-申请EIP(包年/包月):响应参数

弹性公网IP EIP-申请EIP(包年/包月):请求参数

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

推荐文章

解决方案
相关专题