文档首页> 弹性公网IP EIP> API参考> API> 弹性公网IP> 查询弹性公网IP列表
更新时间：2024-05-17 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询弹性公网IP列表

功能介绍

查询当前局点下用户所有弹性公网IP的列表

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/publicips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

  • 功能说明：取值为上一页数据的最后一条记录的id，为空时为查询第一页

最大长度：36

limit

否

Integer

  • 功能说明：每页返回的个数

  • 取值范围：0~[2000]，其中2000为局点差异项，具体取值由局点决定

最小值：0

ip_version

否

Integer

  • 功能说明：IP地址版本信息，4：IPv4，6：开启NAT64能力

枚举值：

  • 4

  • 6

enterprise_project_id

否

String

  • 功能说明：企业项目ID。可以使用该字段过滤某个企业项目下的弹性公网IP。

  • 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。如果需要查询当前用户所有企业项目绑定的弹性公网IP，请传参all_granted_eps。

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

port_id

否

Array

  • 功能说明：绑定弹性公网IP的端口id

public_ip_address

否

Array

  • 功能说明：IPv4时是申请到的弹性公网IP地址，IPv6时是IPv6地址对应的IPv4地址

private_ip_address

否

Array

  • 功能说明：关联端口的私有IP地址

id

否

Array

  • 功能说明：弹性公网IP唯一标识

allow_share_bandwidth_type_any

否

Array

  • 功能说明：共享带宽类型，根据任一共享带宽类型过滤弹性公网IP列表。可以指定多个带宽类型，不同的带宽类型间用逗号分隔。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

publicips

Array of PublicipShowResp objects

弹性公网IP对象
表4 PublicipShowResp

参数

参数类型

描述

bandwidth_id

String

  • 功能说明：弹性公网IP对应带宽ID

最大长度：36

bandwidth_name

String

  • 功能说明：带宽名称

最小长度：1

最大长度：64

bandwidth_share_type

String

  • 功能说明：表示共享带宽或者独享带宽

  • 取值范围：

    • WHOLE：共享带宽

    • PER：独享带宽

  • 约束：其中IPv6暂不支持WHOLE类型带宽。

枚举值：

  • WHOLE

  • PER

bandwidth_size

Integer

  • 功能说明：带宽大小，单位为Mbit/s。

create_time

String

  • 功能说明：弹性公网IP申请时间（UTC）

enterprise_project_id

String

  • 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。

  • 不指定该参数时，默认值是 0

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

最大长度：36

id

String

  • 功能说明：弹性公网IP唯一标识

最大长度：36

port_id

String

  • 功能说明：端口id。

  • 约束：只有绑定了的弹性公网IP查询才会返回该参数

最大长度：36

private_ip_address

String

  • 功能说明：绑定弹性公网IP的私有IP地址

  • 约束：只有绑定了的弹性公网IP查询才会返回该参数

profile

ProfileResp object

  • 功能说明：额外参数，包括订单id、产品id等信息

  • 约束：如果profile不为空，说明是包周期的弹性公网IP

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：IPv4

    • 6：IPv6

枚举值：

  • 4

  • 6

public_border_group

String

  • 功能说明：表示中心站点资源或者边缘站点资源，对接了边缘站点的区域才会返回该字段

  • 取值范围： center、边缘站点名称

  • 约束：publicip只能绑定该字段相同的资源

最小长度：1

最大长度：64

allow_share_bandwidth_types

Array of strings

  • 功能说明：表示此publicip可以加入的共享带宽类型列表，如果列表为空，则表示该publicip不能加入任何共享带宽

  • 约束：publicip只能加入到有该带宽类型的共享带宽中

最大长度：64

alias

String

  • 功能说明：弹性公网IP名称

  • 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最大长度：64
表5 ProfileResp

参数

参数类型

描述

order_id

String

订单的id

最大长度：36

product_id

String

产品的id

最大长度：36

region_id

String

当前局点的id

最大长度：36

user_id

String

用户的id

最大长度：36

请求示例

GET https://{Endpoint}/v1/{project_id}/publicips?limit=2&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d

响应示例

状态码： 200

GET操作正常返回

{
  "publicips" : [ {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "bandwidth_name" : "bandwidth-test",
    "public_ip_address" : "161.xx.xx.9",
    "create_time" : "2015-07-16 04:22:32",
    "profile" : {
      "user_id" : "35f2b308f5d64441a6fa7999fbcd4321",
      "product_id" : "00301-48027-0--0",
      "region_id" : "xxx",
      "order_id" : "xxxxxxxxx"
    },
    "type" : "5_bgp",
    "bandwidth_id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
    "bandwidth_size" : 5,
    "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439",
    "ip_version" : 4,
    "private_ip_address" : "192.168.10.5",
    "bandwidth_share_type" : "PER",
    "id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
    "status" : "ACTIVE",
    "port_id" : "4977b983-cd4f-4ecc-93a1-cb52d848a9b3",
    "public_border_group" : "center",
    "allow_share_bandwidth_types" : [ "share" ]
  }, {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "bandwidth_name" : "bandwidth-test1",
    "public_ip_address" : "161.xx.xx.10",
    "create_time" : "2015-07-16 04:23:03",
    "profile" : { },
    "type" : "5_bgp",
    "bandwidth_id" : "a79fd11a-047b-4f5b-8f12-99c178cc780a",
    "bandwidth_size" : 5,
    "enterprise_project_id" : "0",
    "ip_version" : 4,
    "bandwidth_share_type" : "PER",
    "id" : "80d5b82e-43b9-4f82-809a-37bec5793bd4",
    "status" : "DOWN",
    "public_border_group" : "center",
    "allow_share_bandwidth_types" : [ "share" ]
  } ]
}

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码。

父主题： 弹性公网IP
分享：

    相关文档

    相关产品