云防火墙查询全部资产信息-资产中心相关接口-API 中心-腾讯云

1. 接口描述

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

DescribeSourceAsset-查询全部资产信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSourceAsset。
Version	是	String	公共参数，本接口取值：2019-09-04。
Region	否	String	公共参数，本接口不需要传递此参数。
ChooseType	否	String	ChooseType为1，查询已经分组的资产；ChooseType不为1查询没有分组的资产示例值：1
FuzzySearch	否	String	模糊查询示例值：ins
InsType	否	String	资产类型 1公网 2内网示例值：1
Limit	否	Integer	查询单页的最大值；eg：10；则最多返回10条结果示例值：10
Offset	否	Integer	查询结果的偏移量示例值：0
Zone	否	String	地域示例值：ap-shanghai

3. 输出参数

参数名称	类型	描述
Data	Array of InstanceInfo	数据示例值：[{"AppId":"1300448055","Region":"ap-chengdu","RegionKey":"AP-CHENGDU","VpcId":"vpc-n7k5rwjg","SubnetId":"subnet-oq7vudkb","InstanceId":"eni-2npbqunq","InstanceName":"eth1","InsType":5,"PublicIp":"148.70.225.68","PrivateIp":"10.27.0.20,10.27.0.21,10.27.0.22,10.27.0.23,10.27.0.24,10.27.0.25,10.27.0.26,10.27.0.27,10.27.0.28,10.27.0.8","PortNum":"1","LeakNum":"1","VPCName":"vpc1","InsSource":"1","ResourcePath":["/全部资产/测试环境/","/全部资产/测试环境/DMZ隔离区/"],"Server":["dns"]}]
Total	Integer	返回数据总数示例值：53
ZoneList	Array of AssetZone	地域集合示例值：[{"Zone":"ap-guangzhou","ZoneEng":"广州"},{"Zone":"ap-beijing","ZoneEng":"北京"},{"Zone":"ap-singapore","ZoneEng":"新加坡"},{"Zone":"ap-chengdu","ZoneEng":"成都"},{"Zone":"ap-shanghai","ZoneEng":"上海"},{"Zone":"ap-nanjing","ZoneEng":"南京"},{"Zone":"ap-hongkong","ZoneEng":"中国香港"},{"Zone":"ap-wuhan-ec","ZoneEng":"武汉EC"},{"Zone":"ap-chongqing","ZoneEng":"重庆"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeSourceAsset-查询全部资产信息

DescribeSourceAsset-查询全部资产信息

输入示例

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

{
    "ChooseType": "0",
    "FuzzySearch": "ins",
    "InsType": "1",
    "Limit": 10,
    "Offset": 0,
    "Zone": "ap-chengdu"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "AppId": "1300448055",
                "Region": "ap-chengdu",
                "RegionKey": "AP-CHENGDU",
                "VpcId": "vpc-n7k5rwjg",
                "SubnetId": "subnet-oq7vudkb",
                "InstanceId": "eni-2npbqunq",
                "InstanceName": "eth1",
                "InsType": 5,
                "PublicIp": "148.70.225.68",
                "PrivateIp": "10.27.0.20,10.27.0.21,10.27.0.22,10.27.0.23,10.27.0.24,10.27.0.25,10.27.0.26,10.27.0.27,10.27.0.28,10.27.0.8",
                "PortNum": "1",
                "LeakNum": "1",
                "VPCName": "vpc1",
                "InsSource": "1",
                "ResourcePath": [
                    "/全部资产/测试环境/",
                    "/全部资产/测试环境/DMZ隔离区/"
                ],
                "Server": [
                    "dns"
                ]
            }
        ],
        "RequestId": "c6d441d3-1871-4913-ac41-b552324fa895",
        "Total": 53,
        "ZoneList": [
            {
                "Zone": "ap-guangzhou",
                "ZoneEng": "广州"
            },
            {
                "Zone": "ap-beijing",
                "ZoneEng": "北京"
            },
            {
                "Zone": "ap-singapore",
                "ZoneEng": "新加坡"
            },
            {
                "Zone": "ap-chengdu",
                "ZoneEng": "成都"
            },
            {
                "Zone": "ap-shanghai",
                "ZoneEng": "上海"
            },
            {
                "Zone": "ap-nanjing",
                "ZoneEng": "南京"
            },
            {
                "Zone": "ap-hongkong",
                "ZoneEng": "中国香港"
            },
            {
                "Zone": "ap-wuhan-ec",
                "ZoneEng": "武汉EC"
            },
            {
                "Zone": "ap-chongqing",
                "ZoneEng": "重庆"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameter	参数错误。

查询全部资产信息

本页目录：