申请弹性公网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
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
publicip |
是 |
CreatePrePaidPublicipOption object |
弹性公网IP对象 |
|
bandwidth |
是 |
带宽对象 |
|
|
extendParam |
否 |
扩展参数,用于包周期资源申请 |
|
|
enterprise_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 |
使用共享带宽创建IP时,带宽资源到期时间与IP的到期时间相同。 |
|
period_num |
否 |
Integer |
最小值:1 最大值:9 |
|
is_auto_renew |
否 |
Boolean |
false:不自动续订 true:自动续订 缺省值:false |
|
is_auto_pay |
否 |
Boolean |
缺省值:false |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
publicip |
PublicipCreateResp object |
弹性公网IP对象(后付费场景返回对象) |
|
order_id |
String |
订单号(预付费场景返回该字段) 最小长度:0 最大长度:36 |
|
publicip_id |
String |
弹性公网IP的ID(预付费场景返回该字段) 最小长度:0 最大长度:36 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bandwidth_size |
Integer |
|
|
create_time |
String |
|
|
id |
String |
最大长度:36 |
|
public_ip_address |
String |
最大长度:15 |
|
status |
String |
|
|
tenant_id |
String |
项目ID,如何获取项目ID请参见获取项目ID 最大长度:36 |
|
type |
String |
最大长度:36 |
|
public_ipv6_address |
String |
最大长度:39 |
|
ip_version |
Integer |
|
|
enterprise_project_id |
String |
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 最大长度:36 |
|
alias |
String |
最大长度: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" : false } } -
创建按需的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"
}
}
SDK代码示例
SDK代码示例如下。
-
创建包周期独占带宽和弹性公网IP,大小1Mb,周期1个月。不自动续费,不自动扣费。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.eip.v2.region.EipRegion; import com.huaweicloud.sdk.eip.v2.*; import com.huaweicloud.sdk.eip.v2.model.*; public class CreatePrePaidPublicipSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("<YOUR REGION>")) .build(); CreatePrePaidPublicipRequest request = new CreatePrePaidPublicipRequest(); CreatePrePaidPublicipRequestBody body = new CreatePrePaidPublicipRequestBody(); CreatePrePaidPublicipExtendParamOption extendParambody = new CreatePrePaidPublicipExtendParamOption(); extendParambody.withChargeMode(CreatePrePaidPublicipExtendParamOption.ChargeModeEnum.fromValue("prePaid")) .withPeriodType(CreatePrePaidPublicipExtendParamOption.PeriodTypeEnum.fromValue("month")) .withPeriodNum(1) .withIsAutoRenew(false) .withIsAutoPay(false); CreatePublicipBandwidthOption bandwidthbody = new CreatePublicipBandwidthOption(); bandwidthbody.withChargeMode(CreatePublicipBandwidthOption.ChargeModeEnum.fromValue("bandwidth")) .withName("bw_666") .withShareType(CreatePublicipBandwidthOption.ShareTypeEnum.fromValue("PER")) .withSize(1); CreatePrePaidPublicipOption publicipbody = new CreatePrePaidPublicipOption(); publicipbody.withType("5_bgp"); body.withExtendParam(extendParambody); body.withBandwidth(bandwidthbody); body.withPublicip(publicipbody); request.withBody(body); try { CreatePrePaidPublicipResponse response = client.createPrePaidPublicip(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }
-
创建按需的IP、带宽;extendParam扩展字段,不填即可。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.eip.v2.region.EipRegion; import com.huaweicloud.sdk.eip.v2.*; import com.huaweicloud.sdk.eip.v2.model.*; public class CreatePrePaidPublicipSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("<YOUR REGION>")) .build(); CreatePrePaidPublicipRequest request = new CreatePrePaidPublicipRequest(); CreatePrePaidPublicipRequestBody body = new CreatePrePaidPublicipRequestBody(); CreatePublicipBandwidthOption bandwidthbody = new CreatePublicipBandwidthOption(); bandwidthbody.withChargeMode(CreatePublicipBandwidthOption.ChargeModeEnum.fromValue("bandwidth")) .withName("bw_666") .withShareType(CreatePublicipBandwidthOption.ShareTypeEnum.fromValue("PER")) .withSize(1); CreatePrePaidPublicipOption publicipbody = new CreatePrePaidPublicipOption(); publicipbody.withType("5_bgp"); body.withBandwidth(bandwidthbody); body.withPublicip(publicipbody); request.withBody(body); try { CreatePrePaidPublicipResponse response = client.createPrePaidPublicip(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }
-
创建包周期独占带宽和弹性公网IP,大小1Mb,周期1个月。不自动续费,不自动扣费。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v2.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreatePrePaidPublicipRequest() extendParambody = CreatePrePaidPublicipExtendParamOption( charge_mode="prePaid", period_type="month", period_num=1, is_auto_renew=False, is_auto_pay=False ) bandwidthbody = CreatePublicipBandwidthOption( charge_mode="bandwidth", name="bw_666", share_type="PER", size=1 ) publicipbody = CreatePrePaidPublicipOption( type="5_bgp" ) request.body = CreatePrePaidPublicipRequestBody( extend_param=extendParambody, bandwidth=bandwidthbody, publicip=publicipbody ) response = client.create_pre_paid_publicip(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
-
创建按需的IP、带宽;extendParam扩展字段,不填即可。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v2.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreatePrePaidPublicipRequest() bandwidthbody = CreatePublicipBandwidthOption( charge_mode="bandwidth", name="bw_666", share_type="PER", size=1 ) publicipbody = CreatePrePaidPublicipOption( type="5_bgp" ) request.body = CreatePrePaidPublicipRequestBody( bandwidth=bandwidthbody, publicip=publicipbody ) response = client.create_pre_paid_publicip(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
-
创建包周期独占带宽和弹性公网IP,大小1Mb,周期1个月。不自动续费,不自动扣费。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := eip.NewEipClient( eip.EipClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreatePrePaidPublicipRequest{} chargeModeExtendParam:= model.GetCreatePrePaidPublicipExtendParamOptionChargeModeEnum().PRE_PAID periodTypeExtendParam:= model.GetCreatePrePaidPublicipExtendParamOptionPeriodTypeEnum().MONTH periodNumExtendParam:= int32(1) isAutoRenewExtendParam:= false isAutoPayExtendParam:= false extendParambody := &model.CreatePrePaidPublicipExtendParamOption{ ChargeMode: &chargeModeExtendParam, PeriodType: &periodTypeExtendParam, PeriodNum: &periodNumExtendParam, IsAutoRenew: &isAutoRenewExtendParam, IsAutoPay: &isAutoPayExtendParam, } chargeModeBandwidth:= model.GetCreatePublicipBandwidthOptionChargeModeEnum().BANDWIDTH nameBandwidth:= "bw_666" sizeBandwidth:= int32(1) bandwidthbody := &model.CreatePublicipBandwidthOption{ ChargeMode: &chargeModeBandwidth, Name: &nameBandwidth, ShareType: model.GetCreatePublicipBandwidthOptionShareTypeEnum().PER, Size: &sizeBandwidth, } publicipbody := &model.CreatePrePaidPublicipOption{ Type: "5_bgp", } request.Body = &model.CreatePrePaidPublicipRequestBody{ ExtendParam: extendParambody, Bandwidth: bandwidthbody, Publicip: publicipbody, } response, err := client.CreatePrePaidPublicip(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
-
创建按需的IP、带宽;extendParam扩展字段,不填即可。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := eip.NewEipClient( eip.EipClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreatePrePaidPublicipRequest{} chargeModeBandwidth:= model.GetCreatePublicipBandwidthOptionChargeModeEnum().BANDWIDTH nameBandwidth:= "bw_666" sizeBandwidth:= int32(1) bandwidthbody := &model.CreatePublicipBandwidthOption{ ChargeMode: &chargeModeBandwidth, Name: &nameBandwidth, ShareType: model.GetCreatePublicipBandwidthOptionShareTypeEnum().PER, Size: &sizeBandwidth, } publicipbody := &model.CreatePrePaidPublicipOption{ Type: "5_bgp", } request.Body = &model.CreatePrePaidPublicipRequestBody{ Bandwidth: bandwidthbody, Publicip: publicipbody, } response, err := client.CreatePrePaidPublicip(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
POST操作正常返回 |
错误码
请参见错误码。