NSX-T Data Center REST API

Get dataplane metrics information organized by chart type

Returns available dataplane metrics organized by chart/metric type:



  • cpu_usage: All DPDK and non-DPDK cores (for edge_cpu.usage metrics)

  • cpu_pps: DPDK cores only (for edge_cpu.rx_pps, edge_cpu.tx_pps metrics)

  • cpu_hit_rate: DPDK cores only (for edge_cpu.micro_hit_rates, edge_cpu.mega_hit_rates)

  • phy_port_stats: All physical ports (for edge_nic.rx_*, edge_nic.tx_* stats)

  • phy_port_throughput: All physical ports (for edge_nic.rx_throughput, edge_nic.tx_throughput)


Each metrics item contains:



  • type: Metrics type (dpdk_core, non_dpdk_core, port)

  • id: Metrics identifier (core id or port name)

  • label: Human-readable display label


Use this information to construct valid object_ids for /adf/filter queries.

Request:

Method:
GET
URI Path(s):
/api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/adf/metrics
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AdfMetricsResponse+

Example Response:

{ "result": { "cpu_usage": [ {"type": "dpdk_core", "id": "0", "label": "Core 0 (DPDK)"}, {"type": "dpdk_core", "id": "1", "label": "Core 1 (DPDK)"}, {"type": "non_dpdk_core", "id": "2", "label": "Core 2 (NON-DPDK)"}, {"type": "non_dpdk_core", "id": "3", "label": "Core 3 (NON-DPDK)"} ], "cpu_pps": [ {"type": "dpdk_core", "id": "0", "label": "Core 0 (DPDK)"}, {"type": "dpdk_core", "id": "1", "label": "Core 1 (DPDK)"} ], "cpu_hit_rate": [ {"type": "dpdk_core", "id": "0", "label": "Core 0 (DPDK)"}, {"type": "dpdk_core", "id": "1", "label": "Core 1 (DPDK)"} ], "phy_port_stats": [ {"type": "port", "id": "fp-eth0", "label": "fp-eth0"}, {"type": "port", "id": "fp-eth1", "label": "fp-eth1"} ], "phy_port_throughput": [ {"type": "port", "id": "fp-eth0", "label": "fp-eth0"}, {"type": "port", "id": "fp-eth1", "label": "fp-eth1"} ] } }

Required Permissions:

read

Feature:

system_administration

Additional Errors: