1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
waf斯巴达-获取防护域名信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSpartaProtectionInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 域名 示例值：test.qcloudwaf.com |
| Edition | 否 | String | 版本 示例值：clb-waf |
| InstanceID | 否 | String | 实例 示例值：aaaaa |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Domain | String | 域名 示例值：test.qcloudwaf.com |
| DomainId | String | 域名ID 示例值：2334 |
| Cname | String | cname取值 示例值：sdfsfsdfsdf |
| Status | String | 状态 示例值：2 |
| SrcList | Array of String | 源IP地址列表 示例值：1.1.1.1 |
| CertType | String | 证书类型 示例值：2 |
| Cert | String | 证书 示例值：sdfsfsdfsdf |
| PrivateKey | String | 私有密钥 示例值：sdfsdfsdfs |
| Sslid | String | ssl的id 示例值：123 |
| IsCdn | String | 是否是cdn 示例值：1 |
| GrayAreas | Array of String | 灰度区域列表 示例值：gz |
| Engine | String | 引擎 示例值：10 |
| HttpsRewrite | String | HTTPS重写 示例值：1 |
| UpstreamType | String | upstreamType取值 示例值：2 |
| UpstreamDomain | String | upstreamDomain取值 示例值：1.1.1.1 |
| UpstreamScheme | String | upstreamScheme取值 示例值：1.1.1.1 |
| IsHttp2 | String | 是否是HTTP2 示例值：2 |
| IsWebsocket | String | 是否含有websocket 示例值：1 |
| LoadBalance | String | loadBalance信息 示例值：1 |
| HttpsUpstreamPort | String | httpsUpstreamPort取值 示例值：80 |
| Ports | Array of PortItem | port信息 示例值：80 |
| IsGray | String | 是否灰度 示例值：1 |
| Mode | String | 模式 示例值：1 |
| Level | String | 防御等级,100,200,300 示例值：4 |
| IsKeepAlive | String | 与源站是否保持长连接 示例值：1 |
| Anycast | String | 0：BGP 1：Anycast 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 waf斯巴达-获取防护域名信息
输入示例
https://waf.tencentcloudapi.com/?Action=DescribeSpartaProtectionInfo
&Domain=www.test1.com
&Edition=sprata-waf
&<公共请求参数>输出示例
{
"Response": {
"Cert": "test",
"CertType": "1",
"Cname": "",
"Domain": "www.test1.com",
"DomainId": "",
"Engine": "1",
"GrayAreas": [
"n"
],
"HttpsRewrite": "0",
"HttpsUpstreamPort": "0",
"IsCdn": "0",
"IsGray": "0",
"IsHttp2": "0",
"IsWebsocket": "0",
"LoadBalance": "0",
"Mode": "1",
"Ports": [],
"PrivateKey": "xxxx",
"RequestId": "1548ac10-3e48-4cee-b71b-fc1071421761",
"SrcList": [
"1.1.1."
],
"Sslid": "",
"Status": "2",
"UpstreamDomain": "",
"UpstreamScheme": "http",
"UpstreamType": "0",
"Level": "200",
"IsKeepAlive": "1",
"Anycast": "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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |