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

文档中心

立即注册

导航

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

最近更新时间：2024.11.25 17:03:53首次发布时间：2024.03.28 17:09:34

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

请求说明

请求方式：POST
请求地址：?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	否	`AssetName`	查询条件，模糊查询。资产名称/资产IP
asset_type	Array of String	否	`ECS`	查询条件，精确查询。资产类型: 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	`1`	返回数据的实际数量当查询数据为空时，且使用python SDK调用时此项为None
Data	Array of Asset	`--`	列表详情。
PageNumber	Integer	`1`	返回数据的分页页码
PageSize	Integer	`1`	返回数据的分页大小
TotalCount	Integer	`1`	返回数据总数量当查询数据为空时，且使用python SDK调用时此项为None

Asset

参数	类型	示例值	描述
ip	String	`180...*`	资产IP
name	String	`ecs-test`	资产名称
type	String	`ECS`	资产类型 NAT ECS CLB HAVIP ENI ALB WAF
eip_id	String	`eip-****`	EIP ID
enable	Boolean	`true`	防护开关： false - 关闭 true - 开启
region	String	`cn-beijing`	地域
regionN	String	`华北`	地域名称
AccountID	String	`200*******`	用户ID
InstanceID	String	`i-********`	实例ID
latest_7_days_peak_traffic	Integer	`1000`	最近7天峰值流量,单位bits/s

请求示例

POST ?Action=AssetList&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "asset": "AssetName",
    "asset_type": [
        "ECS"
    ],
    "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
    }
}