Skip to content

Configuration Manual for the "Huawei Cloud - BMS" Collector

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 for 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 appendix for full list

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

Configuration Two (Legacy 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 project IDs under that region
Refer to appendix for full list

2. Configuration Example

Specify Region

Collect BMS 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, you can view the data in the {{( brand_name )}} 'Infrastructure - Resource Catalog'.

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
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "measurement": "huaweicloud_bms",
  "tags": {
    "RegionId"                   : "cn-north-4",
    "project_id"                 : "0ad96f54c800xxxxxxxxxxxxx91a9278a4",
    "enterprise_project_id"      : "0",
    "instance_id"                : "bc49dcf2-ce5d-4a74-8960-xxxxxxxxxx",
    "instance_name"              : "aaa",
    "name"                       : "bc49dcf2-ce5d-4a74-8960-xxxxxxxxxx",
    "tenant_id"                  : "0ad96f54xxxxxxxxxxxc0091a9278a4",
    "hostId"                     : "9f15596e0b9xxxxxxxxxxx04dcad81cd36c36c8f7045",
    "status"                     : "ACTIVE"
  },
  "fields": {
    "OS-EXT-STS:vm_state"                 : "active",
    "OS-EXT-AZ:availability_zone"         : "cn-north-4a",
    "OS-EXT-SRV-ATTR:hostname"            : "02",
    "host_status"                         : "UP",
    "locked"                              : "False",
    "user_id"                             : "869acd7a3xxxxxxxxxb9f12ed3",
    "created"                             : "2022-01-10T01:27:13Z",
    "updated"                             : "2022-07-02T20:15:19Z",
    "addresses"                           : "{bare metal server network information}",
    "image"                               : "{bare metal server image information}",
    "flavor"                              : "{bare metal server specification information}",
    "security_groups"                     : "[{bare metal server security group}]",
    "OS-SRV-USG:launched_at"              : "2022-01-10T01:33:27.000000",
    "os-extended-volumes:volumes_attached": "{disks attached to bare metal server}",
    "description"                         : "Development_China Tower Visual Link Basic Platform_Storage-01",
    "tags"                                : "['bare metal server tags']",
    "os:scheduler_hints"                  : "{bare metal server scheduling information}",
    "enterprise_project_id"               : "239bcb77-3d92-4962-89ab-945a03327922",
    "message"                             : "{instance JSON data}"
  }
}

Explanation of some parameters

Parameter Parameter Type Description
status String Current state information of the bare metal server. Possible values:
ACTIVE: Running/Shutting down/Deleting
BUILD: Creating
ERROR: Fault
HARD_REBOOT: Forced rebooting
REBOOT: Rebooting
DELETED: Instance has been normally deleted
SHUTOFF: Shutdown/Starting up/Deleting/Rebuilding/Reinstalling OS/Failure to reinstall OS/Frozen
OS-EXT-STS:vm_state String Extended attribute, stable state of the bare metal server. For example:
active: Running
shutoff: Shutdown
suspended: Suspended
reboot: Rebooting
host_status String Host status of the bare metal server:
UP: Service normal
UNKNOWN: Status unknown
DOWN: Service abnormal
MAINTENANCE: Maintenance mode
Empty string: Bare metal server has no host information
locked String Whether the bare metal server is locked.
True: Locked
False: Not locked

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 serialized JSON strings

  • fields.message
  • fields.addresses
  • fields.flavor
  • fields.image
  • fields.os-extended-volumes:volumes_attached
  • fields.os:scheduler_hints
  • fields.security_groups

X. Appendix

Huawei Cloud BMS "Region ID"

Please refer to the official Huawei Cloud documentation: