1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
【接口复用】场景化后更新Bot的UCB自定义规则，两个调用位置：1.BOT全局白名单 2.BOT场景配置
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyBotSceneUCBRule。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 域名 示例值：test.com |
| SceneId | 是 | String | 1.BOT全局白名单处调用时，传"global";2.BOT场景配置时，传具体的场景ID 示例值：30xxxxx |
| Rule | 否 | InOutputBotUCBRule | 规则内容, 增加编码SceneId信息,1.BOT全局白名单处调用时，SceneId为"global", RuleType传10, Action为"permit";2.BOT场景配置时，SceneId为场景ID 示例值：{ "RuleType":"10", "Name":"云图API全局白名单测试改名1", "RuleId":"3000004932", "ValidTime":"0", "Timestamp":"1666164720592", "AdditionArg":"none", "Domain":"fgsta.qcloudwaf.com" } |
| BatchRules.N | 否 | Array of InOutputBotUCBRule | 530改批量操作 示例值：[{ "RuleType":"10", "Name":"云图API全局白名单测试改名1", "RuleId":"3000004932", "ValidTime":"0", "Timestamp":"1666164720592", "AdditionArg":"none", "Domain":"fgsta.qcloudwaf.com" }] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | 正常情况下为null 示例值：ok |
| RuleIdList | Array of String | ["1231"] 示例值：修改成功的ruleid列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改全局自定义规则
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBotSceneUCBRule
<公共请求参数>
{
"SceneId": "global",
"Domain": "fgsta.qcloudwaf.com",
"Rule": {
"RuleType": "10",
"Name": "云图API全局白名单测试改名1",
"RuleId": "3000004932",
"ValidTime": "0",
"Timestamp": "1666164720592",
"AdditionArg": "none",
"Domain": "fgsta.qcloudwaf.com",
"Rule": [
{
"Key": "robots_exist",
"Value": {
"LogicValue": "false"
},
"Op": "logic"
}
],
"Label": "友好BOT",
"Prior": "100",
"Appid": "251197210",
"Action": "permit",
"Desc": "云图API测试场景UCB",
"OnOff": "on"
}
}输出示例
{
"Response": {
"RequestId": "6f141b49-a21f-4a72-aa62-7fa7999e18ec",
"Data": "ok"
}
}示例2 插入全局自定义规则
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBotSceneUCBRule
<公共请求参数>
{
"SceneId": "global",
"Domain": "fgsta.qcloudwaf.com",
"Rule": {
"RuleType": "10",
"Name": "云图API全局白名单测试1",
"ValidTime": "0",
"Timestamp": "1666164720592",
"AdditionArg": "none",
"Domain": "fgsta.qcloudwaf.com",
"Rule": [
{
"Key": "robots_exist",
"Value": {
"LogicValue": "true"
},
"Op": "logic"
}
],
"Label": "友好BOT",
"Prior": "100",
"Appid": "251197210",
"Action": "permit",
"Desc": "云图API测试场景UCB",
"OnOff": "on"
}
}输出示例
{
"Response": {
"RequestId": "bbec197a-d04f-4240-bad3-2eb8474554d4",
"Data": "ok"
}
}示例3 插入场景自定义规则
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBotSceneUCBRule
<公共请求参数>
{
"SceneId": "3000004909",
"Domain": "fgsta.qcloudwaf.com",
"Rule": {
"RuleType": "0",
"Name": "云图API测试1",
"ValidTime": "0",
"Timestamp": "1666164720592",
"AdditionArg": "none",
"Domain": "fgsta.qcloudwaf.com",
"Rule": [
{
"Key": "robots_exist",
"Value": {
"LogicValue": "true"
},
"Op": "logic"
}
],
"Label": "疑似BOT",
"Prior": "100",
"Appid": "251197210",
"Action": "monitor",
"Desc": "云图API测试场景UCB",
"Id": "字符串",
"OnOff": "on"
}
}输出示例
{
"Response": {
"RequestId": "4789cbed-1d47-44b4-adfb-f908a52f2a75",
"Data": "ok"
}
}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 | 内部错误。 |
| InvalidParameter.BotNameRepeatErr | 命名重复 |
