NSX-T Data Center REST API

Query historical dataplane statistics from dp-stats.log

Queries historical dataplane statistics from dp-stats.log files. Supports filtering by time range and selecting specific metrics.


The dp-stats.log file contains periodic snapshots of dataplane statistics including CPU usage per core, packet rates, and physical port statistics.


Object ID formats (use type.id from /adf/metrics):



  • dpdk_core.X: Individual DPDK core (all edge_cpu.* metrics)

  • non_dpdk_core.X: Non-DPDK core (edge_cpu.usage only)

  • port.fp-ethX: Physical port (edge_nic.* metrics)


Key formats:



  • edge_cpu.*: CPU metrics (usage, rx_pps, tx_pps, hit_rates)

  • edge_nic.*: NIC metrics (rx/tx bytes, packets, errors, throughput)

Request:

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

Example Request:

{ "object_ids": ["dpdk_core.0", "dpdk_core.1", "non_dpdk_core.2", "port.fp-eth0"], "keys": [ "edge_cpu.usage", "edge_cpu.rx_pps", "edge_nic.rx_packets", "edge_nic.rx_throughput" ], "start_time": 1603971420, "end_time": 1603973420 }

Successful Response:

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

Example Response:

{ "results": [ { "key_results": [ { "key": "edge_cpu.usage", "unit": "PERCENT", "results": [ { "object_id": "dpdk_core.0", "data": [ {"time": 1603971420, "value": 0.06}, {"time": 1603971480, "value": 0.05} ] }, { "object_id": "dpdk_core.1", "data": [ {"time": 1603971420, "value": 0.04}, {"time": 1603971480, "value": 0.03} ] }, { "object_id": "non_dpdk_core.2", "data": [ {"time": 1603971420, "value": 35.51}, {"time": 1603971480, "value": 34.22} ] } ] }, { "key": "edge_cpu.rx_pps", "unit": "PER_SECOND", "results": [ { "object_id": "dpdk_core.0", "data": [ {"time": 1603971420, "value": null}, {"time": 1603971480, "value": 4} ] }, { "object_id": "dpdk_core.1", "data": [ {"time": 1603971420, "value": null}, {"time": 1603971480, "value": 2} ] } ] }, { "key": "edge_nic.rx_packets", "unit": "PACKETS", "results": [ { "object_id": "port.fp-eth0", "data": [ {"time": 1603971420, "value": null}, {"time": 1603971480, "value": 79} ] } ] }, { "key": "edge_nic.rx_throughput", "unit": "GBPS", "results": [ { "object_id": "port.fp-eth0", "data": [ {"time": 1603971420, "value": null}, {"time": 1603971480, "value": 0.0082} ] } ] } ] } ] }

Required Permissions:

read

Feature:

system_administration

Additional Errors: