计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 弹性公网IP/ 全量查询弹性公网IP列表

全量查询弹性公网IP列表

更新时间:2025-02-08 GMT+08:00

功能介绍

查询弹性公网IP列表信息

URI

GET /v3/{project_id}/eip/publicips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

  • 功能说明:项目ID

最小长度:0

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

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

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过滤

ip_version

Array

  • 功能说明:根据ip_version过滤
  • 取值范围:4、6

枚举值:

  • 4
  • 6

public_ip_address

Array

  • 功能说明:根据public_ip_address过滤

public_ip_address_like

String

  • 功能说明:根据public_ip_address过滤,模糊搜索

最小长度:0

最大长度:64

public_ipv6_address

Array

  • 功能说明:根据public_ipv6_address过滤

public_ipv6_address_like

String

  • 功能说明:根据public_ipv6_address过滤,模糊搜索

最小长度:0

最大长度:64

type

Array

  • 功能说明:根据type过滤
  • 取值范围:
    • EIP: 弹性公网IP
    • DUALSTACK: 双栈IPV6

枚举值:

  • EIP
  • DUALSTACK

network_type

Array

  • 功能说明:根据network_type过滤
  • 取值范围:5_telcom、5_union、5_bgp、5_sbgp、5_ipv6、5_graybgp

枚举值:

  • 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、专属池名称等

status

Array

  • 功能说明:根据status过滤
  • 取值范围:FREEZED、DOWN、ACTIVE、ERROR

枚举值:

  • FREEZED
  • DOWN
  • ACTIVE
  • ERROR

alias_like

String

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

最小长度:0

最大长度:64

alias

Array

  • 功能说明:根据alias过滤

description

Array

  • 功能说明:根据description过滤

vnic.private_ip_address

Array

  • 功能说明:根据private_ip_address过滤

vnic.private_ip_address_like

String

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

最小长度:0

最大长度:64

vnic.device_id

Array

  • 功能说明:根据device_id过滤

vnic.device_owner

Array

  • 功能说明:根据device_owner过滤

vnic.vpc_id

Array

  • 功能说明:根据vpc_id过滤

vnic.port_id

Array

  • 功能说明:根据port_id过滤

vnic.device_owner_prefixlike

String

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

最小长度:0

最大长度:64

vnic.instance_type

Array

  • 功能说明:根据instance_type过滤

vnic.instance_id

Array

  • 功能说明:根据instance_id过滤

bandwidth.id

Array

  • 功能说明:根据id过滤

bandwidth.name

Array

  • 功能说明:根据name过滤

bandwidth.name_like

Array

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

bandwidth.size

Array

  • 功能说明:根据size过滤

bandwidth.share_type

Array

  • 功能说明:根据share_type过滤

枚举值:

  • PER
  • WHOLE

bandwidth.charge_mode

Array

  • 功能说明:根据charge_mode过滤

枚举值:

  • bandwidth
  • traffic
  • 95peak_plus

billing_info

Array

  • 功能说明:根据billing_info过滤

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

枚举值:

  • PORT
  • NATGW
  • ELB
  • VPN
  • ELBV1

associate_instance_id

Array

  • 功能说明:根据associate_instance_id过滤

enterprise_project_id

Array

  • 功能说明:根据enterprise_project_id过滤

public_border_group

Array

  • 功能说明:根据public_border_group过滤

allow_share_bandwidth_type_any

Array

  • 功能说明:共享带宽类型,根据任一共享带宽类型过滤EIP列表。可以指定多个带宽类型,不同的带宽类型间用逗号分隔。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

最小长度:0

最大长度:36

publicips

Array of PublicipSingleShowResp objects

弹性公网IP对象

page_info

PageInfoOption object

分页页码信息

total_count

Integer

公网IP总条目数

最小值:0

最大值:999999

表4 PublicipSingleShowResp

参数

参数类型

描述

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

枚举值:

  • EIP
  • 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绑定的实例类型
  • 取值范围:
    • PORT
    • NATGW
    • ELB
    • ELBV1
    • VPN
    • null

最小长度:0

最大长度:64

枚举值:

  • PORT
  • NATGW
  • ELB
  • ELBV1
  • VPN
  • null

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,如果为true,则该eip可以切换bgp类型; 如果为false,则该eip不可以切换bgp类型。(默认不显示)

枚举值:

  • true
  • false

tags

Array of strings

  • 功能说明:用户标签。(默认不显示)

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

cascade_delete_by_instance

Boolean

  • 功能说明:表示该eip是否支持与实例同步删除。(默认不显示)
表5 VnicInfo

参数

参数类型

描述

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

port_vif_details

String

  • 功能说明:网卡虚拟接口的详细信息

最小长度:0

最大长度:255

表6 PublicipBandwidthInfo

参数

参数类型

描述

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

表7 ProfileInfo

参数

参数类型

描述

local_network_port

String

  • 功能说明:公网IP附属的5_xxx网络(如5_bgp)中的port_id

最小长度:0

最大长度:36

standalone

Boolean

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

notify_status

String

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

最小长度: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绑定的带宽信息
表8 BandwidthInfoResp

参数

参数类型

描述

bandwidth_name

String

  • 功能说明:带宽名称

最小长度:0

最大长度:256

bandwidth_number

Integer

  • 功能说明:带宽大小

最小值:0

最大值:99999

bandwidth_type

String

  • 功能说明:带宽类型

枚举值:

  • PER
  • WHOLE

bandwidth_id

String

  • 功能说明:带宽id

最小长度:0

最大长度:36

表9 PageInfoOption

参数

参数类型

描述

previous_marker

String

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

最小长度:0

最大长度:36

next_marker

String

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

最小长度:0

最大长度:36

current_count

Integer

当前页的数据总数

最小值:0

最大值:99999

请求示例

响应示例

状态码: 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,
      "port_vif_details": ""
    },
    "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
}

状态码

请参见状态码

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容