Skip to content

Collector Configuration Manual for "Huawei Cloud - VPC"

Before reading this article, 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 the complete list in the appendix

The collector will automatically retrieve all IAM projects under the region and then obtain resources based on the 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 key-value pairs:
Key represents the region (e.g., 'cn-north-4')
Value represents the list of project IDs to collect data from within that region
See the complete list in the appendix

2. Configuration Example

Specifying a Region

Collecting VPC instance data for projects corresponding to the cn-north-4 region.

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

3. Data Reporting Format

After data synchronization is successful, the data can be viewed in the 'Infrastructure - Resource Catalog' section of {{( brand_name )}}.

An example of the reported data is as follows:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "measurement": "huaweicloud_vpc",
  "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",
    "status"               : "ACTIVE"
  },
  "fields": {
    "created_at"           : "2022-06-16T10:12:12Z",
    "updated_at"           : "2022-06-16T10:12:13Z",
    "cidr"                 : "192.168.0.0/16",
    "message"              : "{Instance JSON data}"
  }
}

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

Field Type Description
cidr string Range of available subnets under the VPC
status string Status of the VPC
PENDING: Creating
ACTIVE: Created successfully
instance_name string Instance name

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: