文档中心

云防火墙

互联网边界防火墙

AssetList - 查询互联网边界资产列表

AssetList - 查询互联网边界资产列表

根据资产开启状态查询资产列表信息。

请求说明

请求方式：POST

请求地址：https://fw-center.volcengineapi.com/?Action=AssetList&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	AssetList	接口名称。当前 API 的名称为 AssetList。
Version	String	是	2021-09-06	接口版本。当前 API 的版本为 2021-09-06。

Body

参数	类型	是否必选	示例值	描述
asset	String	否	192.168.1.1	用于模糊查询资产名称或资产 IP 地址的条件。
asset_type	Array of String	否	["ECS","CLB"]	精确查询资产的类型，可多选。支持的资产类型如下。 NAT：NAT 网关； ECS：云服务器； CLB：负载均衡； HAVIP：高可用虚拟 IP； ENI：弹性网卡； ALB：应用负载均衡； WAF：Web 应用防火墙说明该字段后续将废弃，推荐使用instance_type。
current_page	Integer	否	1	分页页码，默认值为 1。
order_dir	String	否	desc	7天流量峰值排序方式，默认降序。 asc：升序； desc：降序。
page_size	Integer	否	10	分页大小，默认值为10。
stat	Integer	否	0	查询条件，精确查询。开关状态，默认查询全部。 0：全部； 1：开； 2：关。
InternetFirewallId	String	否	ifw-****	互联网边界防火墙实例ID
ip_type	String	否	v4	精确查询资产的 IP 类型。支持的取值如下所示。 v4：IPv4 地址； v6：IPv6 地址。
region_code	Array of String	否	["cn-beijing","cn-shanghai"]	精确查询资产所在的地域，支持多选。例如 cn-beijing 表示北京地域，更多地域信息可参考地域和可用区列表。
instance_type	Array of String	否	["EcsInstance","Nat"]	精确查询资产的实例类型，支持多选。支持的实例类型如下。 EcsInstance：云服务器； NetworkInterface：网卡； HaVip：高可用虚拟 IP； Nat：NAT 网关； ClbInstance：负载均衡； AlbInstance：应用型负载均衡； VpnGateway：VPN 网关； WafInstance：Web 应用防火墙。

返回参数

参数	类型	示例值	描述
Count	Integer	10	返回数据的实际数量，当查询数据为空且使用 python SDK 调用时此项为 None。
Data	Array of AssetDetail	-	互联网边界资产的列表详情，包含资产的 IP 地址、名称、类型、EIP标识符、防护开关状态、地域信息等。
PageNumber	Integer	1	返回数据的分页页码，表示当前查询结果所在的页码。
PageSize	Integer	10	返回数据的分页大小，表示每页返回的数据条目数量。
TotalCount	Integer	100	返回数据的总数量，当查询数据为空且使用 python SDK 调用时此项为 None。

AssetDetail

参数	类型	示例值	描述
ip	String	180.1.1.1	资产的 IP地址。
name	String	my-asset	资产的名称，用于标识互联网边界资产的唯一标识符。
type	String	ECS	资产的类型，表示互联网边界资产的具体分类，可能的取值如下所示。 NAT：NAT 网关； ECS：云服务器； CLB：负载均衡； HAVIP：高可用虚拟 IP； ENI：弹性网卡； ALB：应用负载均衡； WAF：Web 应用防火墙。说明该字段后续将废弃，推荐使用instance_type。
eip_id	String	eip-12345678	资产的 EIP（弹性公网 IP）标识符，用于唯一标识与资产关联的弹性公网 IP资源。
enable	Boolean	true	防护开关，用于控制互联网边界资产的防护状态，取值如下所示。 false：关闭防护； true：开启防护。
region	String	cn-beijing	资产所属地域 ID。
ip_type	String	v4	资产的 IP 地址类型，用于标识互联网边界资产所使用的 IP 协议版本。支持的取值如下所示。 v4：IPv4 地址； v6：IPv6地址。
regionN	String	华北地区（北京）	资产所属地域的名称，用于标识互联网边界资产所在的具体地理位置。
AccountID	String	200*******	用户的唯一标识符，用于标识资产所属的账户。
InstanceID	String	i-********	实例的唯一标识符。
instance_type	String	EcsInstance	实例的类型，用于标识互联网边界资产的具体实例分类。支持的取值如下所示。 EcsInstance：云服务器； NetworkInterface：网卡； HaVip：高可用虚拟 IP； Nat：NAT 网关； ClbInstance：负载均衡； AlbInstance：应用型负载均衡； VpnGateway：VPN 网关； WafInstance：Web 应用防火墙。
latest_7_days_peak_traffic	Integer	1000	最近 7 天内的峰值流量，单位为 bits/s。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.08.11 12:01:33

这个页面对您有帮助吗？

有用

有用

无用

无用