Skip to content

Collector "Huawei Cloud-APIG" Configuration Manual

Before reading this, please read the following first:

Before using this collector, you must install the 'Integration Core package' and its associated 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'
See appendix for full list

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

Configuration Two (Legacy Compatibility)

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

2. Configuration Example

Specifying a Region

Collecting APIG instance data corresponding to the cn-north-4 region.

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

3. Data Reporting Format

After data synchronization, you can view the data in the {{( brand_name )}} 'Infrastructure - Resource Catalog'.

An example of reported data is as follows:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "measurement": "huaweicloud_apig",
  "tags": {
    "RegionId"              : "cn-north-4",
    "project_id"            : "c631f046252xxxxxxx45f253c62d48585",
    "enterprise_project_id" : "0",
    "instance_id"           : "xxxxx",
    "instance_name"         : "apig-5muz",
    "status"                : "6",
    "eip_address"           : "xx.xx.xx.xx",
    "name"                  : "f3193ea65bxxxxxxxxxa02937cf190f49",
  },
  "fields": {
    "spec"                  : "BASIC",
    "status"                : "Running",
    "type"                  : "apig"
    "loadbalancer_provider" : "elb",
    "create_time" : 1690443027224,
    "message"     : "{Instance JSON data}"
  }
}

Fields in tags and fields may change with subsequent updates

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

The following fields are strings after JSON serialization

  • fields.message

X. Appendix

Huawei Cloud APIG "Region ID"

Please refer to the official Huawei Cloud documentation: