文档首页/ 云防火墙 CFW/ API参考 (联盟区域) / API/ EIP管理/ 弹性IP列表查询
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

弹性IP列表查询

功能介绍

弹性IP列表查询

URI

GET /v1/{project_id}/eips/protect

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式
表2 Query参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。

key_word

否

String

查询防护EIP列表关键字，可选用弹性公网ID和弹性公网IP

status

否

String

防护状态 null-全部 0-开启防护 1-关闭防护

sync

否

Integer

是否同步租户EIP数据 0-不同步 1-同步

limit

是

Integer

每页显示个数，范围为1-1024

offset

是

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

device_key

否

String

设备关键字，是eip绑定的资产的名称或id

address_type

否

Integer

地址Internet协议类型0 ipv4，1 ipv6

fw_instance_id

否

String

防火墙id，可通过防火墙ID获取方式获取

fw_key_word

否

String

防火墙关键字，可使用防火墙id或名称查询，可通过防火墙ID获取方式

eps_id

否

String

弹性公网ip的企业项目id，可通过如何获取企业项目ID获取，租户未开启企业项目时为0

tags

否

String

标签列表信息可通过查询EIP服务界面列表标签页签获得

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

EipResponseData object

查询eip返回data
表5 EipResponseData

参数

参数类型

描述

limit

Integer

每页显示个数，范围为1-1024

offset

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

total

Integer

查询获得EIP列表总数

records

Array of EipResource objects

eip资源记录
表6 EipResource

参数

参数类型

描述

id

String

弹性公网ID

public_ip

String

弹性公网IP

status

Integer

EIP防护状态，0表示防护中，1表示未防护

public_ipv6

String

弹性公网IP,IPV6类型

enterprise_project_id

String

Eip所在账户企业项目id

device_id

String

EIP绑定设备（如ecs，nat）id

device_name

String

EIP绑定设备（如ecs，nat）名称

device_owner

String

EIP绑定设备（如ecs，nat）拥有者

associate_instance_type

String

关联实例类型，包括：NATGW，ELB，PORT等。

fw_instance_name

String

防火墙名称

fw_instance_id

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。

fw_enterprise_project_id

String

Eip绑定的防火墙企业项目id

object_id

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。

tags

String

标签列表

domain_id

String

EIP所属用户id，可通过获取账号、IAM用户、项目、用户组、区域、委托的名称和ID获取。

fw_domain_id

String

防火墙所属用户，可通过获取账号、IAM用户、项目、用户组、区域、委托的名称和ID获取。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象id为cfebd347-b655-4b84-b938-3c54317599b2，非同步的第一页的数据

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eips/protect?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&sync=0

响应示例

状态码：200

EIP数据查询返回值

{
  "data" : {
    "limit" : 200,
    "offset" : 0,
    "records" : [ {
      "associate_instance_type" : "PORT",
      "device_id" : "c87579ab-c76a-4afd-83ce-62e0f531f13e",
      "device_name" : "test",
      "device_owner" : "compute:test",
      "domain_id" : "7d07807209524a4280266db9df63c4fa",
      "enterprise_project_id" : "0",
      "fw_domain_id" : "7d07807209524a4280266db9df63c4fa",
      "fw_enterprise_project_id" : "default",
      "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
      "fw_instance_name" : "test",
      "id" : "465b34fe-e017-4831-a21c-9c6c753bb1f2",
      "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
      "public_ip" : "100.85.223.15",
      "status" : 0,
      "tags" : "combined_order_id=CBRCS23040615138M2KW912"
    } ],
    "total" : 1
  }
}

状态码：400

Bad Request

{
  "error_code" : "CFW.00109004",
  "error_msg" : "HTTP请求错误"
}

状态码

状态码

描述

200

EIP数据查询返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： EIP管理