全量查询弹性公网IP列表

project_id

是

String

项目ID，获取项目ID请参见获取项目ID

最大长度：32

marker

否

String

• 功能说明：分页查询起始的资源ID，为空时为查询第一页

最小长度：0

最大长度：36

offset

否

Integer

• 功能说明：分页查询起始的资源序号

最小值：0

最大值：99999

limit

否

Integer

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

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

最小值：0

最大值：2000

fields

否

Array

• 功能说明：查询字段，形式为"fields=id&fields=owner&..."

• 支持字段：id/project_id/ip_version/type/public_ip_address/public_ipv6_address/network_type/status/description/created_at/updated_at/vnic/bandwidth/associate_instance_type/associate_instance_id/lock_status/billing_info/tags/enterprise_project_id/allow_share_bandwidth_types/public_border_group/alias/publicip_pool_name/publicip_pool_id

数组长度：0 - 999

sort_key

否

String

• 功能说明：排序字段，形式为"sort_key=id"

• 支持字段：id/public_ip_address/public_ipv6_address/ip_version/created_at/updated_at/public_border_group

枚举值：

• id

• public_ip_address

• public_ipv6_address

• ip_version

• created_at

• updated_at

• public_border_group

sort_dir

否

String

• 功能说明：排序方向

• 取值范围：asc、desc

枚举值：

• asc

• desc

id

否

Array

• 功能说明：根据id过滤

数组长度：0 - 999

ip_version

否

Array

• 功能说明：根据ip_version过滤

• 取值范围：4、6

数组长度：0 - 999

枚举值：

• 4

• 6

public_ip_address

否

Array

• 功能说明：根据public_ip_address过滤

数组长度：0 - 999

public_ip_address_like

否

String

• 功能说明：根据public_ip_address过滤，模糊搜索

最小长度：0

最大长度：64

public_ipv6_address

否

Array

• 功能说明：根据public_ipv6_address过滤

数组长度：0 - 999

public_ipv6_address_like

否

String

• 功能说明：根据public_ipv6_address过滤，模糊搜索

最小长度：0

最大长度：64

type

否

Array

• 功能说明：根据type过滤

• 取值范围：

  • 弹性公网IP: 弹性公网IP

  • DUALSTACK: 双栈IPV6

数组长度：0 - 999

枚举值：

• 弹性公网IP

• DUALSTACK

network_type

否

Array

• 功能说明：根据network_type过滤

• 取值范围：5_telcom、5_union、5_bgp、5_sbgp、5_ipv6、5_graybgp

数组长度：0 - 999

枚举值：

• 5_telcom

• 5_union

• 5_bgp

• 5_sbgp

• 5_ipv6

• 5_graybgp

publicip_pool_name

否

Array

• 功能说明：根据publicip_pool_name过滤

• 取值范围：5_telcom、5_union、5_bgp、5_sbgp、5_ipv6、5_graybgp、专属池名称等

数组长度：0 - 999

status

否

Array

• 功能说明：根据status过滤

• 取值范围：FREEZED、DOWN、ACTIVE、ERROR

数组长度：0 - 999

枚举值：

• FREEZED

• DOWN

• ACTIVE

• ERROR

alias_like

否

String

• 功能说明：根据alias模糊搜索

最小长度：0

最大长度：64

alias

否

Array

• 功能说明：根据alias过滤

数组长度：0 - 999

description

否

Array

• 功能说明：根据description过滤

数组长度：0 - 999

vnic.private_ip_address

否

Array

• 功能说明：根据private_ip_address过滤

数组长度：0 - 999

vnic.private_ip_address_like

否

String

• 功能说明：根据private_ip_address模糊搜索

最小长度：0

最大长度：64

vnic.device_id

否

Array

• 功能说明：根据device_id过滤

数组长度：0 - 999

vnic.device_owner

否

Array

• 功能说明：根据device_owner过滤

数组长度：0 - 999

vnic.vpc_id

否

Array

• 功能说明：根据vpc_id过滤

数组长度：0 - 999

vnic.port_id

否

Array

• 功能说明：根据port_id过滤

数组长度：0 - 999

