申请弹性公网IP

功能介绍

申请弹性公网IP

弹性公网IP（Elastic IP）提供独立的公网IP资源，包括公网IP地址与公网出口带宽服务。可以与弹性云服务器、裸金属服务器、虚拟IP、弹性负载均衡、NAT网关等资源灵活地绑定及解绑。

URI

POST /v1/{project_id}/publicips

请求消息

• 请求参数

  表2 请求参数

  名称	是否必选	参数类型	说明
  publicip	是	Object	弹性公网IP对象，请参见表3。
  bandwidth	是	Object	带宽对象，请参见表4。

  表3 publicip字段说明

  名称	是否必选	参数类型	说明
  type	是	String	功能说明：弹性公网IP的类型 取值范围：5_bgp 约束： 必须是系统具体支持的类型 publicip_id为IPv4端口，所以"publicip_type"字段未给定时，默认为5_bgp。
  ip_address	否	String	功能说明：希望申请到的弹性公网IP的地址，不指定时由系统自动分配 约束：必须为IPv4地址格式，且必须在可用地址池范围内

  表4 bandwidth字段说明

  名称	是否必选	参数类型	说明
  name	是	String	功能说明：带宽名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 如果share_type是PER，该参数必须带,如果share_type是WHOLE并且id有值，该参数会忽略。
  size	是	Integer	功能说明：带宽大小 取值范围：默认1Mbit/s~300Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 约束：share_type是PER，该参数必须带,如果share_type是WHOLE并且id有值，该参数会忽略。 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s：默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。 大于1000Mbit/s：默认最小单位为500Mbit/s。
  share_type	是	String	功能说明：带宽类型 取值为PER，表示独享带宽
  charge_mode	否	String	取值为traffic，表示流量计费。

• 请求样例一（IPv4 EIP独享带宽）

  POST https://{Endpoint}/v1/{project_id}/publicips
  
  {
      "publicip": {
          "type": "5_bgp",
          "ip_version": 4
      },
      "bandwidth": {
          "name": "bandwidth123",
          "size": 10,
          "share_type": "PER"
      }
  }

响应消息

• 响应参数

  表5 响应参数

  名称	参数类型	说明
  publicip	Object	弹性公网IP对象，请参见表6。

  表6 publicip字段说明

  名称	参数类型	说明
  id	String	弹性公网IP唯一标识
  status	String	功能说明：弹性公网IP的状态 取值范围： FREEZED：冻结 BIND_ERROR：绑定失败 BINDING：绑定中 PENDING_DELETE：释放中 PENDING_CREATE：创建中 PENDING_UPDATE：更新中 DOWN：未绑定 ACTIVE：绑定 ELB：绑定ELB ERROR：异常失败
  type	String	功能说明：弹性公网IP的类型 取值范围：5_bgp 约束： 必须是系统具体支持的类型 publicip_id为IPv4端口，所以"publicip_type"字段未给定时，默认为5_bgp。
  public_ip_address	String	IPv4时是申请到的弹性公网IP地址
  tenant_id	String	项目ID
  create_time	String	弹性公网IP申请时间（UTC）
  bandwidth_size	Integer	带宽大小，单位为Mbit/s。

• 响应样例一（IPv4 EIP独享带宽）

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

状态码

请参见状态码。

错误码

请参考错误码。