管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>Web 应用防火墙>其他接口>场景化后Bot获取UCB自定义规则策略

场景化后Bot获取UCB自定义规则策略

最近更新时间：2025-05-13 02:15:41

我的收藏

本页目录：

1. 接口描述

接口请求域名： waf.tencentcloudapi.com 。

场景化后Bot获取UCB自定义规则策略

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBotSceneUCBRule。
Version 是 String 公共参数，本接口取值：2018-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-seoul, ap-singapore 。
Domain 是 String 域名
示例值：www.test.com
Skip 是 Integer 翻页组件的起始页
示例值：0
Limit 是 Integer 翻页组件的页数据条数
示例值：10
Sort 是 String 排序参数
示例值：desc
SceneId 是 String 1.BOT全局白名单处调用时，传"global";2.BOT场景配置处调用时，传具体的场景ID
示例值：30xxxxx
Operate 否 String 需要过滤的动作
示例值：monitor
Name 否 String 需要过滤的规则名称
示例值：custom-1
VersionFlag 否 String 兼容老数据和新旧版前端
示例值：480
TimerType 否 Integer 生效方式：0-全部 1-永久生效 2-定时生效 3-周粒度生效 4-月粒度生效
示例值：0
ValidStatus 否 Integer 0-全部 1-生效中 2-已过期
示例值：1
RuleId 否 String 规则id
示例值：2342

3. 输出参数

参数名称 类型 描述
Data DescribeBotUCBRuleRsp 返回数据包
示例值：{ "Res": [ ], "TotalCount": 0 }
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 全局UCB列表

全局UCB列表

输入示例

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBotSceneUCBRule
<公共请求参数>

{
    "Sort": "timestamp:-1",
    "Skip": "0",
    "Domain": "fgsta.qcloudwaf.com",
    "Limit": "2",
    "SceneId": "global"
}

输出示例

{
    "Response": {
        "Data": {
            "Res": [
                {
                    "Domain": "admin.com",
                    "Name": "custom-1",
                    "Rule": [
                        {
                            "Key": "url",
                            "Op": "eq",
                            "Value": {
                                "BasicValue": "/login",
                                "LogicValue": true,
                                "BelongValue": [
                                    "/login"
                                ],
                                "ValidKey": "url",
                                "MultiValue": [
                                    "/login"
                                ]
                            },
                            "OpOp": "rematch",
                            "OpArg": [
                                "name"
                            ],
                            "OpValue": 0,
                            "Name": "age"
                        }
                    ],
                    "Action": "monitor",
                    "OnOff": "on",
                    "RuleType": 0,
                    "Prior": 0,
                    "Timestamp": 0,
                    "Label": "human",
                    "Id": "3021313",
                    "SceneId": "3021312412",
                    "ValidTime": 0,
                    "Appid": 1,
                    "AdditionArg": "none",
                    "Desc": "none",
                    "RuleId": "320032232",
                    "PreDefine": true,
                    "JobType": "hour",
                    "JobDateTime": {
                        "Timed": [
                            {
                                "StartDateTime": 1,
                                "EndDateTime": 1
                            }
                        ],
                        "Cron": [
                            {
                                "Days": [
                                    1
                                ],
                                "WDays": [
                                    1
                                ],
                                "StartTime": "1231312414",
                                "EndTime": "12313124111"
                            }
                        ],
                        "TimeTZone": "utc+8"
                    },
                    "ExpireTime": 1
                }
            ],
            "TotalCount": 0
        },
        "RequestId": "req-id-13123"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.MongoOperationFailed 操作Mongo数据库失败
InternalError 内部错误。
InvalidParameter.BotSceneNotExistErr Bot场景不存在
UnsupportedOperation 操作不支持。
UnsupportedOperation.BotServiceNotSubscribeErr Bot套餐未购买
UnsupportedOperation.InvalidRequest InvalidRequest
中国站
目录