1. 接口描述
接口请求域名： antiddos.tencentcloudapi.com 。
获取基础防护攻击状态
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBasicDeviceStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-09。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| IpList.N | 否 | Array of String | IP 资源列表 示例值：["\u20181.1.1.1\u2019\r\n"] |
| IdList.N | 否 | Array of String | 域名化资源传id |
| FilterRegion | 否 | Integer | 地域名称 |
| CnameWafIdList.N | 否 | Array of String | cnameWaf资源 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of KeyValue | 返回资源及状态，状态码： 1 - 封堵状态 2 - 正常状态 3 - 攻击状态 |
| CLBData | Array of KeyValue | 域名化资产的名称 注意：此字段可能返回 null，表示取不到有效值。 |
| CnameWafData | Array of KeyValue | cnamewaf资源状态 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取基础防护状态
获取基础防护状态
输入示例
POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBasicDeviceStatus
<公共请求参数>
{
"IpList": [
"abc"
],
"IdList": [
"abc"
],
"FilterRegion": 1
}输出示例
{
"Response": {
"Data": [
{
"Key": "abc",
"Value": "abc"
}
],
"CLBData": [
{
"Key": "abc",
"Value": "abc"
}
],
"CnameWafData": [
{
"Key": "1.1.1.1",
"Value": "1"
}
],
"RequestId": "abc"
}
}示例2 获取基础防护攻击状态
无
输入示例
POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBasicDeviceStatus
<公共请求参数>
{
"IpList": [
"127.0.0.1"
]
}输出示例
{
"Response": {
"Data": [
{
"Key": "1.1.1.1",
"Value": "1"
}
],
"CLBData": [
{
"Key": "1.1.1.1",
"Value": "1"
}
],
"CnameWafData": [
{
"Key": "1.1.1.1",
"Value": "1"
}
],
"RequestId": "8f7a9451-2372-4a88-a69d-9868b8991076"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。