メトリックは、仮想サービス、サービス エンジン、プール、サーバ、仮想マシン、およびホスト オブジェクトでサポートされます。

すべてのメトリック API の構文は次のとおりです。

https://${controller}/api/analytics/metrics/ ${object_type}/${object_uuid}/?metric_id=${metric_id}& ${additional_kv_options}

デフォルトでは、API はテナント管理者を使用します。管理以外の特定のテナントに対してクエリを実行するには、HTTP ヘッダー X-AVI-TENANT を追加します。X-AVI-TENANT ヘッダーを指定すると、分析 API が提供される前に、そのテナントに対してユーザー アクセスがチェックされます。

たとえば、仮想サービス virtualservice-abc の metricsl4_client.avg_bandwidth、l7_client.avg_complete_responses を、5 分間隔で過去 6 時間（72 個のサンプル）にわたってクエリするには、次の API を使用します。

https://avicontroller/api/analytics/metrics/ virtualservice/virtualservice-abc/?metric_id=l4_client.avg_bandwidth, l7_client.avg_complete_responses&limit=72&step=300

すべてのオプションのうち、limit、step、start、および stop が連携して動作します。step は、メトリック集約の期間の粒度を示します。たとえば、step=300 は、average、sum、max などが5 分の時間枠のメトリックを使用して計算されることを意味します。

メトリック API は、step で指定されたとおり、5 分ごとに 1 つの値を返します。NSX Advanced Load Balancer ソリューションは、step の値を 300、3,600、86,400 までサポートします。start と stop が指定されていない場合、stop は UTC の最新時刻であると見なされ、start は stop - limit * step の式を使用して計算されます。start および step のみを指定すると、ソリューションは、time = start 以降で使用可能なすべてのメトリックを返すために、式 (stop - start) / step に基づいて制限を計算します。

API を使用してメトリックを取得する方法の詳細については、「メトリック API」に関する説明を参照してください。

メトリック収集の構成手順については、「メトリックの収集」に関する説明を参照してください。

API を使用したメトリックの取得方法

  1. 直近 6 時間のメトリックを取得する：limit=72 & step=300。

  2. 過去 1 日のメトリックを取得する：limit=288 & step=300。

  3. T1 以降のメトリックを取得する：start=T1 & step=300。

  4. 最新の単一メトリックを取得する：limit=1 & step=300。