vnic.device_owner_prefixlike

否

String

• 功能说明：根据device_owner_prefixlike模糊搜索

最小长度：0

最大长度：64

vnic.instance_type

否

Array

• 功能说明：根据instance_type过滤

数组长度：0 - 999

vnic.instance_id

否

Array

• 功能说明：根据instance_id过滤

数组长度：0 - 999

bandwidth.id

否

Array

• 功能说明：根据id过滤

数组长度：0 - 999

bandwidth.name

否

Array

• 功能说明：根据name过滤

数组长度：0 - 999

bandwidth.name_like

否

Array

• 功能说明：根据name模糊过滤

数组长度：0 - 999

bandwidth.size

否

Array

• 功能说明：根据size过滤

数组长度：0 - 999

bandwidth.share_type

否

Array

• 功能说明：根据share_type过滤

数组长度：0 - 999

枚举值：

• PER

• WHOLE

bandwidth.charge_mode

否

Array

• 功能说明：根据charge_mode过滤

数组长度：0 - 999

枚举值：

• bandwidth

• traffic

• 95peak_plus

billing_info

否

Array

• 功能说明：根据billing_info过滤

数组长度：0 - 999

billing_mode

否

String

• 功能说明：根据订单模式过滤,

• 取值范围：YEARLY_MONTHLY、PAY_PER_USE

枚举值：

• YEARLY_MONTHLY

• PAY_PER_USE

associate_instance_type

否

Array

• 功能说明：根据associate_instance_type过滤

• 取值范围：PORT、NATGW、ELB、VPN、ELBV1

• 约束：ELBV1资源中国站已下线，目前仅存在国际站与和营云局点

数组长度：0 - 999

枚举值：

• PORT

• NATGW

• ELB

• VPN

• ELBV1

associate_instance_id

否

Array

• 功能说明：根据associate_instance_id过滤

数组长度：0 - 999

enterprise_project_id

否

Array

• 功能说明：根据enterprise_project_id过滤

数组长度：0 - 999

public_border_group

否

Array

• 功能说明：根据public_border_group过滤

数组长度：0 - 999

allow_share_bandwidth_type_any

否

Array

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

数组长度：0 - 999

request_id

String

本次请求的编号

最小长度：0

最大长度：36

publicips

Array of PublicipSingleShowResp objects

弹性公网IP对象

数组长度：0 - 9999

page_info

PageInfoOption object

分页页码信息

total_count

Integer

公网IP总条目数

最小值：0

最大值：999999

id

String

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

最小长度：0

最大长度：36

project_id

String

• 功能说明：项目ID

最小长度：0

最大长度：32

ip_version

Integer

• 功能说明：IP版本信息

• 取值范围：

  • 4：公网IP地址为public_ip_address地址

  • 6：公网IP地址为public_ipv6_address地址

枚举值：

• 4

• 6

public_ip_address

String

• 功能说明：弹性公网IP或者IPv6端口的地址

最小长度：0

最大长度：36

public_ipv6_address

String

• 功能说明：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址

最小长度：0

最大长度：64

network_type

String

• 功能说明：弹性公网IP的网络类型。废弃，功能由publicip_pool_name继承，默认不显示

最小长度：0

最大长度：64

status

String

• 功能说明：弹性公网IP的状态

• 取值范围：

  • FREEZED：冻结

  • BIND_ERROR：绑定失败

  • BINDING：绑定中

  • PENDING_DELETE：释放中

  • PENDING_CREATE：创建中

  • NOTIFYING：创建中

  • NOTIFY_DELETE：释放中

  • PENDING_UPDATE：更新中

  • DOWN：未绑定

  • ACTIVE：绑定

  • ELB：绑定ELB

  • VPN：绑定VPN

  • ERROR：失败

最小长度：0

最大长度：64

枚举值：

• FREEZED

• BIND_ERROR

• BINDING

• PENDING_DELETE

• PENDING_CREATE

• NOTIFYING

• NOTIFY_DELETE

• PENDING_UPDATE

• DOWN

• ACTIVE

• ELB

• VPN

• ERROR

description

String

