帮你快速理解、总结文档立即下载
文档中心>云防火墙>API 文档>AI安全场景相关接口>查询防火墙纳管资产

查询防火墙纳管资产

最近更新时间：2026-07-21 01:27:28

我的收藏

本页目录：

1. 接口描述

接口请求域名： cfw.tencentcloudapi.com 。

查询当前租户防火墙纳管资产。首次查询传 AssetType、过滤条件和 Limit；Response.Data.HasMore=true 时，续查只传 NextToken。默认查询 host；broad 查询分页返回资产，exact InstanceId 查询分页返回该实例 fingerprints 且每页重复基础资产。仅明确需要 VPC 或子网时传 AssetType。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCfwAssets。
Version 是 String 公共参数，本接口取值：2019-09-04。
Region 否 String 公共参数，本接口不需要传递此参数。
AssetType 否 String

资产类型。可选，默认 host；枚举 host 主机资产、vpc VPC 网络、subnet 子网。


示例值：host
Ip 否 String

IP 地址过滤。可选，支持部分匹配；适用于 host。


示例值：10.0.0.8
InstanceId 否 String

实例 ID 过滤。可选，适用于 host。


示例值：ins-xxxxxxxx
VpcId 否 String

VPC ID 过滤。可选，适用于 host、vpc、subnet。


示例值：vpc-xxxxxxxx
SubnetId 否 String

子网 ID 过滤。可选，适用于 host、subnet。


示例值：subnet-xxxxxxxx
InstanceType 否 String

实例类型过滤。可选，适用于 host；常见值包括 CVM、CLB、ENI、POD、MYSQL、REDIS、MARIADB、NAT、VPN、HAVIP、NATFW、GAAP、DC。


示例值：CVM
Limit 否 Integer

最大返回资产数。可选，默认 100，最大 1000。


示例值：100
NextToken 否 String

上一页 Response.Data 返回的不透明资产或指纹续查 token。首次查询不传；续查时只传 NextToken，不能同时传 AssetType、过滤条件或 Limit。调用方无需区分 token 类型；无效、篡改或租户不匹配会被拒绝。


示例值：1.DH9BabXSdfHBbzQazv-0EMottHRmUm6-XBUkLVsIlP8wS_Xg1Y4ooB-C2paI_8sVqP0iLQ

3. 输出参数

参数名称 类型 描述
Data String

查询结果。UTF-8 JSON object 字符串；调用方需解析 Response.Data。


示例值：{"asset_type":"host","assets":null,"stats":{"returned":0,"total":0,"by_scope":{"private":50,"public":36},"by_region":{"ap-guangzhou":26,"ap-beijing":13,"ap-chengdu":12,"ap-shanghai":11,"other":24},"by_type":{"ENI":35,"HAVIP":15,"CVM":13,"other":23}}}
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 使用 NextToken 续查资产或指纹

资产或指纹续查都只传 NextToken，不要解析或构造 token；HasMore=false 时结束。

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwAssets
<公共请求参数>

{
    "NextToken": "opaque-token"
}

输出示例

{
    "Response": {
        "Data": "{\"asset_type\":\"host\",\"assets\":[{\"instance_id\":\"ins-xxxxxxxx\",\"fingerprints\":[{\"port\":80}]}],\"HasMore\":false}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例2 精确查询实例及指纹

exact InstanceId 每页重复基础资产，fingerprints 仅为当前页；HasMore=true 时使用 NextToken 续查剩余指纹。

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwAssets
<公共请求参数>

{
    "AssetType": "host",
    "InstanceId": "ins-xxxxxxxx"
}

输出示例

{
    "Response": {
        "Data": "{\"asset_type\":\"host\",\"assets\":[{\"instance_id\":\"ins-xxxxxxxx\",\"fingerprints\":[{\"port\":443}]}],\"HasMore\":true,\"NextToken\":\"opaque-token\"}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例3 首次查询主机资产

broad host 列表返回基础资产；如果 Data.HasMore 为 true，保存 Data.NextToken。

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwAssets
<公共请求参数>

{
    "AssetType": "host",
    "Limit": 20
}

输出示例

{
    "Response": {
        "Data": "{\"asset_type\":\"host\",\"assets\":[{\"instance_id\":\"ins-1\"}],\"HasMore\":true,\"NextToken\":\"opaque-token\"}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.ResponseTooLarge FailedOperation.ResponseTooLarge
InternalError 内部错误。
InvalidParameter 参数错误。
中国站