1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
修改Bot-ID规则配置1
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyBotIdRule。 |
| Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 域名 示例值:admin.com |
| SceneId | 是 | String | 场景ID 示例值:3012342342 |
| Data.N | 否 | Array of BotIdConfig | 配置信息,支持批量 示例值:[ { "RuleId": "abc", "BotId": "abc", "Status": true, "Action": "abc" } ] |
| GlobalSwitch | 否 | Integer | 0-全局设置不生效 1-全局开关配置字段生效 2-全局动作配置字段生效 3-全局开关和动作字段都生效 4-只修改全局重定向路径 5-只修改全局防护等级 示例值:0 |
| Status | 否 | Boolean | 全局开关 示例值:false |
| RuleAction | 否 | String | 全局动作 示例值:monitor |
| GlobalRedirect | 否 | String | 全局重定向路径 示例值:/luffy |
| ProtectLevel | 否 | String | 防护等级:normal-正常;strict-严格 示例值:normal |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 sample
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBotIdRule
<公共请求参数>
{
"Domain": "admin.com",
"SceneId": "3088902138",
"Data": [
{
"RuleId": "3309123111",
"BotId": "abot",
"Status": true,
"Action": "monitor"
}
],
"GlobalSwitch": 0,
"Status": true,
"RuleAction": "redirect",
"GlobalRedirect": "/luffy",
"ProtectLevel": "normal"
}
输出示例
{
"Response": {
"RequestId": "a713f4cf-51ef-437f-8467-d4fdec061b78"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。