云防火墙查询地址模板列表-通用相关接口-API 中心-腾讯云

1. 接口描述

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

查询地址模板列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAddressTemplateList。
Version	是	String	公共参数，本接口取值：2019-09-04。
Region	否	String	公共参数，本接口不需要传递此参数。
Offset	否	Integer	偏移量，分页用示例值：0
Limit	否	Integer	条数，分页用示例值：10
By	否	String	排序字段，取值：UpdateTime最近更新时间，RulesNum关联规则数示例值：UpdateTime
Order	否	String	排序，取值：asc正序，desc逆序示例值：desc
SearchValue	否	String	搜索值示例值：name
Uuid	否	String	检索地址模板唯一id 示例值：mb_appid_1704179380581
TemplateType	否	String	模板类型，取值：1：ip模板，5：域名模板，6：协议端口模板示例值：1
TemplateId	否	String	模板Id 示例值：ip-d5fbfc11

3. 输出参数

参数名称	类型	描述
Total	Integer	模板总数示例值：100
Data	Array of TemplateListInfo	模板列表数据示例值：[{"Detail":"","IPNum":4,"InsertTime":"2024-02-21 16:33:11","IpString":"10.222.0.0/16,10.222.0.14,10.26.26.11,10.115.1.12","IpVersion":0,"Name":"出向白名单","ProtocolType":"","RulesNum":5,"TemplateId":"ip-863papye","Type":1,"UpdateTime":"2024-09-11 10:14:42","Uuid":"mb_appid_1708504391199"}]
NameList	Array of String	模板名称列表示例值：['name']
IpTemplateCount	Integer	Ip地址模板数量示例值：20
DomainTemplateCount	Integer	域名地址模板数量示例值：30
PortTemplateCount	Integer	协议端口模板数量示例值：50
UsedTemplateCount	Integer	已使用的地址模板数示例值：10
TemplateQuotaCount	Integer	地址模板配额数量示例值：100
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询地址模板列表

输入示例

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

{
    "Offset": 0,
    "Limit": 20,
    "SearchValue": "出向白名单",
    "TemplateType": "1"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Detail": "放通出方向目的ip",
                "IPNum": 4,
                "InsertTime": "2024-02-21 16:33:11",
                "IpString": "10.222.0.0/16,10.222.0.14,10.26.26.11,10.115.1.12",
                "IpVersion": 0,
                "Name": "出向白名单",
                "ProtocolType": "4",
                "RulesNum": 5,
                "TemplateId": "ip-863papye",
                "Type": 1,
                "UpdateTime": "2024-09-11 10:14:42",
                "Uuid": "mb_appid_1708504391199"
            }
        ],
        "DomainTemplateCount": 0,
        "IpTemplateCount": 1,
        "NameList": [
            "dora"
        ],
        "PortTemplateCount": 0,
        "RequestId": "f68d4fbb-4887-4fbb-91cb-e964131d5b4c",
        "TemplateQuotaCount": 300,
        "Total": 1,
        "UsedTemplateCount": 1
    }
}

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	参数错误。