API调用
概述
WebTDS 提供两类 API 接口：
- 对外开放 Admin API：用于企业自动化运维场景，需要在控制台开启并配置白名单后使用，接口前缀为
/admin_api/ - 内部节点接口：用于节点与控制台通信，不对外暴露
Admin API 具有三层安全防护：开关控制（ADMIN_API_ENABLE）+ IP/域名白名单（ADMIN_API_WHITELIST）+ wtds_auth 认证。
Admin API 使用说明
认证方式
所有 Admin API 请求需要在 Header 中携带认证信息：
| Header | 说明 |
|---|---|
| wtds_auth | 控制台认证令牌，在 系统管理 -> 基础信息 页面查看 |
接口前缀
所有对外开放接口使用 /admin_api/ 前缀访问，例如：
- 获取基础组件列表：
POST /admin_api/api_get_sys_base_component_list
支持的 Admin API 列表
| API 分类 | 接口名称 | 功能描述 |
|---|---|---|
| 基础组件 | api_get_sys_base_component_list | 获取基础组件列表 |
| 名单配置 | api_get_sys_name_list_list | 获取名单列表 |
| 名单条目 | api_get_sys_name_list_item_list | 获取名单条目列表 |
| 规则配置 | api_get_sys_rule_check_list | 获取规则列表 |
| 分析组件 | api_get_sys_analysis_component_list | 获取分析组件列表 |
| 检测策略 | api_get_sys_check_policy_list | 获取策略列表 |
| 检测策略 | api_sys_check_policy_args | 获取策略参数配置 |
| 内部字典 | api_get_sys_check_policy_inner_dict_list | 获取策略内部字典列表 |
| 全局字典 | api_get_sys_global_dict_list | 获取全局字典列表 |
| 告警配置 | api_get_sys_alert_list | 获取告警配置列表 |
| 处置接口 | api_get_sys_action_api_list | 获取处置接口列表 |
| 处置组件 | api_get_sys_action_component_list | 获取处置组件列表 |
接口详情
1. 获取基础组件列表
接口名称
api_get_sys_base_component_list
功能描述
获取所有基础组件的名称列表
请求方法
POST
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| wtds_auth | string | 是 | WebTDS控制台认证令牌（通过Header传递） |
响应示例
{
"result": true,
[
{"name": "sql_check"},
{"name": "xss_check"}
]
}
2. 获取名单列表
接口名称
api_get_sys_name_list_list
功能描述
获取所有名单配置的名称列表
请求方法
POST
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| wtds_auth | string | 是 | WebTDS控制台认证令牌（通过Header传递） |
3. 获取名单条目列表
接口名称
api_get_sys_name_list_item_list
功能描述
获取指定名单下的名单条目列表
请求方法
POST
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| wtds_auth | string | 是 | WebTDS控制台认证令牌（通过Header传递） |
| name_list_name | string | 是 | 名单名称 |
| page | number | 否 | 页码，默认1 |
4. 获取规则列表
接口名称
api_get_sys_rule_check_list
功能描述
获取所有规则匹配配置的名称列表
请求方法
POST
5. 获取分析组件列表
接口名称
api_get_sys_analysis_component_list
功能描述
获取所有分析组件的名称列表
请求方法
POST
6. 获取检测策略列表
接口名称
api_get_sys_check_policy_list
功能描述
获取所有检测策略的名称列表
请求方法
POST
7. 获取检测策略参数
接口名称
api_sys_check_policy_args
功能描述
获取指定检测策略的参数配置
请求方法
POST
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| wtds_auth | string | 是 | WebTDS控制台认证令牌（通过Header传递） |
| policy_name | string | 是 | 策略名称 |
8. 获取策略内部字典列表
接口名称
api_get_sys_check_policy_inner_dict_list
功能描述
获取指定检测策略的内部字典配置列表
请求方法
POST
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| wtds_auth | string | 是 | WebTDS控制台认证令牌（通过Header传递） |
| policy_name | string | 是 | 策略名称 |
9. 获取全局字典列表
接口名称
api_get_sys_global_dict_list
功能描述
获取所有全局字典的名称列表
请求方法
POST
10. 获取告警配置列表
接口名称
api_get_sys_alert_list
功能描述
获取所有策略告警配置的名称列表
请求方法
POST
11. 获取处置接口列表
接口名称
api_get_sys_action_api_list
功能描述
获取所有处置接口配置的名称列表
请求方法
POST
12. 获取处置组件列表
接口名称
api_get_sys_action_component_list
功能描述
获取所有处置组件配置的名称列表
请求方法
POST
内部接口（不对外暴露）
以下接口为节点与控制台通信的内部接口，不在 Admin API 中对外开放，请勿直接调用：
| 接口名称 | 用途 |
|---|---|
| api_create_sys_name_list_item | 节点创建/更新名单条目 |
| api_get_sys_name_list_item_list_all | 节点获取全量名单条目 |
| monitor | 节点心跳上报 |
| event_record | 节点上报告警事件 |
| send_alert | 发送告警通知 |
| query_event_record | 查询事件记录 |
| query_behave_track | 查询行为轨迹 |
| conf_update | 节点拉取配置更新 |
数据结构说明
名单项(sys_name_list_item)表结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| user_name | string | 用户名 |
| name_list_name | string | 名单名称 |
| name_list_item | string | 名单项内容 |
| name_list_expire | string | 是否过期("true"/"false") |
| name_list_item_expire_time | integer | 过期时间戳(0表示永不过期) |