Updated on 2025-07-18 GMT+08:00

Monitoring Metrics

Introduction

This section describes the metrics that APIG reports to the Cloud Eye service. You can view metrics and alarms by using the Cloud Eye console.

If a metric is not supported by your gateway, submit a service ticket to upgrade the gateway to the latest version.

Namespace

SYS.APIC

Metrics

Table 1 Metric description

Metric ID

Metric Name

Description

Value Range

Unit

Conversion Rule

Monitored Object (Dimension)

Monitoring Period (Minute)

throttled_calls

Throttled API Calls

Number of API calls that are throttled.

≥0

Times/min

None

Dedicated gateway (instance_id)

1

requests

API Calls

Number of times that an API has been called

≥0

Times/min

None

Dedicated gateway (instance_id)

1

req_count_error

Total Errors

Total number of API errors

≥0

Times/min

None

API (instance_id and api_id)

1

req_count_5xx

5xx Responses

Number of API calls resulting in 5xx responses

≥0

Times/min

None

API (instance_id and api_id)

1

req_count_4xx

4xx Responses

Number of API calls resulting in 4xx responses

≥0

Times/min

None

API (instance_id and api_id)

1

req_count_2xx

2xx Responses

Number of API calls resulting in 2xx responses

≥0

Times/min

None

API (instance_id and api_id)

1

req_count

API Calls

Number of times that an API has been called

≥0

Times/min

None

API (instance_id and api_id)

1

output_throughput

Outgoing Traffic

Outgoing traffic of the API

≥0

Byte

1000(SI)

API (instance_id and api_id)

1

max_latency

Maximum Latency

Maximum latency of the API

≥0

ms

None

Dedicated gateway (instance_id)

1

max_latency

Maximum Latency

Maximum latency of the API

≥0

ms

None

API (instance_id and api_id)

1

input_throughput

Incoming Traffic

Incoming traffic of the API

≥0

Byte

1000(SI)

API (instance_id and api_id)

1

error_5xx

5xx Responses

Number of API calls resulting in 5xx responses

≥0

Times/min

None

Dedicated gateway (instance_id)

1

error_4xx

4xx Responses

Number of API calls resulting in 4xx responses

≥0

Times/min

None

Dedicated gateway (instance_id)

1

avg_latency

Average Latency

Average latency of the API

≥0

ms

None

Dedicated gateway (instance_id)

1

avg_latency

Average Latency

Average latency of the API

≥0

ms

None

API (instance_id and api_id)

1

node_system_load

Node System Load

Load details of a gateway node on the data plane. 1 means low water level, 2 means medium water level, and 3 means high water level.

1, 2, 3

count

None

Gateway node (node_ip)

1

node_cpu_usage

Node CPU Usage

CPU usage details of a gateway node on the data plane

≥0

%

None

Gateway node (node_ip)

1

node_memory_usage

Node Memory Usage

Memory usage details of a gateway node on the data plane

≥0

%

None

Gateway node (node_ip)

1

Dimension

Table 2 Monitoring dimensions

Key

Value

instance_id

Dedicated gateway

instance_id, node_ip

Dedicated gateway node

instance_id, api_id

API