文档首页> 弹性公网IP EIP> API参考> API> 弹性公网IP> 申请弹性公网IP(按需计费)

更新时间：2024-04-03 GMT+08:00

申请弹性公网IP(按需计费)

功能介绍

申请弹性公网IP，支持IPv4和IPv6。弹性公网IP（Elastic IP）提供独立的公网IP资源，包括公网IP地址与公网出口带宽服务。可以与弹性云服务器、裸金属服务器、虚拟IP、弹性负载均衡、NAT网关等资源灵活地绑定及解绑。拥有多种灵活的计费方式，可以满足各种业务场景的需要。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/publicips

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取项目ID请参见获取项目ID

请求参数

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

表3 CreatePublicipBandwidthOption
参数	是否必选	参数类型	描述
charge_mode	否	String	功能说明：按带宽计费还是按流量计费。取值范围：bandwidth（按带宽计费，traffic（按流量计费），不填或者为空时默认是bandwidth。缺省值：bandwidth 枚举值： bandwidth traffic
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。枚举值： WHOLE PER
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。

表4 CreatePublicipOption
参数	是否必选	参数类型	描述
ip_address	否	String	功能说明：希望申请到的弹性公网IP的地址，不指定时由系统自动分配约束：必须为IPv4地址格式，且必须在可用地址池范围内最大长度：15
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。
ip_version	否	Integer	功能说明：弹性公网IP的版本取值范围：4、6，ipv6表示开启NAT64能力约束：必须是系统具体支持的类型不填或空字符串时，默认创建ipv4 缺省值：4 枚举值： 4 6
alias	否	String	功能说明：弹性公网IP名称取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最大长度：64
port_id	否	String	功能说明：端口id 约束：必须是存在的端口id，如果该端口不存在或端口已绑定弹性公网IP则会提示出错。最小长度：36 最大长度：36

响应参数

状态码： 200

表5 响应Body参数
参数	参数类型	描述
publicip	PublicipCreateResp object	弹性公网IP对象

表6 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：失败枚举值： FREEZED BIND_ERROR BINDING PENDING_DELETE PENDING_CREATE NOTIFYING NOTIFY_DELETE PENDING_UPDATE DOWN ACTIVE ELB VPN ERROR
tenant_id	String	功能说明：项目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能力枚举值： 4 6
enterprise_project_id	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。创建弹性公网IP时，给弹性公网IP绑定企业项目ID。不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。最大长度：36
alias	String	功能说明：弹性公网IP名称取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最大长度：64

请求示例

创建IPv4 弹性公网IP独享带宽。

{
  "bandwidth" : {
    "size" : 10,
    "share_type" : "PER",
    "name" : "bandwidth123"
  },
  "publicip" : {
    "ip_version" : 4,
    "type" : "5_bgp"
  }
}

创建IPv6 弹性公网IP独享带宽。

{
  "bandwidth" : {
    "size" : 5,
    "share_type" : "WHOLE",
    "name" : "bandwidth123"
  },
  "publicip" : {
    "ip_version" : 6,
    "type" : "5_bgp"
  }
}

响应示例

状态码： 200

POST操作正常返回

{
  "publicip" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "bandwidth_size" : 0,
    "public_ip_address" : "161.xx.xx.7",
    "ip_version" : 4,
    "create_time" : "2015-07-16 04:10:52",
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "type" : "5_bgp",
    "status" : "PENDING_CREATE"
  }
}

SDK代码示例

SDK代码示例如下。

创建IPv4 弹性公网IP独享带宽。

        
         
           
           
             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 CreatePublicipSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        CreatePublicipRequest request = new CreatePublicipRequest();
        CreatePublicipRequestBody body = new CreatePublicipRequestBody();
        CreatePublicipOption publicipbody = new CreatePublicipOption();
        publicipbody.withType("5_bgp")
            .withIpVersion(CreatePublicipOption.IpVersionEnum.NUMBER_4);
        CreatePublicipBandwidthOption bandwidthbody = new CreatePublicipBandwidthOption();
        bandwidthbody.withName("bandwidth123")
            .withShareType(CreatePublicipBandwidthOption.ShareTypeEnum.fromValue("PER"))
            .withSize(10);
        body.withPublicip(publicipbody);
        body.withBandwidth(bandwidthbody);
        request.withBody(body);
        try {
            CreatePublicipResponse response = client.createPublicip(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());
        }
    }
}

            

          

        
       

创建IPv6 弹性公网IP独享带宽。

        
         
           
           
             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 CreatePublicipSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        CreatePublicipRequest request = new CreatePublicipRequest();
        CreatePublicipRequestBody body = new CreatePublicipRequestBody();
        CreatePublicipOption publicipbody = new CreatePublicipOption();
        publicipbody.withType("5_bgp")
            .withIpVersion(CreatePublicipOption.IpVersionEnum.NUMBER_6);
        CreatePublicipBandwidthOption bandwidthbody = new CreatePublicipBandwidthOption();
        bandwidthbody.withName("bandwidth123")
            .withShareType(CreatePublicipBandwidthOption.ShareTypeEnum.fromValue("WHOLE"))
            .withSize(5);
        body.withPublicip(publicipbody);
        body.withBandwidth(bandwidthbody);
        request.withBody(body);
        try {
            CreatePublicipResponse response = client.createPublicip(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());
        }
    }
}

            

          

        
       

创建IPv4 弹性公网IP独享带宽。

        
         
           
           
             # coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = EipClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EipRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreatePublicipRequest()
        publicipbody = CreatePublicipOption(
            type="5_bgp",
            ip_version=4
        )
        bandwidthbody = CreatePublicipBandwidthOption(
            name="bandwidth123",
            share_type="PER",
            size=10
        )
        request.body = CreatePublicipRequestBody(
            publicip=publicipbody,
            bandwidth=bandwidthbody
        )
        response = client.create_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)

            

          

        
       

创建IPv6 弹性公网IP独享带宽。

        
         
           
           
             # coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = EipClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EipRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreatePublicipRequest()
        publicipbody = CreatePublicipOption(
            type="5_bgp",
            ip_version=6
        )
        bandwidthbody = CreatePublicipBandwidthOption(
            name="bandwidth123",
            share_type="WHOLE",
            size=5
        )
        request.body = CreatePublicipRequestBody(
            publicip=publicipbody,
            bandwidth=bandwidthbody
        )
        response = client.create_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)

            

          

        
       

创建IPv4 弹性公网IP独享带宽。

        
         
           
           
             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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreatePublicipRequest{}
	ipVersionPublicip:= model.GetCreatePublicipOptionIpVersionEnum().E_4
	publicipbody := &model.CreatePublicipOption{
		Type: "5_bgp",
		IpVersion: &ipVersionPublicip,
	}
	nameBandwidth:= "bandwidth123"
	sizeBandwidth:= int32(10)
	bandwidthbody := &model.CreatePublicipBandwidthOption{
		Name: &nameBandwidth,
		ShareType: model.GetCreatePublicipBandwidthOptionShareTypeEnum().PER,
		Size: &sizeBandwidth,
	}
	request.Body = &model.CreatePublicipRequestBody{
		Publicip: publicipbody,
		Bandwidth: bandwidthbody,
	}
	response, err := client.CreatePublicip(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

创建IPv6 弹性公网IP独享带宽。

        
         
           
           
             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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreatePublicipRequest{}
	ipVersionPublicip:= model.GetCreatePublicipOptionIpVersionEnum().E_6
	publicipbody := &model.CreatePublicipOption{
		Type: "5_bgp",
		IpVersion: &ipVersionPublicip,
	}
	nameBandwidth:= "bandwidth123"
	sizeBandwidth:= int32(5)
	bandwidthbody := &model.CreatePublicipBandwidthOption{
		Name: &nameBandwidth,
		ShareType: model.GetCreatePublicipBandwidthOptionShareTypeEnum().WHOLE,
		Size: &sizeBandwidth,
	}
	request.Body = &model.CreatePublicipRequestBody{
		Publicip: publicipbody,
		Bandwidth: bandwidthbody,
	}
	response, err := client.CreatePublicip(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	POST操作正常返回

错误码

请参见错误码。

父主题：弹性公网IP

上一篇：按需转包年/包月弹性公网IP

下一篇：查询弹性公网IP

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

申请弹性公网IP(按需计费)

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线