申请弹性公网IP_弹性公网IP EIP_API参考_API_弹性公网IP

功能介绍

申请弹性公网IP，支持IPv4和IPv6。

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

URI

POST /v1/{project_id}/publicips

请求消息

• 请求参数

  表2 请求参数

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

  表3 publicip字段说明

  名称	是否必选	参数类型	说明
  type	是	String	功能说明：弹性公网IP的类型 取值范围：5_telcom（电信），5_union（联通），5_bgp（全动态BGP），5_sbgp（静态BGP） 东北-大连：5_telcom、5_union 华南-广州：5_bgp、5_sbgp 华东-上海一：5_bgp、5_sbgp 华东-上海二：5_bgp、5_sbgp 华北-北京一：5_bgp、5_sbgp 亚太-香港：5_bgp 亚太-曼谷：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，分别表示创建ipv4和ipv6 约束： 必须是系统具体支持的类型 不填或空字符串时，默认创建ipv4
  ip_address	否	String	功能说明：希望申请到的弹性公网IP的地址，不指定时由系统自动分配 约束：必须为IPv4地址格式，且必须在可用地址池范围内

  表4 bandwidth字段说明

  名称	是否必选	参数类型	说明
  name	否	String	功能说明：带宽名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 如果share_type是PER，该参数必须带，如果share_type是WHOLE并且id有值，该参数会忽略。
  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。
  id	否	String	功能说明：带宽ID，创建弹性公网IP时可以指定已有的共享带宽 取值范围：共享（WHOLE类型）带宽ID
  share_type	是	String	功能说明：带宽类型 取值范围： PER：独享带宽 WHOLE：共享带宽 约束：该字段为WHOLE时，必须指定带宽ID
  charge_mode	否	String	功能说明：按流量计费还是按带宽计费。 取值范围：bandwidth，traffic，不填或者为空时默认是bandwidth。其中IPv6国外默认是bandwidth，国内默认是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"
      },
      "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
  }

响应消息

• 响应参数

  表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_telcom（电信），5_union（联通），5_bgp（全动态BGP），5_sbgp（静态BGP） 东北-大连：5_telcom、5_union 华南-广州：5_bgp、5_sbgp 华东-上海一：5_bgp、5_sbgp 华东-上海二：5_bgp、5_sbgp 华北-北京一：5_bgp、5_sbgp 亚太-香港：5_bgp 亚太-曼谷：5_bgp 亚太-新加坡：5_bgp 非洲-约翰内斯堡：5_bgp 西南-贵阳一：5_sbgp 华北-北京四：5_bgp、5_sbgp 拉美-圣保罗一：5_bgp 拉美-墨西哥城一：5_bgp 拉美-布宜诺斯艾利一：5_bgp 拉美-利马一：5_bgp 拉美-圣地亚哥二：5_bgp 约束： 必须是系统具体支持的类型 publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。
  public_ip_address	String	IPv4时是申请到的弹性公网IP地址，IPv6时是IPv6地址对应的IPv4地址
  public_ipv6_address	String	IPv4时无此字段，IPv6时为申请到的弹性公网IP地址
  ip_version	Integer	IP版本信息，取值范围是4和6 4：表示IPv4 6：表示IPv6
  tenant_id	String	项目ID
  create_time	String	弹性公网IP申请时间（UTC）
  bandwidth_size	Integer	带宽大小，单位为Mbit/s。
  enterprise_project_id	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。

• 响应样例一（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,
          "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
      }
  }

状态码

请参见状态码。

错误码

请参考错误码。