Web 应用防火墙获取防护域名列表-其他接口-API 中心-腾讯云

1. 接口描述

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

clb-waf中获取防护域名列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeHosts。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo 。
Domain	否	String	防护域名，如果是要查询某一具体的防护域名则传入此参数，要求是准确的域名，此参数不支持模糊搜索示例值：txwaf.qcloudwaf.com
DomainId	否	String	防护域名ID，如果是要查询某一具体的防护域名则传入此参数，要求是准确的域名ID，此参数不支持模糊搜索示例值：waf-u23yt9Hj
Search	否	String	搜索条件，根据此参数对域名做模糊搜索示例值：txwaf
Item	否	SearchItem	复杂的搜索条件示例值：{ "ClsStatus": 1, "Status": 1, "FlowMode": 1 }
InstanceID	否	String	实例id 示例值：waf_idnauit2adad

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	防护域名列表的长度示例值：10
HostList	Array of HostRecord	防护域名的列表示例值：[{ "Domain": "txcloudwaf.qcloudwaf.com", "DomainId": "waf-DhOzNw3D", "MainDomain": "qcloudwaf.com", "Mode": 1, "Status": 1, "State": 1, "Engine": 1, "IsCdn": 1, "LoadBalancerSet": [ { "LoadBalancerId": "lb-daiu3grtd", "LoadBalancerName": "txlb", "ListenerId": "lbl-daskhe2", "ListenerName": "80httpport", "Vip": "35.68.12.3", "Vport": 1, "Region": "gz", "Protocol": "http", "Zone": "ap-guangzhou", "NumericalVpcId": 3243, "LoadBalancerType": "open", "LoadBalancerDomain": "" } ], "Region": "gz", "Edition": "clb-waf", "FlowMode": 1, "ClsStatus": 1, "Level": 1, "CdcClusters": [ "cluster-o41khj88" ], "AlbType": "clb", "IpHeaders": [ "x-myreal-ip" ], "EngineType": 0, "CloudType": "public", "Note": "备注" }]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取防护域名列表

输入示例

https://waf.tencentcloudapi.com/?Action=DescribeHosts
&Domain=txwaf.qcloudwaf.com
&DomainId=waf-u23yt9Hj
&Search=txwaf
&InstanceID=waf_uadhiu2ads44a
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "HostList": [
            {
                "Domain": "txwaf.qcloudwaf.com",
                "DomainId": "waf-u23yt9Hj",
                "MainDomain": "qcloudwaf.com",
                "Mode": 1,
                "Status": 1,
                "State": 1,
                "Engine": 1,
                "IsCdn": 1,
                "LoadBalancerSet": [
                    {
                        "LoadBalancerId": "lb-ads3adsa",
                        "LoadBalancerName": "80http",
                        "ListenerId": "lbl-das32q",
                        "ListenerName": "80http",
                        "Vip": "23.25.123.23",
                        "Vport": 1,
                        "Region": "gz",
                        "Protocol": "http",
                        "Zone": "ap-guangzhou",
                        "NumericalVpcId": 54352,
                        "LoadBalancerType": "open"
                    }
                ],
                "Region": "gz",
                "Edition": "clb-waf",
                "FlowMode": 1,
                "ClsStatus": 1,
                "Level": 1,
                "CdcClusters": [],
                "AlbType": "clb",
                "IpHeaders": [
                    "x-real-ip"
                ],
                "EngineType": 0,
                "CloudType": "public",
                "Note": "备注"
            }
        ],
        "RequestId": "304cb36f-772a-4fdb-9b25-212d8fe5a553"
    }
}

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	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
ResourceInUse	资源被占用。
ResourceInsufficient	资源不足。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
ResourcesSoldOut	资源售罄。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。

获取防护域名列表

本页目录：