Zum Abrufen der Zeitreihenmetriken können Sie die Metrik-APIs verwenden.
Diese APIs können mehrere Absichtspfade als Eingabe für einen bestimmten Ressourcentyp verwenden, z. B. Edge oder Gateway, und geben die entsprechenden Metriken zurück. Vollständige Informationen zum Aufrufen der Zeitreihenmetrik-APIs finden Sie im Handbuch für die NSX Intelligence- und NSX Application Platform-API.
Die folgende Liste enthält Begriffe und deren Beschreibungen im Zusammenhang mit Metrik-APIs.
| Begriff | Beschreibung |
|---|---|
| Ressourcentyp | Jede Entität, z. B. Edge-Knoten oder Gateway, für die Metriken verfügbar sind. |
| Ressourcen-ID | Absichtspfad oder ein Bezeichner für einen Ressourcentyp. |
| Objekt | Unterentität eines bestimmten Ressourcentyps. Beispiel: Firewallregel innerhalb eines Regelsatzes. |
| Metrikschlüssel | Eindeutiger Schlüssel, der einer Metrik einer beliebigen Ressource zugewiesen ist. Die folgenden Metrikschlüssel sind Beispiele für Schlüssel, die für Edge-Knoten und NSX Manager verfügbar sind:
Die folgenden Metrikschlüssel sind Beispiele für Schlüssel, die für Gateway-Firewalls verfügbar sind:
Sie können die folgende API verwenden, um Metrikschlüssel aller erforderlichen Ressourcen abzurufen.
|
Führen Sie die folgenden Schritte aus, um Metriken für eine erforderliche Ressource abzurufen. Beachten Sie, dass die in Beispielen verwendeten Metrikschlüssel nur der Veranschaulichung dienen. Verwenden Sie die entsprechende API, um tatsächliche Schlüssel und Beschreibungen abzurufen.
Schritt 1: Ressourcentyp auswählen, für den Sie die Zeitreihenmetriken abrufen möchten
- PolicyEdgeNode
- ClusterNode
- Tier0Interface
- Tier1Interface
- Tier0
- Tier1
Schritt 2: Unterstützte Metrikschlüssel und die zugehörigen Informationen für einen Ressourcentyp abrufen
Verwenden Sie die folgende API, um unterstützte Metrikschlüssel für einen Ressourcentyp abzurufen. Die API verwendet resource_type als Abfrageparameter und listet alle Metriken auf, die für diese Ressource verfügbar sind. Diese API bietet auch Beschreibungen und Einheiten für jede Metrik.
URI-Pfad:
GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=<resource_type>
Beispiel:
GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=PolicyEdgeNode
Antwort:
{
"results":[
{
"metric_key ":"edge.cpu_usage",
"metric_unit":"PERCENT",
"description":"Edge Cpu usage percentage"
},
{
"metric_key":"edge.pnic_avg_rx_packets",
"metric_unit":"PER_SECOND"
"description":"Average Rx packets per second"
}
]
}
}
Schritt 3: Objektinformationen für eine Ressource und einen Metrikschlüssel abrufen
Verwenden Sie die folgende API, um die Objektinformationen eines Metrikschlüssels für einen erforderlichen Ressourcentyp abzurufen.
URI-Pfad:
POST https://<manager>/napp/api/v1/metrics/object-info
Beispielanforderung:
{
"resource_type":"PolicyEdgeNode",
"resource_ids": [
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/1349af04-21c9-11e9-be65-000c2902d0000"
],
"keys": [ "edge_cores.cpu_usage", "edge.pnic_avg_rx_packets"],
"start_time":1603971420
"end_time": 1603973420
"granularity": "5M",
"max_num_data_points": 10
}
Beispielantwort:
{
"start_time": 1603971420,
"end_time": 1603973420,
"resource_type": "PolicyEdgeNode",
"results": [
{
"resource_id": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"key_results": [
{
"key": "edge.pnic_avg_rx_packets",
"unit": "PER_SECOND",
},
{
"key": "edge_core.cpu_usage",
"results": [
{
"object_id": "core1",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"node_path": "/infra/default/edge/1",
node_name": "Edge1",
},
{
"object_id": "core2",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"node_path": "/infra/default/edge/1",
"node_name": "Edge1",
}
]
}
]
},
{
"resource_id": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/1349af04-21c9-11e9-be65-000c2902d0000",
"key_results": [
{
"key": "edge.pnic_avg_rx_packets",
"unit": "PER_SECOND",
"description": "Average packet per second (PPS) network utilization on ingress on the the management interface(s)",
}
]
}
]
}
Schritt 4: Metrikdaten abrufen
Verwenden Sie zum Abrufen von Metrikdaten die folgende API.
URI-Pfad:
POST https://<manager>/napp/api/v1/metrics/data
Beispielanforderung:
{
"resource_type":"PolicyEdgeNode",
"resource_ids": [
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/1349af04-21c9-11e9-be65-000c2902d0000"
],
"object_ids": ["core1" ,"core2"],
"node_ids": [],
"keys": [ "edge_cores.cpu_usage", "edge.pnic_avg_rx_packets"],
"start_time":1603971420
"end_time": 1603973420
"granularity": "5M",
"max_num_data_points": 10
}
Beispielantwort:
{
"start_time": 1603971420, --> output start_time and end_time maybe different from input start_time and end_time
"end_time": 1603973420,
"resource_type": "PolicyEdgeNode",
"results": [
{
"path": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"key_results": [
{
{
"key": "edge_core.cpu_usage",
"results": [
{
"object_id": "core1",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"data": [
{
"time": 1603444589,
"value": 29
},
{
"time": 1603444489,
"value": 30
},
{
"time": 1603444389,
"value": 35
}
},
{
"object_id": "core2",
"object_description": "Some description",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"node_name": "Edge1",
"node_path":"/infra/default/edge/1"
"data": [
{
"time": 1603444589,
"value": 29
},
{
"time": 1603444489,
"value": 30
},
{
"time": 1603444389,
"value": 35
}
}
]
}
]
}
