DocsICP FilingConsole
Documentation
Home Page Server Load Balancer Network Load Balancer User Guide NLB monitoring metrics View NLB monitoring data

View NLB monitoring information

Updated at:
Copy as MD
Product
My Favorites

When you encounter network issues with your Network Load Balancer (NLB) instance, such as request timeouts, traffic throttling, or dropped connections, you can use CloudMonitor to investigate. CloudMonitor provides detailed metrics on the operational status and performance of your NLB resources, helping you quickly identify and diagnose problems. You can view NLB monitoring data using the console, the API, or an SDK.

View monitoring data in the console

  1. Log on to the NLB console.

  2. In the top navigation bar, select the region in which the NLB instance is deployed.

  3. On the Instances page, you can view monitoring data in two ways:

    • View data from the instance list

      1. On the Instances page, find the target instance and click monitor in the Monitoring column.

      2. In the Monitoring Information panel that appears, switch between the NLB Instance, Listener, and VIP (Zone) tabs to view monitoring data.

    • View data from the instance details page

      1. On the Instances page, find the target instance and click its ID.

      2. On the Instance Details page, click the Monitoring Chart tab.

      3. On the Monitoring Chart tab, switch between the NLB Instance, Listener, and VIP (Zone) tabs to view monitoring data.

    Note

    • For more information about NLB metrics, see NLB metrics.

    • By default, monitoring data from the last hour is displayed. You can select a time range of 3 hours, 6 hours, or 12 hours. You can also select Custom to specify a custom time range.

    • If you enable Auto Refresh, the monitoring chart automatically updates every minute.

View monitoring data via API

This section describes how to use the CloudMonitor API to query metrics and detailed monitoring data for an NLB instance.

The following figure shows the API query workflow.monitoring

The workflow is as follows:

  1. Query the namespace. Call the DescribeProjectMeta operation to query the namespace of NLB in CloudMonitor.

  2. Optional: View available metrics. Call the DescribeMetricMetaList operation to query available time-series metrics in CloudMonitor, or see NLB metrics.

  3. Query monitoring data for a specific metric.

    • Call the DescribeMetricLast operation to query the latest data point for a specific NLB metric.

    • Call the DescribeMetricList operation to query time-series data for a specific NLB metric over a specified period.

DescribeProjectMeta

Call the DescribeProjectMeta operation to query the namespace of NLB in CloudMonitor. For more information, see DescribeProjectMeta.

  1. Log on to OpenAPI Explorer.

  2. Set request parameters. Set the Labels parameter to [{"name":"product","value":"NLB"}]. Keep the default values for other parameters and click Initiate Call.

    Sample request

    http(s)://[Endpoint]/?Action=DescribeProjectMeta
&Labels=[{"name":"product","value":"NLB"}]
&<common request parameters>

  3. In the response, find the namespace for NLB. The value of Namespace is acs_nlb.

    Sample response

    {
  "RequestId": "D214F951-A63D-523D-8EB5-827F691C0F76",
  "PageSize": 30,
  "PageNumber": 1,
  "Total": 1,
  "Resources": {
    "Resource": [
      {
        "Description": "Network Load Balancer",
        "Labels": "[{\"name\":\"product\",\"value\":\"NLB\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"groupFlag\",\"value\":\"true\"},{\"name\":\"cnName\",\"value\":\"Network Load Balancer\"},{\"name\":\"enName\",\"value\":\"Network Load Balancer\"}]",
        "Namespace": "acs_nlb"
      }
    ]
  },
  "Code": 200,
  "Success": true
}

DescribeMetricMetaList

Call the DescribeMetricMetaList operation to query available time-series metrics in CloudMonitor. For more information, see DescribeMetricMetaList.

  1. Log on to OpenAPI Explorer.

  2. Set request parameters. Set the Namespace parameter to acs_nlb. Keep the default values for other parameters and click Initiate Call.

    Sample request 

    http(s)://[Endpoint]/?Action=DescribeMetricMetaList
