云防火墙 CFW-弹性IP列表查询:响应参数

时间:2024-10-31 19:35:56

响应参数

状态码: 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

错误描述

support.huaweicloud.com/api-cfw/ListEips.html