查询弹性公网IP列表

功能介绍

查询弹性公网IP列表。

URI

GET /v1/{project_id}/publicips

请求消息

• 请求参数

  无

• 请求样例

  GET https://{Endpoint}/v1/{project_id}/publicips?limit={limit}&marker={marker}

响应消息

• 响应参数

  表2 响应参数

  名称	参数类型	说明
  publicips	Array of publicips objects	弹性公网IP列表对象，请参见表3。

  表3 publicips字段说明

  名称	参数类型	说明
  id	String	弹性公网IP唯一标识
  status	String	功能说明：弹性公网IP的状态 取值范围： FREEZED：冻结 BIND_ERROR：绑定失败 BINDING：绑定中 PENDING_DELETE：释放中 PENDING_CREATE：创建中 PENDING_UPDATE：更新中 DOWN：未绑定 ACTIVE：绑定 ELB：绑定ELB ERROR：异常失败
  profile	Object	功能说明：额外参数，包括订单id、产品id等信息，详情请参见表4。
  type	String	功能说明：弹性公网IP的类型 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP） 华南-广州：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端口，所以"publicip_type"字段未给定时，默认为5_bgp。
  public_ip_address	String	IPv4时是申请到的弹性公网IP地址
  public_ipv6_address	String	IPv4时无此字段，IPv6时为申请到的弹性公网IP地址
  ip_version	Integer	IP版本信息，取值范围是4和6 4：表示IPv4 6：表示IPv6
  private_ip_address	String	功能说明：绑定弹性公网IP的私有IP地址 约束：只有绑定了的弹性公网IP查询才会返回该参数
  port_id	String	功能说明：端口id。 约束：只有绑定了的弹性公网IP查询才会返回该参数
  tenant_id	String	项目ID
  create_time	String	弹性公网IP申请时间（UTC） 格式：yyyy-MM-dd HH:mm:ss
  bandwidth_id	String	弹性公网IP对应带宽ID
  bandwidth_size	Integer	带宽大小，单位为Mbit/s。
  bandwidth_share_type	String	功能说明：弹性公网IP的带宽类型 取值范围：PER，WHOLE。 PER：独享带宽 WHOLE：共享带宽
  bandwidth_name	String	带宽名称。
  alias	String	弹性公网IP名称
  enterprise_project_id	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。 不指定该参数时，默认值是 0，0表示默认企业项目。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》
  public_border_group	String	功能说明：表示中心站点资源或者边缘站点资源。 取值范围： center 边缘站点名称 约束限制：只能绑定与该字段相同的publicip资源
  allow_share_bandwidth_types	Array of strings	功能说明：表示此publicip可以加入的共享带宽类型列表。 如果列表为空，表示该publicip不能加入任何共享带宽。 约束：publicip只能加入到有该带宽类型的共享带宽中。

  表4 profile字段说明

  名称	参数类型	说明
  order_id	String	订单的id
  product_id	String	产品的id
  region_id	String	region的id
  user_id	String	用户的id

• 响应样例

  {
      "publicips": [
          {
              "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
              "status": "DOWN",
              "alias": "tom",
              "profile": {},
              "type": "5_bgp",
              "public_ip_address": "161.xx.xx.9",
              "private_ip_address": "192.168.10.5",
              "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
              "create_time": "2015-07-16 04:22:32",
              "bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
              "bandwidth_share_type": "PER",
              "bandwidth_size": 5,
              "bandwidth_name": "bandwidth-test",
              "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
              "ip_version": 4
          },
          {
              "id": "80d5b82e-43b9-4f82-809a-37bec5793bd4",
              "status": "DOWN",
              "profile": {},
              "type": "5_bgp",
              "public_ip_address": "161.xx.xx.10",
              "private_ip_address": "192.168.10.6",
              "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
              "create_time": "2015-07-16 04:23:03",
              "bandwidth_id": "a79fd11a-047b-4f5b-8f12-99c178cc780a",
              "bandwidth_share_type": "PER",
              "bandwidth_size": 5,
              "bandwidth_name": "bandwidth-test1",
              "enterprise_project_id":"0",
              "ip_version": 4
          }
      ]
  }

状态码

请参见状态码。

错误码

请参考错误码。