時系列メトリックを取得する API

メトリック API を使用すると、時系列メトリックを取得できます。

これらの API は、Edge やファイアウォールなどの特定のリソースタイプの入力として複数のインテントパスまたは UUIDS を取得し、対応するメトリックを返します。時系列メトリック API の呼び出し方法の詳細については、『NSX Intelligence/NSX Application Platform API ガイド』を参照してください。

次のリストには、メトリック API に関連する用語とその説明を示します。


用語	説明
リソースタイプ	メトリックが使用可能なエンティティ（Edge ノード、ゲートウェイなど）。
リソース ID	インテントパスまたはリソースタイプの識別子。
オブジェクト	特定のリソースタイプのサブエンティティ。たとえば、ルールセット内のファイアウォールルールなど。
メトリックキー	任意のリソースのメトリックに割り当てられた一意のキー。次のメトリックキーは、Edge ノードと NSX Manager で使用可能なキーの例です。 disk.avg_used_percent：合計に対して使用中のブロックの割合。 system.avg_load：過去 1 分間のシステムの平均負荷。 system.avg_mem_available_percent：メモリの合計に対する使用可能なメモリの割合。次のメトリックキーは、ゲートウェイファイアウォールで使用可能なキーの例です。 edge_fw.avg_drop_reason_alg：Application Layer Gateway によるファイアウォールの平均ドロップ率。 edge_fw.avg_drop_reason_connection_limit：connection-limit による 1 秒あたりの平均ドロップ率。次の API を使用すると、必要なリソースのメトリックキーを取得できます。 `GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=<resource_type>`

次の手順で必要なリソースのメトリックを取得します。これらの例のメトリックキーは、サンプル目的でのみ使用しています。実際のキーと説明を取得する場合は、適切な API を使用してください。

手順 1：時系列メトリックを取得するリソースタイプを選択する

Edge ノードとゲートウェイの時系列メトリックを取得できます。以下のリストからリソースタイプを選択します。

PolicyEdgeNode

ClusterNode

Tier0Interface

Tier1Interface

Tier0

Tier1

手順 2：サポートされているメトリックキーとそのリソースタイプの情報を取得する

次の API を使用して、リソースタイプでサポートされているメトリックキーを取得します。API は resource_type をクエリパラメータとして取得し、そのリソースで使用可能なすべてのメトリックを一覧表示します。この API は、各メトリックの説明と単位も提供します。

URI パス：

GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=<resource_type>

例：

GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=PolicyEdgeNode

応答：

{
  "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"
        }
  ]
}

}

手順 3：リソースとメトリックキーのオブジェクト情報を取得する

次の API を使用して、必要なリソースタイプのメトリックキーのオブジェクト情報を取得します。

URI パス：

POST https://<manager>/napp/api/v1/metrics/object-info

要求の例：

{
    "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
}

応答の例：

{
    "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)",
                    
                }
            ]
        }
    ]
}

手順 4：メトリックデータを取得する

次の API を使用して、メトリックデータを取得します。

URI パス：

POST https://<manager>/napp/api/v1/metrics/data

要求の例：

{
    "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
}

応答の例：

{
    "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
                                }
                           }
                    ]
                }
            ]
        }

手順 1：時系列メトリックを取得するリソース タイプを選択する

手順 2：サポートされているメトリック キーとそのリソース タイプの情報を取得する

手順 3：リソースとメトリック キーのオブジェクト情報を取得する

手順 4：メトリック データを取得する

手順 1：時系列メトリックを取得するリソースタイプを選択する

手順 2：サポートされているメトリックキーとそのリソースタイプの情報を取得する

手順 3：リソースとメトリックキーのオブジェクト情報を取得する

手順 4：メトリックデータを取得する