1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
获取发现域名列表接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeFindDomainList。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
Offset | 是 | Integer | 分页 示例值:1 |
Limit | 是 | Integer | 每页容量 示例值:1 |
Key | 是 | String | 过滤条件 示例值:beigrpc02.qcloudwaf.com |
IsWafDomain | 是 | String | 是否接入waf;传"1"返回接入域名的详情,传"0"返回未接入域名的详情,传""返回接入和未接入域名的详情 示例值:1 |
By | 否 | String | 排序参数 示例值:updatetime |
Order | 否 | String | 排序方式 示例值:asc |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 域名总数 示例值:530 |
List | Array of FindAllDomainDetail | 域名信息列表 示例值:[ { "Appid": 1256704312, "Domain": "*.sdfwaf.qcloudwaf.com", "Ips": [ "" ], "FindTime": "2024-11-01", "InstanceId": "", "DomainId": "", "Edition": "SAAS-WAF", "IsWafDomain": 0 }, { "Appid": 1256704312, "Domain": "123123.baidu.com", "Ips": [ "175.24.137.82" ], "FindTime": "2024-11-01", "InstanceId": "", "DomainId": "", "Edition": "CLB", "IsWafDomain": 0 }, { "Appid": 1256704312, "Domain": "123123.qcloudwaf.com", "Ips": [ "111.230.119.108" ], "FindTime": "2024-11-01", "InstanceId": "", "DomainId": "", "Edition": "CLB", "IsWafDomain": 0 } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取发现域名列表接口
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFindDomainList
<公共请求参数>
{
"Offset": 2,
"Limit": 5,
"Key": "qcloudwaf.com",
"IsWafDomain": "1"
}
输出示例
{
"Response": {
"Total": 9,
"RequestId": "b4f13899-561b-46a0-a045-6ba6b72c38f2",
"List": [
{
"Appid": 251000001,
"Domain": "lucasssli3.qcloudwaf.com",
"Ips": [
"159.75.189.237"
],
"FindTime": "20210729",
"InstanceId": "waf_0000000001",
"DomainId": "waf-oV8zE3WP",
"Edition": "clb-waf",
"IsWafDomain": 1
},
{
"Appid": 251000001,
"Domain": "wwwtx.qcloudwaf.com",
"Ips": [
"159.75.189.237"
],
"FindTime": "20210730",
"InstanceId": "waf_2kuil2fm02vqm7t5",
"DomainId": "waf-KsC0pPCo",
"Edition": "clb-waf",
"IsWafDomain": 1
},
{
"Appid": 251000001,
"Domain": "0613.qcloudwaf.com",
"Ips": [
"119.29.47.251"
],
"FindTime": "20210730",
"InstanceId": "waf_2kuil2fm02vqm7t5",
"DomainId": "waf_mfhvyos1",
"Edition": "clb-waf",
"IsWafDomain": 0
},
{
"Appid": 251000001,
"Domain": "txwaf.qcluodwaf.com",
"Ips": [
"159.75.189.237"
],
"FindTime": "20210730",
"InstanceId": "waf_2kuil2fm02fsdm1",
"DomainId": "waf_vlsdf123m",
"Edition": "sparta-waf",
"IsWafDomain": 0
}
]
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidCertificate | 证书内容非法。 |
InvalidParameter.QueryCertBySSLIDFailed | 根据ID查询证书失败。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |