Skip to content

Configuration Manual for Collector 「Huawei Cloud - WAF」

Before reading this, please first read:

Before using this collector, you must install the 「Integration Core Package」 and its corresponding third-party dependency packages

1. Configuration Structure

The configuration structure of this collector is as follows:

Configuration One (Recommended)

Field Type Required Description
regions list Required List of regions to collect data from
regions[#] str Required Region ID. For example: 'cn-north-4'
Refer to the appendix for the full table

The collector will automatically retrieve all IAM projects under the region and then obtain resources based on IAM projects

Configuration Two (Old Version Compatibility)

Field Type Required Description
region_projects dict Required List of 「Region - Project ID」 pairs required for data collection
region_projects[#] str:list Required In the key-value pair:
Key represents the region (e.g., 'cn-north-4')
Value represents the list of project IDs to be collected in that region
Refer to the appendix for the full table

2. Configuration Example

Specifying a Region

Collecting WAF instance data for the cn-north-4 region.

Python
1
2
3
collector_configs = {
    'regions': ['cn-north-4']
}

3. Data Reporting Format

After the data has been synchronized successfully, it can be viewed in the 「Infrastructure - Resource Catalog」 section of {{( brand_name }}}.

Example of reported data:

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"              : "{Instance JSON Data}"
  }
}

Descriptions of some fields are as follows; for more details, refer to the appendix interface return parameters.

Field Type Description
web_tag string Website name, corresponds to the website name in the WAF console domain details
protect_status string Domain protection status:
-1: bypass, requests for this domain go directly to the backend server without passing through WAF
0: paused protection, WAF only forwards the request without attack detection
1: protection enabled, WAF performs attack detection based on configured policies
access_status string Domain access status, 0 means not connected, 1 means connected

Fields in tags and fields may change with subsequent updates

The value of tags.name is the instance ID, used as a unique identifier

fields.message is a JSON serialized string

X. Appendix

Please refer to the official Huawei Cloud documentation: