1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
查询用户所有域名的详细信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDomains。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
| Offset | 是 | Integer | 分页偏移量，取Limit整数倍。最小值为0，最大值= Total/Limit向上取整 示例值：0 |
| Limit | 是 | Integer | 返回域名的数量 示例值：20 |
| Filters.N | 否 | Array of FiltersItemNew | 过滤数组，过滤字段包括：Edition：实例版本，sparta-waf或clb-waf Domain：域名 DomainId：域名ID InstanceName：实例名称 InstanceId：实例ID FlowMode：流量接入模式，仅支持CLBWAF FlowCheckMode：流量体检模式，仅支持CLBWAF ClsStatus：日志开关 Status：WAF开关BotStatus：BOT开关 ApiStatus：API安全开关 Engine：引擎模式 UpstreamIP：源站IP，仅支持SAAS型WAF UpstreamDomain：源站域名，仅支持SAAS型WAF DomainState：域名状态，仅支持SAAS型WAF SgState：安全组状态，仅支持SAAS型WAF Label：分组标签，同时仅支持一种标签过滤 示例值：[{"Name":"InstanceId","Values":["waf_2kw60zgy0908e8j3"],"ExactMatch":false}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值：2 |
| Domains | Array of DomainInfo | domain列表 示例值：[{"AppId":1256702383,"Domain":"randygz2.qcloudwaf.com","DomainId":"7d58ebf3db7e5f7e8f91eb017c6a7b31","InstanceId":"waf_2kw60jgy0908e8j3","InstanceName":"广州双栈集群企业版","Edition":"sparta-waf","Region":"gz","CreateTime":"2024-07-18T10:46:12+08:00","Cname":"dae1cae7d48ec31c7727a86a8cda2a62.qcloudzygj.com","ClsStatus":1,"PostCLSStatus":0,"PostCKafkaStatus":0,"FlowMode":0,"Status":1,"Mode":1,"State":0,"Engine":1,"Ipv6Status":1,"BotStatus":2,"ApiStatus":0,"Level":3,"CdcClusters":"","RsList":["134.175.221.0/24","2402:4e00:1020:1707::/64"],"CCList":[],"Ports":[{"NginxServerId":231056,"Port":"80","Protocol":"http","UpstreamPort":"80","UpstreamProtocol":"http"},{"NginxServerId":321607,"Port":"443","Protocol":"https","UpstreamPort":"80","UpstreamProtocol":"http"}],"LoadBalancerSet":[],"AlbType":"","SgState":2,"SgDetail":"","CloudType":"","Note":"22222","SrcList":["114.132.246.237"],"UpstreamDomainList":[],"SgID":"sg-7dme0v73","AccessStatus":1,"Labels":[""]},{"AppId":1256704386,"Domain":"xiaochengxu.qcloudwaf.com","DomainId":"42059f9a9905519d8f9e72a823891544","InstanceId":"waf_2kw60jgy0908e8j3","InstanceName":"广州双栈集群企业版","Edition":"sparta-waf","Region":"gz","CreateTime":"2024-07-08T17:42:42+08:00","Cname":"3323d11c0772e26ca3c68548b9cd069f.qcloudzygj.com","ClsStatus":1,"PostCLSStatus":0,"PostCKafkaStatus":0,"FlowMode":0,"Status":1,"Mode":1,"State":1,"Engine":1,"Ipv6Status":0,"BotStatus":2,"ApiStatus":0,"Level":3,"CdcClusters":"","RsList":["134.175.221.0/24"],"CCList":[],"Ports":[{"NginxServerId":257856,"Port":"80","Protocol":"http","UpstreamPort":"80","UpstreamProtocol":"http"}],"LoadBalancerSet":[],"AlbType":"","SgState":1,"SgDetail":"","CloudType":"","Note":"","SrcList":["124.221.148.62"],"UpstreamDomainList":[],"SgID":"","AccessStatus":1,"Labels":[""]}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户所有域名信息
查询用户所有域名信息
输入示例
POST / HTTP/1.1
Host: xxx.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomains
<公共请求参数>
{
"Offset": 0,
"Limit": 20,
"Filters": []
}输出示例
{
"Response": {
"RequestId": "93efef98-b938-4ae7-bad3-19fc70b7b9a7",
"Total": 2,
"Domains": [
{
"AppId": 1256704386,
"Domain": "zhenhas1020.qcloudwaf.com",
"DomainId": "waf-ApUwCv4q",
"InstanceId": "waf_2k0il2fm02vqm7z3",
"InstanceName": "cd-Default1",
"Edition": "clb-waf",
"Region": "cd",
"CreateTime": "2024-10-28T16:52:33+08:00",
"Cname": "dae1cae7d48ec31c7727a86a5c1a2a62.qcloudzygj.com",
"ClsStatus": 0,
"PostCLSStatus": 0,
"PostCKafkaStatus": 0,
"FlowMode": 1,
"Status": 1,
"Mode": 1,
"State": 0,
"Engine": 20,
"Ipv6Status": 0,
"BotStatus": 2,
"ApiStatus": 0,
"Level": 3,
"CdcClusters": "cls-dasjh2a2t5",
"RsList": [
"1.14.1.0/24"
],
"CCList": [
"1.14.3.0/24"
],
"Ports": [
{
"NginxServerId": 257856,
"Port": "80",
"Protocol": "http",
"UpstreamPort": "80",
"UpstreamProtocol": "http"
}
],
"LoadBalancerSet": [
{
"ListenerId": "lbl-d823da3",
"ListenerName": "listener 80",
"LoadBalancerId": "lb-nda52sau",
"LoadBalancerName": "cd lb",
"Protocol": "HTTP",
"Region": "cd",
"Vip": "26.153.3.235",
"Vport": 80,
"Zone": "ap-chengdu-1",
"NumericalVpcId": 23654,
"LoadBalancerType": "OPEN",
"LoadBalancerDomain": "lb-nda52sau-vo1x4syum7jtqz5n.clb.ap-guangzhou.tencentclb.com"
}
],
"AlbType": "clb",
"SgState": 0,
"CloudType": "public",
"Note": "clb domain",
"AccessStatus": 1,
"Labels": [
"clb domain"
]
},
{
"AppId": 1256704386,
"Domain": "zhenhuasaas1020.qcloudwaf.com",
"DomainId": "11c88f0f292a5fd4a3002344271367b2",
"InstanceId": "waf_2kzh5tma0v0jpotj",
"InstanceName": "cd-Default",
"Edition": "sparta-waf",
"Region": "cd",
"CreateTime": "2024-10-21T14:41:50+08:00",
"Cname": "88fa6f44eee830c8e1e3b3c5ecba6af7.qcloudzygj.com",
"ClsStatus": 1,
"PostCLSStatus": 0,
"PostCKafkaStatus": 0,
"FlowMode": 0,
"Status": 1,
"Mode": 1,
"State": 0,
"Engine": 1,
"Ipv6Status": 0,
"BotStatus": 0,
"ApiStatus": 0,
"Level": 3,
"RsList": [
"1.14.1.0/24"
],
"CCList": [
"1.14.8.0/24"
],
"Ports": [
{
"NginxServerId": 329025,
"Port": "80",
"Protocol": "http",
"UpstreamPort": "80",
"UpstreamProtocol": "http"
}
],
"LoadBalancerSet": [
{
"ListenerId": "default",
"ListenerName": "default",
"LoadBalancerId": "default.cd",
"LoadBalancerName": "default.clb",
"Protocol": "HTTP",
"Region": "cd",
"Vip": "8.8.8.8",
"Vport": 80,
"Zone": "cd",
"NumericalVpcId": -1,
"LoadBalancerType": "OPEN",
"LoadBalancerDomain": "default.cd"
}
],
"SgState": 1,
"SgDetail": "ok",
"CloudType": "public",
"Note": "saas domain",
"SrcList": [
"87.29.132.9"
],
"SgID": "sg-asn32ag1",
"AccessStatus": 1,
"Labels": [
"saas domain"
]
}
]
}
}示例2 查询用户SAASWAF某个实例的域名信息
查询用户SAASWAF某个实例的域名信息
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomains
<公共请求参数>
{
"Offset": 0,
"Limit": 20,
"Filters": [
{
"Name": "Edition",
"Values": [
"sparta_waf"
],
"ExactMatch": true
},
{
"Name": "InstanceId",
"Values": [
"waf_2kw60jgy0908e8j3"
],
"ExactMatch": true
}
]
}输出示例
{
"Response": {
"RequestId": "91334a5a-1d24-42b9-998e-57e1490f9608",
"Total": 2,
"Domains": [
{
"AppId": 1256702383,
"Domain": "randygz2.qcloudwaf.com",
"DomainId": "7d58ebf3db7e5f7e8f91eb017c6a7b31",
"InstanceId": "waf_2kw60jgy0908e8j3",
"InstanceName": "广州双栈集群企业版",
"Edition": "sparta-waf",
"Region": "gz",
"CreateTime": "2024-07-18T10:46:12+08:00",
"Cname": "dae1cae7d48ec31c7727a86a8cda2a62.qcloudzygj.com",
"ClsStatus": 1,
"PostCLSStatus": 0,
"PostCKafkaStatus": 0,
"FlowMode": 0,
"Status": 1,
"Mode": 1,
"State": 0,
"Engine": 1,
"Ipv6Status": 1,
"BotStatus": 2,
"ApiStatus": 0,
"Level": 3,
"RsList": [
"134.175.221.0/24",
"2402:4e00:1020:1707::/64"
],
"CCList": [
"134.175.225.0/24"
],
"Ports": [
{
"NginxServerId": 231056,
"Port": "80",
"Protocol": "http",
"UpstreamPort": "80",
"UpstreamProtocol": "http"
},
{
"NginxServerId": 321607,
"Port": "443",
"Protocol": "https",
"UpstreamPort": "80",
"UpstreamProtocol": "http"
}
],
"LoadBalancerSet": [],
"SgState": 2,
"SgDetail": "ok",
"Note": "randy domain",
"SrcList": [
"114.132.246.237"
],
"UpstreamDomainList": [
"xiaochegnxu.upstream.com"
],
"SgID": "sg-7dme0v73",
"AccessStatus": 1,
"Labels": [
"randy domain"
]
},
{
"AppId": 1256704386,
"Domain": "xiaochengxu.qcloudwaf.com",
"DomainId": "42059f9a9905519d8f9e72a823891544",
"InstanceId": "waf_2kw60jgy0908e8j3",
"InstanceName": "广州双栈集群企业版",
"Edition": "sparta-waf",
"Region": "gz",
"CreateTime": "2024-07-08T17:42:42+08:00",
"Cname": "3323d11c0772e26ca3c68548b9cd069f.qcloudzygj.com",
"ClsStatus": 1,
"PostCLSStatus": 0,
"PostCKafkaStatus": 0,
"FlowMode": 0,
"Status": 1,
"Mode": 1,
"State": 1,
"Engine": 1,
"Ipv6Status": 0,
"BotStatus": 2,
"ApiStatus": 0,
"Level": 3,
"RsList": [
"134.175.221.0/24"
],
"CCList": [
"134.175.225.0/24"
],
"Ports": [
{
"NginxServerId": 257856,
"Port": "80",
"Protocol": "http",
"UpstreamPort": "80",
"UpstreamProtocol": "http"
}
],
"LoadBalancerSet": [],
"SgState": 1,
"SgDetail": "fail",
"Note": "xiaochengxu",
"SrcList": [
"124.221.148.62"
],
"UpstreamDomainList": [
"xiaochegnxu.upstream.com"
],
"SgID": "sg-7dme0v73",
"AccessStatus": 1,
"Labels": [
"xiaochengxu"
]
}
]
}
}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 | 操作不支持。 |
