申请弹性公网IP
1. 接口描述
调用 AllocateEip 接口申请一个弹性公网IP。
- 后付费弹性IP按实际使用量收取费用,为避免账单欠费被停服,请确保账户余额充足。
- 预付费弹性IP的购买会预先扣除本次实例购买所需金额,在调用本次接口前请确保账户余额充足。
- 申请弹性公网IP需要通过实名认证。您可以参见实名认证相关文档完成认证。
2. 请求参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 固定取值:AllocateEip |
RegionCode | String | 是 | 弹性公网IP所属的地域编码,您可以调用 DescribeRegionConfig 接口获取地域编码 |
BandwidthType | String | 是 | 弹性公网IP线路类型,您可以调用 DescribeProductConfig 查看您可购买的弹性公网IP线路类型 |
Bandwidth | Integer | 是 | 带宽大小, 单位Mbps |
InternetChargeType | String | 是 | 计费方式,可能值: PAY_BY_BAND_WIDTH 按带宽计费(预付费) PAY_BY_TRAFFIC 按流量计费(后付费) PAY_BY_BANDWIDTH_PACKAGE 按共享带宽包计费(后付费) |
InstanceChargeType | String | 是 | 付费方式,需要与InternetChargeType对应,取值范围: PRE_PAID 预付费 POST_PAID 后付费 |
AutoRenew | String | 否 | 是否自动续费。取值范围: NONE 不开启自动续费 INFINITE 开启自动续费 |
Period | Integer | 是 | 购买时长 |
BillingCycle | String | 是 | 计费周期,预付费为MONTH,后付费为DAY,取值范围: DAY 日 MONTH 月 |
EipSeries | String | 否 | 弹性公网IP系列。默认Normal,取值范围: Normal 普通型 Enetwork 网络增强型 |
CidrBlock | String | 否 | 指定IP地址网段 |
IpAddress | String | 否 | 指定IP地址,指定IP地址时CidrBlock为必传 |
ClientToken | String | 是 | 用于保证幂等性。 |
3. 返回数据
名称 | 类型 | 说明 |
---|---|---|
EipUUID | String | 弹性公网IP标识 |
RequestId | String | 请求ID |
4. 示例
请求示例
https://openapi.kaopuyun.com/?AccessKeyId=sz0000ei53aw
&Action=AllocateEip
&Format=JSON
&SignatureMethod=HMAC-SHA1
&SignatureNonce=76a5d5e7-0992-462d-9a26-916650eca00f
&SignatureVersion=1.0
&Timestamp=2023-03-09T07%3A33%3A56Z
&Version=2014-05-26
&Signature=LH5UYKO7k%2FeQlyLH3p169uyRKyU%
&RegionCode=cn-fuzhou-5
&BandwidthType=BGP
&Bandwidth=10
&InternetChargeType=PAY_BY_BAND_WIDTH
&InstanceChargeType=PRE_PAID
&Period=1
&BillingCycle=MONTH
&ClientToken=9a26-916650eca00f
正常返回示例
{
"EipUUID":"eip-np00000d146o",
"RequestId":"742fbe80-0ea9-11eb-9b36-0208cb7f7896"
}
5. 错误码
错误码 | 错误信息 |
---|---|
MissingParameter | RegionCode 参数不能为空 |
MissingParameter | BandwidthType 参数不能为空 |
MissingParameter | InstanceChargeType 参数不能为空 |
MissingParameter | InternetChargeType 参数不能为空 |
MissingParameter | Period 参数不能为空 |
MissingParameter | Bandwidth 参数不能为空 |
MissingParameter | CidrBlock 参数不能为空 |
ValueNotSupported | BillingCycle 参数不合法 |
ValueNotSupported | BandwidthType 参数不合法 |
ValueNotSupported | InternetChargeType 参数不合法 |
ValueNotSupported | InstanceChargeType 参数不合法 |
ValueNotSupported | AutoRenew 参数不合法 |
InvalidEipConfigNotSupported | 弹性公网IP配置不合法 |
NoAvailableBandwidthTypeConfig | 无可用线路类型配置 |
NoAvailableIp | 无可用IP |
AccountBalnceNotEnough | 账户余额不足 |
AccountNotRealnameAuth | 账户未实名认证 |
AllocateEipFail | 分配弹性公网IP失败:xxx |