管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>Web 应用防火墙>其他接口>获取BOT场景列表与概览

获取BOT场景列表与概览

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

我的收藏

本页目录：

1. 接口描述

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

获取BOT场景列表与概览

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBotSceneList。
Version 是 String 公共参数，本接口取值：2018-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-seoul, ap-singapore 。
Domain 是 String 域名
示例值：admin.com
Limit 是 Integer 每页数量
示例值：10
Offset 是 Integer 页码
示例值：0
BusinessType.N 否 Array of String 场景模板类型，通过此下拉字段进行场景筛选。全部: all 登录: login 秒杀:seckill 爬内容：crawl 自定义: custom
示例值：["all"]
SceneName 否 String 通过场景名称模糊搜索
示例值：登录场景
IsDefault 否 Boolean 是否只显示默认场景
示例值：true
IsValid 否 Boolean 是否仅显示生效场景
示例值：false
SceneId 否 String 要查询的场景id
示例值：1231313

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合筛选条件的场景数目
示例值：5
BotSceneList Array of BotSceneInfo 当TotalCount为0时，返回空
示例值：[ { "SceneId": "3000004602", "Type": "default", "SceneName": "默认场景", "UpdateTime": 1666262225512]
SimpleFlag Boolean true-简易模式
示例值：false
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 仅查看默认场景

仅查看默认场景

输入示例

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

{
    "Domain": "fgsta.qcloudwaf.com",
    "Limit": "10",
    "BusinessType": [
        "all"
    ],
    "IsDefault": "true",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "d399557f-0050-4402-adb6-d0af24671738",
        "BotSceneList": [
            {
                "SceneId": "3000004602",
                "Type": "default",
                "SceneName": "默认场景",
                "UpdateTime": 1666262225512,
                "BusinessType": [],
                "ClientType": [
                    "browser"
                ],
                "Priority": 100,
                "MatchCondition": [],
                "MatchType": "",
                "ActionMatchType": "and",
                "SceneStatus": true,
                "JsInjectStatus": false,
                "AIStatus": true,
                "TIStatus": true,
                "StatisticStatus": false,
                "ActionRuleCount": 1,
                "UCBCount": 0,
                "UAStatus": true
            }
        ],
        "TotalCount": 1,
        "SimpleFlag": true
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
UnsupportedOperation 操作不支持。
UnsupportedOperation.BotServiceNotSubscribeErr Bot套餐未购买
UnsupportedOperation.InvalidRequest InvalidRequest
中国站
目录