1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
Bot_V2 bot总开关更新
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyBotStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-seoul, ap-singapore 。 |
| Category | 是 | String | 类别 示例值：bot |
| Status | 是 | String | 状态 示例值：1 |
| Domain | 否 | String | 域名 示例值：test.com |
| InstanceID | 否 | String | 实例id |
| IsVersionFour | 否 | Boolean | 是否是bot4.0版本 |
| BotVersion | 否 | String | 传入Bot版本号，场景化版本为"4.1.0" 示例值：4.1.0 |
| DomainList.N | 否 | Array of String | 批量开启BOT开关的域名列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | 正常情况为null 注意：此字段可能返回 null，表示取不到有效值。 |
| UnSupportedList | Array of String | 未购买BOT的域名列表 注意：此字段可能返回 null，表示取不到有效值。 |
| FailDomainList | Array of String | 已购买但操作失败的域名列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Count | Integer | 成功数目 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Bot_V2 bot开关更新
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBotStatus
<公共请求参数>
{
"Category": "bot",
"Status": "1",
"Domain": "test.com",
"InstanceID": "waf_xxx"
}输出示例
{
"Response": {
"Data": null,
"RequestId": "a0b4e55b-5307-4378-856d-efc22475c77d"
}
}示例2 新版本_bot总开关
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBotStatus
<公共请求参数>
{
"Status": "1",
"Category": "bot",
"Domain": "fgsta.qcloudwaf.com",
"IsVersionFour": "true",
"BotVersion": "4.1.0"
}输出示例
{
"Response": {
"Data": "",
"RequestId": "110a2ef2-74ee-4db1-9b96-7da77283653f"
}
}示例3 老版本_bot总开关
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBotStatus
<公共请求参数>
{
"Status": "0",
"Category": "bot",
"Domain": "fgsta.qcloudwaf.com",
"IsVersionFour": "true"
}输出示例
{
"Response": {
"Data": "",
"RequestId": "c6ae93c9-f71c-473c-ad9b-ba1b59e47059"
}
}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.ErrCodeNoPurchased | 当前实例未购买api安全套餐 |
| InternalError | 内部错误。 |
| UnsupportedOperation.InvalidRequest | InvalidRequest |