• 功能说明：弹性公网IP描述信息

• 约束：用户以自定义方式标识资源，系统不感知

最小长度：0

最大长度：256

public_border_group

String

• 功能说明：表示中心站点资源或者边缘站点资源

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

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

最小长度：1

最大长度：64

created_at

String

• 功能说明：资源创建UTC时间

• 格式：yyyy-MM-ddTHH:mm:ssZ

最小长度：0

最大长度：64

updated_at

String

• 功能说明：资源更新UTC时间

• 格式：yyyy-MM-ddTHH:mm:ssZ

最小长度：0

最大长度：64

type

String

• 功能说明：弹性公网IP类型

最小长度：1

最大长度：36

枚举值：

• 弹性公网IP

• DUALSTACK

vnic

VnicInfo object

• 功能说明：公网IP绑定实例有PORT时，PORT的相关信息

• 约束：如果绑定的实例不依赖PORT，该对象为null

bandwidth

PublicipBandwidthInfo object

功能说明：公网IP绑定带宽信息

enterprise_project_id

String

功能说明：企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

最小长度：0

最大长度：36

billing_info

String

• 功能说明：公网IP的订单信息

• 约束：包周期才会有订单信息，按需资源此字段为空

最小长度：0

最大长度：256

lock_status

String

• 功能说明：记录公网IP当前的冻结状态

• 约束：metadata类型，标识欠费冻结、公安冻结

• 取值范围：

  • police

  • locked

最小长度：0

最大长度：64

associate_instance_type

String

• 功能说明：公网IP绑定的实例类型

• 约束：ELBV1资源中国站已下线，目前仅存在国际站与和营云局点

• 取值范围：

  • PORT

  • NATGW

  • ELB

  • ELBV1

  • VPN

最小长度：0

最大长度：64

枚举值：

• PORT

• NATGW

• ELB

• ELBV1

• VPN

associate_instance_id

String

• 功能说明：公网IP绑定的实例ID

最小长度：0

最大长度：36

publicip_pool_id

String

• 功能说明：公网IP所属网络的ID，publicip_pool_name对应的网络ID

最小长度：0

最大长度：36

publicip_pool_name

String

• 功能说明：弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户购买的专属池。

• 专属池见publcip_pool相关接口

最小长度：0

最大长度：64

alias

String

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

最小长度：0

最大长度：64

profile

ProfileInfo object

• 功能说明：公网IP、元数据。（默认不显示）

fake_network_type

Boolean

• 功能说明：该字段仅仅用于表示eip的bgp类型是否是真实的静态sbgp * 1，如果为true，则该eip可以切换bgp类型 * 2； 如果为false，则该eip不可以切换bgp类型。（默认不显示）

枚举值：

• true

• false

tags

Array of strings

• 功能说明：用户标签。（默认不显示）

数组长度：0 - 9999

associate_instance_metadata

String

• 功能说明：记录实例的更上一层归属。例如associate_instance_type为PORT，此字段记录PORT的device_id和device_owner信息。仅有限场景记录。（默认不显示）

最小长度：1

最大长度：64

associate_mode

String

• 功能说明：开启支持直通模式后展示，表示直通模式的标识。（默认不显示）

最小长度：1

最大长度：36

allow_share_bandwidth_types

Array of strings

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

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

最大长度：64

数组长度：0 - 9999

cascade_delete_by_instance

Boolean

• 功能说明：表示该eip是否支持与实例同步删除。（默认不显示）

private_ip_address

String

• 功能说明：私网IP地址

最小长度：0

最大长度：36

device_id

String

• 功能说明：端口所属设备ID

• 约束：不支持设置和更新,由系统自动维护

最小长度：0

最大长度：36

device_owner

String

• 功能说明：设备所属

• 取值范围：合法设备所属

  • network:dhcp

  • network:VIP_PORT

  • network:router_interface_distributed

  • network:router_centralized_snat

• 约束：不支持设置和更新,由系统自动维护

最小长度：0

最大长度：64

vpc_id

String

• 功能说明：虚拟私有云ID

最小长度：0

最大长度：36

port_id

String

