AssetList - 查询互联网边界资产列表--云防火墙-火山引擎

文档中心

立即注册

导航

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

最近更新时间：2025.05.29 17:45:46首次发布时间：2024.03.28 17:09:34

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

请求说明

请求方式：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` `ECS` `CLB` `HAVIP` `ENI` `ALB` `WAF`
current_page	Integer	否	`1`	分页页码，默认值为 `1`。
order_dir	String	否	`desc`	7天流量峰值排序方式，默认降序。 `asc`：升序； `desc`：降序。
page_size	Integer	否	`10`	分页大小，默认值为`10`。
stat	Integer	否	`0`	查询条件，精确查询。开关状态，默认查询全部。 `0`：全部； `1`：开； `2`：关。

返回参数

参数	类型	示例值	描述
Count	Integer	`10`	返回数据的实际数量，当查询数据为空且使用 `python SDK` 调用时此项为 `None`。
Data	Array of AssetDetail	`--`	列表详情。
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 应用防火墙。
eip_id	String	`eip-12345678`	资产的 `EIP`（弹性公网 `IP`）标识符，用于唯一标识与资产关联的弹性公网 `IP` 资源。
enable	Boolean	`true`	防护开关，用于控制互联网边界资产的防护状态，取值如下所示。 `false`：关闭防护； `true`：开启防护。
region	String	`cn-beijing`	资产所属地域 ID。
ip_type	String	`v4`	IP类型 - v4 - v6
regionN	String	`华北地区（北京）`	资产所属地域的名称，用于标识互联网边界资产所在的具体地理位置。
AccountID	String	`200*******`	用户的唯一标识符，用于标识资产所属的账户。
InstanceID	String	`i-********`	实例的唯一标识符。
latest_7_days_peak_traffic	Integer	`1000`	最近 `7` 天内的峰值流量，单位为 `bits/s`。

请求示例

POST https://fw_center.volcengineapi.com/?Action=AssetList&Version=2021-09-06
{
    "asset": "192.168.1.1",
    "asset_type": [
        "ECS",
        "CLB"
    ],
    "current_page": 1,
    "order_dir": "desc",
    "page_size": 10,
    "stat": 0
}

返回示例

{
    "ResponseMetadata": {
        "Action": "AssetList",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Count": 1,
        "Data": [
            {
                "ip": "180.*.*.*",
                "name": "ecs-test",
                "type": "ECS",
                "eip_id": "eip-****",
                "enable": true,
                "region": "cn-beijing",
                "regionN": "华北",
                "AccountID": "200*******",
                "InstanceID": "i-********",
                "latest_7_days_peak_traffic": 1000
            }
        ],
        "PageNumber": 1,
        "PageSize": 1,
        "TotalCount": 1
    }
}

错误码

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