全量查询弹性公网IP列表
功能介绍
查询弹性公网IP列表信息
URI
GET /v3/{project_id}/eip/publicips
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
最小长度:0 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
最小长度:0 最大长度:36 |
offset |
否 |
Integer |
最小值:0 最大值:99999 |
limit |
否 |
Integer |
最小值:0 最大值:2000 |
fields |
否 |
Array |
|
sort_key |
否 |
String |
枚举值:
|
sort_dir |
否 |
String |
枚举值:
|
id |
否 |
Array |
|
ip_version |
否 |
Array |
枚举值:
|
public_ip_address |
否 |
Array |
|
public_ip_address_like |
否 |
String |
最小长度:0 最大长度:64 |
public_ipv6_address |
否 |
Array |
|
public_ipv6_address_like |
否 |
String |
最小长度:0 最大长度:64 |
type |
否 |
Array |
枚举值:
|
network_type |
否 |
Array |
枚举值:
|
publicip_pool_name |
否 |
Array |
|
status |
否 |
Array |
枚举值:
|
alias_like |
否 |
String |
最小长度:0 最大长度:64 |
alias |
否 |
Array |
|
description |
否 |
Array |
|
vnic.private_ip_address |
否 |
Array |
|
vnic.private_ip_address_like |
否 |
String |
最小长度:0 最大长度:64 |
vnic.device_id |
否 |
Array |
|
vnic.device_owner |
否 |
Array |
|
vnic.vpc_id |
否 |
Array |
|
vnic.port_id |
否 |
Array |
|
vnic.device_owner_prefixlike |
否 |
String |
最小长度:0 最大长度:64 |
vnic.instance_type |
否 |
Array |
|
vnic.instance_id |
否 |
Array |
|
bandwidth.id |
否 |
Array |
|
bandwidth.name |
否 |
Array |
|
bandwidth.name_like |
否 |
Array |
|
bandwidth.size |
否 |
Array |
|
bandwidth.share_type |
否 |
Array |
枚举值:
|
bandwidth.charge_mode |
否 |
Array |
枚举值:
|
billing_info |
否 |
Array |
|
billing_mode |
否 |
String |
枚举值:
|
associate_instance_type |
否 |
Array |
枚举值:
|
associate_instance_id |
否 |
Array |
|
enterprise_project_id |
否 |
Array |
|
public_border_group |
否 |
Array |
|
allow_share_bandwidth_type_any |
否 |
Array |
|
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
本次请求的编号 最小长度:0 最大长度:36 |
publicips |
Array of PublicipSingleShowResp objects |
弹性公网IP对象 |
page_info |
PageInfoOption object |
分页页码信息 |
total_count |
Integer |
公网IP总条目数 最小值:0 最大值:999999 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
最小长度:0 最大长度:36 |
project_id |
String |
最小长度:0 最大长度:32 |
ip_version |
Integer |
枚举值:
|
public_ip_address |
String |
最小长度:0 最大长度:36 |
public_ipv6_address |
String |
最小长度:0 最大长度:64 |
network_type |
String |
最小长度:0 最大长度:64 |
status |
String |
最小长度:0 最大长度:64 枚举值:
|
description |
String |
最小长度:0 最大长度:256 |
public_border_group |
String |
最小长度:1 最大长度:64 |
created_at |
String |
最小长度:0 最大长度:64 |
updated_at |
String |
最小长度:0 最大长度:64 |
type |
String |
最小长度:1 最大长度:36 枚举值:
|
vnic |
VnicInfo object |
|
bandwidth |
PublicipBandwidthInfo object |
功能说明:公网IP绑定带宽信息 |
enterprise_project_id |
String |
功能说明:企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。创建弹性公网IP时,给弹性公网IP绑定企业项目ID。 最小长度:0 最大长度:36 |
billing_info |
String |
最小长度:0 最大长度:256 |
lock_status |
String |
最小长度:0 最大长度:64 |
associate_instance_type |
String |
最小长度:0 最大长度:64 枚举值:
|
associate_instance_id |
String |
最小长度:0 最大长度:36 |
publicip_pool_id |
String |
最小长度:0 最大长度:36 |
publicip_pool_name |
String |
最小长度:0 最大长度:64 |
alias |
String |
最小长度:0 最大长度:64 |
profile |
ProfileInfo object |
|
fake_network_type |
Boolean |
枚举值:
|
tags |
Array of strings |
|
associate_instance_metadata |
String |
最小长度:1 最大长度:64 |
associate_mode |
String |
最小长度:1 最大长度:36 |
allow_share_bandwidth_types |
Array of strings |
最大长度:64 |
cascade_delete_by_instance |
Boolean |
|
参数 |
参数类型 |
描述 |
---|---|---|
private_ip_address |
String |
最小长度:0 最大长度:36 |
device_id |
String |
最小长度:0 最大长度:36 |
device_owner |
String |
最小长度:0 最大长度:64 |
vpc_id |
String |
最小长度:0 最大长度:36 |
port_id |
String |
最小长度:0 最大长度:36 |
port_profile |
String |
最小长度:0 最大长度:256 |
mac |
String |
最小长度:0 最大长度:64 |
vtep |
String |
最小长度:0 最大长度:36 |
vni |
String |
最小长度:0 最大长度:36 |
instance_id |
String |
最小长度:0 最大长度:36 |
instance_type |
String |
最小长度:0 最大长度:36 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
最小长度:0 最大长度:36 |
size |
Integer |
最小值:0 最大值:99999 |
share_type |
String |
最小长度:0 最大长度:36 |
charge_mode |
String |
最小长度:0 最大长度:36 |
name |
String |
最小长度:0 最大长度:64 |
billing_info |
String |
最小长度:0 最大长度:256 |
参数 |
参数类型 |
描述 |
---|---|---|
local_network_port |
String |
最小长度:0 最大长度:36 |
standalone |
Boolean |
|
notify_status |
String |
最小长度:0 最大长度:36 枚举值:
|
create_time |
String |
最小长度:0 最大长度:64 |
fake_network_type |
Boolean |
枚举值:
|
create_source |
String |
最小长度:0 最大长度:36 枚举值:
|
ecs_id |
String |
最小长度:0 最大长度:36 |
lock_status |
String |
最小长度:0 最大长度:36 |
freezed_status |
String |
最小长度:0 最大长度:36 枚举值:
|
bandwith_info |
BandwidthInfoResp object |
|
请求示例
无
响应示例
状态码: 200
GET正常返回
{ "page_info" : { "current_count" : 1, "next_marker" : "0490aeae-ab8f-4764-b012-45645e9c0aa9", "previous_marker" : "0490aeae-ab8f-4764-b012-45645e9c0aa9" }, "publicips" : [ { "created_at" : "2022-03-17T09:46:22Z", "updated_at" : "2022-03-30T02:46:04Z", "lock_status" : null, "allow_share_bandwidth_types" : [ "bgp", "sbgp", "share", "share_yidongdanxian", "share_youxuan" ], "id" : "006343a1-32bf-4361-958a-efd158153dd0", "alias" : null, "project_id" : "060576787a80d5762fa2c00f07ddfcf4", "ip_version" : 4, "public_ip_address" : "88.88.1.141", "public_ipv6_address" : null, "status" : "DOWN", "description" : "", "enterprise_project_id" : "0", "billing_info" : null, "type" : "EIP", "vnic" : { "private_ip_address" : "172.16.1.235", "device_id" : "", "device_owner" : "", "vpc_id" : "1c30f428-9741-48b2-a788-0b2f359705eb", "port_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "mac" : "fa:16:3e:3a:22:66", "vtep" : null, "vni" : null, "instance_id" : "", "instance_type" : "", "port_profile" : null }, "bandwidth" : { "id" : "149ff19b-5de4-4436-958f-2eca39952e93", "size" : 100, "share_type" : "PER", "charge_mode" : "traffic", "name" : "bandwidth-xym-br-eqos", "billing_info" : "" }, "associate_instance_type" : "PORT", "associate_instance_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "publicip_pool_id" : "9af5f2e5-1765-4b86-b342-ece52e785c8b", "publicip_pool_name" : "5_union", "public_border_group" : "center", "tags" : [ "key=value" ] } ], "request_id" : "c4962d006b34af3c2343de7f88ef65e3", "total_count" : 100 }
状态码
请参见状态码。
错误码
请参见错误码。