租户端 安全 云防火墙（CFW） 通用相关接口 DescribeAddressTemplateList

DescribeAddressTemplateList

最近更新时间: 2025-10-20 17:06:11

1. 接口描述

接口请求域名： cfw.api3.fincloud.tencent.cn。

查询地址模板列表

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

接口更新时间：2023-09-11 01:24:13。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeAddressTemplateList
Version 是 否 String 公共参数，本接口取值：2019-09-04
Region 是 否 String 公共参数，地域信息本接口不需要传递此参数。
By 否 否 String 此参数对外不可见。
排序字段，取值 'UpdateTime' | 'RulesNum'
Limit 否 否 Int64 此参数对外不可见。
条数，分页用
Offset 否 否 Int64 此参数对外不可见。
偏移量，分页用
Order 否 否 String 此参数对外不可见。
排序，取值 'asc'|'desc'
SearchValue 否 否 String 此参数对外不可见。
搜索值
ShowDelete 否 否 Bool 此参数对外不可见。
是否展示已删除数据
TemplateId 否 否 String 此参数对外不可见。
模板Id
TemplateType 否 否 String 此参数对外不可见。
1：ip模板，5：域名模板，6：协议端口模板
Uuid 否 否 String 此参数对外不可见。
检索地址模板唯一id

3. 输出参数

参数名称 类型 描述
Data TemplateListInfo 此参数对外不可见。
模板列表数据
DomainTemplateCount Int64 此参数对外不可见。
域名地址模板数量
IpTemplateCount Int64 此参数对外不可见。
Ip地址模板数量
NameList String 此参数对外不可见。
模板名称列表
PortTemplateCount Int64 此参数对外不可见。
协议端口模板数量
TemplateQuotaCount Int64 此参数对外不可见。
地址模板配额数量
Total Int64 此参数对外不可见。
模板总数
UsedTemplateCount Int64 此参数对外不可见。
已使用的地址模板数
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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