&Namespace=acs_nlb
&<common request parameters>

  3. In the response, view the available time-series metrics for NLB.

    Sample response

    {
  "TotalCount": 30,
  "RequestId": "9912911F-AEE2-52A0-AF4E-E0EC16F859E4",
  "Resources": {
    "Resource": [
      {
        "MetricName": "ActiveConnection",
        "Periods": "60,300",
        "Description": "The number of active connections on a listener per second.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "DropConnection",
        "Periods": "60,300",
        "Description": "The number of connections dropped by a listener per second.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "DropPacketRX",
        "Periods": "60,300",
        "Description": "The number of inbound packets dropped by a listener per second.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "DropPacketTX",
        "Periods": "60,300",
        "Description": "The number of outbound packets dropped by a listener per second.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "DropTrafficRX",
        "Periods": "60,300",
        "Description": "The amount of inbound traffic dropped by a listener per second, in bit/s.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "DropTrafficTX",
        "Periods": "60,300",
        "Description": "The amount of outbound traffic dropped by a listener per second, in bit/s.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InactiveConnection",
        "Periods": "60,300",
        "Description": "The number of inactive connections on a listener.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count",
        "Statistics": "Sum",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceActiveConnection",
        "Periods": "60,300",
        "Description": "The number of active connections on an instance.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceDropConnection",
        "Periods": "60,300",
        "Description": "The number of connections dropped by an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceDropPacketRX",
        "Periods": "60,300",
        "Description": "The number of inbound packets dropped by an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceDropPacketTX",
        "Periods": "60,300",
        "Description": "The number of outbound packets dropped by an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceDropTrafficRX",
        "Periods": "60,300",
        "Description": "The amount of inbound traffic dropped by an instance per second, in bit/s.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceDropTrafficTX",
        "Periods": "60,300",
        "Description": "The amount of outbound traffic dropped by an instance per second, in bit/s.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceInactiveConnection",
        "Periods": "60,300",
        "Description": "The number of inactive connections on an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceMaxConnection",
        "Periods": "60,300",
        "Description": "The maximum number of concurrent connections on an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceNewConnection",
        "Periods": "60,300",
        "Description": "The number of new connections established on an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstancePacketRX",
        "Periods": "60,300",
        "Description": "The number of inbound packets received by an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstancePacketTX",
        "Periods": "60,300",
        "Description": "The number of outbound packets sent from an instance per second.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceTrafficRX",
        "Periods": "60,300",
        "Description": "The amount of inbound traffic to an instance per second, in bit/s.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceTrafficTX",
        "Periods": "60,300",
        "Description": "The amount of outbound traffic from an instance per second, in bit/s.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "InstanceUnhealthyServerCount",
        "Periods": "60,300",
        "Description": "The number of unhealthy backend servers of an instance as detected by health checks.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count",
        "Statistics": "Sum",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "ListenerHealthyServerCount",
        "Periods": "60,300",
        "Description": "The number of healthy backend servers of a listener as detected by health checks.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count",
        "Statistics": "Minimum",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "ListenerPacketRX",
        "Periods": "60,300",
        "Description": "The number of inbound packets received by a listener per second.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "ListenerPacketTX",
        "Periods": "60,300",
        "Description": "The number of outbound packets sent from a listener per second.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "ListenerUnhealthyServerCount",
        "Periods": "60,300",
        "Description": "The number of unhealthy backend servers of a listener as detected by health checks.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count",
        "Statistics": "Maximum",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "MaxConnection",
        "Periods": "60,300",
        "Description": "The maximum number of connections on a listener per second.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"false\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "NewConnection",
        "Periods": "60,300",
        "Description": "The number of new connections established on a listener.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "Count/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "NlbInstanceHealthyServerCount",
        "Periods": "60,300",
        "Description": "The number of healthy backend servers for an NLB instance.",
        "Dimensions": "userId,instanceId",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Count\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"HighResolution\",\"value\":\"false\"},{\"name\":\"HighResolutionPeriod\",\"value\":\"\"},{\"name\":\"dataType\",\"value\":\"\"},{\"name\":\"DefaultTemplate\",\"value\":\"true\"},{\"name\":\"dashboardFlag\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"instance\"}]",
        "Unit": "Count",
        "Statistics": "Sum",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "TrafficRXNew",
        "Periods": "60,300",
        "Description": "The amount of inbound traffic to a listener per second, in bit/s.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      },
      {
        "MetricName": "TrafficTXNew",
        "Periods": "60,300",
        "Description": "The amount of outbound traffic from a listener per second, in bit/s.",
        "Dimensions": "userId,instanceId,listenerPort,listenerProtocol",
        "Labels": "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"bits/s\"},{\"name\":\"productCategory\",\"value\":\"nlb\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"port\"}]",
        "Unit": "bits/s",
        "Statistics": "Average",
        "Namespace": "acs_nlb"
      }
    ]
  },
  "Code": 200,
  "Success": true
}

DescribeMetricLast

Call the DescribeMetricLast operation to query the latest data point for a specific NLB metric. This example shows how to query data for the InstanceNewConnection metric, which indicates the number of new connections established on an instance per second. For more information, see DescribeMetricLast.

  1. Log on to OpenAPI Explorer.

  2. Set the request parameters to query the InstanceNewConnection metric, and then click Initiate Call.

    Set the following parameters and keep the default values for the others.

    • MetricName: The name of the metric. Set the value to InstanceNewConnection.

    • Dimensions: The dimensions of the resource to query. Set the value to [{"instanceId":"nlb-defs3vztfty3nm****"}].

    • Namespace: The namespace of the service. Set the value to acs_nlb.

    Sample request

    http(s)://[Endpoint]/?Action=DescribeMetricLast
&MetricName=InstanceNewConnection
&Namespace=acs_nlb
&Dimensions=[{"instanceId":"nlb-defs3vztfty3nm****"}]
&<common request parameters>

  3. In the response, view the latest monitoring data for the InstanceNewConnection metric.

    Sample response 

    {
  "RequestId": "7F96EE67-5172-567E-9A80-410705EC4A99",
  "Period": "60",
  "Datapoints": "[{\"timestamp\":1665479760000,\"instanceId\":\"nlb-defs3vztfty3nm****\",\"userId\":\"1461700914926653\",\"Average\":7.0}]",
  "Code": "200",
  "Success": true
}

DescribeMetricList

Call the DescribeMetricList operation to query the time-series data of an NLB metric over a specified period. This example shows how to query data for the InstanceMaxConnection metric, which indicates the maximum number of concurrent connections on an instance per second. For more information, see DescribeMetricList.

  1. Log on to OpenAPI Explorer.

  2. Set the request parameters to query monitoring data for InstanceMaxConnection over a specified time range, and then click Initiate Call.

    Set the following parameters and keep the default values for the others.

    • MetricName: The name of the metric. Set the value to InstanceMaxConnection.

    • Namespace: The namespace of the service. Set the value to acs_nlb.

    • Dimensions: The dimensions of the resource to query. Set the value to [{"instanceId":"nlb-q5515xt60rx5s2****"}].

    • StartTime: The start of the time range to query. The value of this parameter must be earlier than the value of EndTime. Set the value to 2022-10-13 20:45:03.

      Supported formats:

      • UNIX timestamp: The number of milliseconds since 00:00:00 UTC on January 1, 1970.

      • ISO 8601 format: YYYY-MM-DDThh:mm:ssZ.

    • EndTime: The end of the time range to query. The supported formats are the same as those for StartTime. Set the value to 2022-10-13 20:47:03.

    Sample request

    http(s)://[Endpoint]/?Action=DescribeMetricList
&MetricName=InstanceMaxConnection
&Namespace=acs_nlb
&Dimensions=[{"instanceId":"nlb-q5515xt60rx5s2****"}]
&StartTime=2022-10-13 20:45:03
&EndTime=2022-10-13 20:47:03
&<common request parameters>

  3. In the response, view the monitoring data for InstanceMaxConnection during the specified time range.

    Sample response

    {
  "RequestId": "8FBB3D06-834C-57EA-B641-37538EB5FF4E",
  "Period": "60",
  "Datapoints": "[{\"timestamp\":1665665040000,\"instanceId\":\"nlb-q5515xt60rx5s2****\",\"userId\":\"1429972739299349\",\"Average\":3.9668172E7},{\"timestamp\":1665665100000,\"instanceId\":\"nlb-q5515xt60rx5s2****\",\"userId\":\"1429972739299349\",\"Average\":3.9668172E7}]",
  "Code": "200",
  "Success": true
}

View monitoring data via SDK

You can use an SDK to query metrics and detailed monitoring data for NLB. This example shows how to call the DescribeMetricList operation to query the maximum number of concurrent connections on an NLB instance per second.

  1. Log on to OpenAPI Explorer.

  2. Set the following request parameters and keep the default values for the others.

    • MetricName: The name of the metric. In this example, set the value to InstanceMaxConnection.

    • Namespace: The namespace of the service. In this example, set the value to acs_nlb.

    • Dimensions: The dimensions of the resource to query. In this example, set the value to [{"instanceId":"nlb-q5515xt60rx5s2****"}].

    • StartTime: The start of the time range to query. The value of this parameter must be earlier than the value of EndTime. In this example, set the value to 2022-10-13 20:45:03.

      Supported formats:

      • UNIX timestamp: The number of milliseconds since 00:00:00 UTC on January 1, 1970.

      • ISO 8601 format: YYYY-MM-DDThh:mm:ssZ.

    • EndTime: The end of the time range to query. The supported formats are the same as those for StartTime. In this example, set the value to 2022-10-13 20:47:03.

  3. On the SDK Sample Code tab, select a language such as Python and click Run in the right-side panel.

  4. View the result in the panel that appears at the bottom of the page.

Previous：NLB monitoring metricsNext：Integrate NLB with Managed Service for Prometheus