• 功能说明：端口ID

最小长度：0

最大长度：36

port_profile

String

• 功能说明：端口profile信息

最小长度：0

最大长度：256

mac

String

• 功能说明：端口MAC地址

• 约束：由系统分配,不支持指定

最小长度：0

最大长度：64

vtep

String

• 功能说明：VTEP IP

最小长度：0

最大长度：36

vni

String

• 功能说明：VXLAN ID

最小长度：0

最大长度：36

instance_id

String

• 功能说明：端口所属实例ID,例如RDS实例ID

• 约束：不支持设置和更新,由系统自动维护

最小长度：0

最大长度：36

instance_type

String

• 功能说明：端口所属实例类型,例如“RDS”

• 约束：不支持设置和更新,由系统自动维护

最小长度：0

最大长度：36

id

String

• 功能描述：带宽ID

最小长度：0

最大长度：36

size

Integer

• 功能描述：带宽大小

• 取值范围：默认5Mbit/s~2000Mbit/s

最小值：0

最大值：99999

share_type

String

• 功能说明：带宽类型，标识是否是共享带宽

• 取值范围：

  • PER：独享带宽

  • WHOLE：共享带宽

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

最小长度：0

最大长度：36

charge_mode

String

• 功能说明：按流量计费还是按带宽计费

• 取值范围：

  • bandwidth：按带宽计费

  • traffic：按流量计费

  • 95peak_plus：按增强型95计费

最小长度：0

最大长度：36

name

String

• 功能说明：带宽名称

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

最小长度：0

最大长度：64

billing_info

String

• 功能说明：账单信息。如果billinginfo不为空，说明是包周期的带宽

最小长度：0

最大长度：256

local_network_port

String

• 功能说明：公网IP附属的5_xxx网络（如5_bgp）中的port_id

最小长度：0

最大长度：36

standalone

Boolean

• 功能说明：标识公网IP是否是和虚机一起创建的。true-独立创建；false-和虚机一起创建

notify_status

String

• 功能说明：云服务标识公网IP创建进度, 弹性公网IP服务内部使用

最小长度：0

最大长度：36

枚举值：

• PENDING_CREATE

• PENDING_UPDATE

• NOTIFYING

• NOTIFYED

• NOTIFY_DELETE

create_time

String

• 功能说明：公网IP创建时间

最小长度：0

最大长度：64

fake_network_type

Boolean

• 功能说明：该字段仅仅用于表示eip的bgp类型是否是真实的静态sbgp * 1， 如果为true，则该eip可以切换bgp类型 * 2； 如果为false，则该eip不可以切换bgp类型

枚举值：

• true

• false

create_source

String

• 功能说明：标识IP是和哪类资源一起购买的

最小长度：0

最大长度：36

枚举值：

• ecs

ecs_id

String

• 功能说明：标识和公网IP一起购买的ecs的id

最小长度：0

最大长度：36

lock_status

String

• 功能说明：公网IP加锁状态, eg："POLICE,LOCKED"。POLICE-公安冻结；LOCKED-普通冻结；普通冻结细分状态：ARREAR-欠费；DELABLE-可删除；

最小长度：0

最大长度：36

freezed_status

String

• 功能说明：公网IP冻结状态。

最小长度：0

最大长度：36

枚举值：

• FREEZED

• UNFREEZED

bandwith_info

BandwidthInfoResp object

• 功能说明：公网IP绑定的带宽信息

bandwidth_name

String

• 功能说明：带宽名称

最小长度：0

最大长度：255

bandwidth_number

Integer

• 功能说明：带宽大小

最小值：0

最大值：2000

bandwidth_type

String

• 功能说明：带宽类型

最小长度：0

最大长度：36

枚举值：

• PER

• WHOLE

bandwidth_id

String

• 功能说明：带宽id

最小长度：36

最大长度：36

previous_marker

String

翻页时，作为前一页的marker取值

最小长度：0

最大长度：36

next_marker

String

翻页时，作为后一页的marker取值

最小长度：0

最大长度：36

current_count

Integer

当前页的数据总数

最小值：0

最大值：99999

200

GET正常返回