跳转至

采集器「华为云-WAF」配置手册

阅读本文前,请先阅读:

使用本采集器前,必须安装「观测云集成 Core 核心包」及其配套的第三方依赖包

1. 配置结构

本采集器配置结构如下:

字段 类型 是否必须 说明
region_projects dict 必须 所需采集数据的「地域 - 项目 ID」列表
region_projects[#] str:list 必须 键值对中:
Key 代表地域(如:'cn-north-4'
Value 代表该地域下所需采集的项目 ID 列表
总表见附录

2. 配置示例

指定地域

采集cn-north-4地域对应项目的 WAF 实例数据

Python
1
2
3
4
5
6
collector_configs = {
    'region_projects': {
        'enterprise_project_id': 'xxxxxxx',
        'cn-north-4': ['c631f046252d4exxxxxxxxxxx', '15c6ce1c12da40xxxxxxxx9'],
    }
}

3. 数据上报格式

数据正常同步后,可以在观测云的「基础设施-资源目录」中查看数据。

上报的数据示例如下:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "measurement": "huaweicloud_waf",
  "tags": {
    "RegionId"             : "cn-north-4",
    "project_id"           : "15c6ce1c12daxxxxxxx",
    "enterprise_project_id": "0",
    "name"                 : "3ddxxx-axxx-48xx-a9xx-28fxxxxxxx",
    "instance_id"          : "3ddxxx-axxx-48xx-a9xx-28fxxxxxxx",
    "instance_name"        : "vpc-default",
    "hostid"               : "d0a4bc2f74e340xxxxx",
    "hostname"             : "www.xxx.com"
  },
  "fields": {
    "description"          : "aaaa",
    "paid_type"            : "prePaid",
    "proxy"                : "false",
    "policyid"             : "bb2124fabe6f42fxxxxx",
    "protect_status"       : "1",
    "access_status"        : "0",
    "web_tag"              : "iii",
    "message"              : "{实例 JSON 数据}"
  }
}

部分字段说明如下,具体可看附录接口返回参数

字段 类型 说明
web_tag string 网站名称,对应 WAF 控制台域名详情中的网站名称
protect_status string 域名防护状态:
-1:bypass,该域名的请求直接到达其后端服务器,不再经过 WAF
0:暂停防护,WAF 只转发该域名的请求,不做攻击检测
1:开启防护,WAF 根据您配置的策略进行攻击检测
access_status string 域名接入状态,0 表示未接入,1 表示已接入

tags、fields 中的字段可能会随后续更新有所变动

tags.name 值为实例 ID,作为唯一标识

fields.message 为 JSON 序列化后字符串

X. 附录

请参考华为云官方文档: