NSX Advanced Load Balancer API を使用して、仮想サービスのスループット データやその他のメトリックにアクセスできます。
/API/analytics/metrics への API 呼び出しは、すべてのメトリック関連データを取得するために使用されます。次の例は、24 時間の仮想サービスのスループットに関するクエリを示しています。
https://<Controller VIP>/api/analytics/metrics/virtualservice/virtualservice-<VS UUID>?metric_id=l4_client.avg_bandwidth &step=86400&limit=7&start=2015-11-17T00:00:00.000Z
Controller VIP：NSX Advanced Load Balancer Controller の IP アドレスまたは冗長コントローラのクラスタに割り当てられたクラスタ IP アドレスに置き換えます。VS UUID：仮想サービスのユニバーサル一意 ID (UUID)。仮想サービス名は複数のテナント間で一意でない場合があるため、API クエリに仮想サービスの UUID を含めることをお勧めします。
仮想サービスの UUID を簡単に見つけるには、コントローラの Web インターフェイスで仮想サービスを表示し、ブラウザの URI から UUID をキャプチャします。仮想サービスの UUID を検索するには、『VMware NSX Advanced Load Balancer 構成ガイド』の「仮想サービス UUID の検出」のトピックを参照してください。
step |
サンプリング期間（秒）。24 時間の場合は、サンプリング時間 86,400 を使用します。 |
制限 |
返されるデータ ポイントの最大数（日数）。この例では、7 つのデータ ポイントが返されます。各データ ポイントは、クライアントから仮想サービスへのネットワーク スループットの、その日の平均です。 |
起動 |
クエリの開始時間。この例では、クエリは 10 月 17 日に開始し、7 日後の 10 月 23 日に終了します。同様に、開始点が 2 に設定されている場合、2 日間のそれぞれの日に 1 つずつで、2 つのデータ ポイントのみが返されます。 |
metric_id |
クエリ対象のメトリック。一般的にクエリの対象となるメトリックのメトリック ID を次に示します。
|
次に、l4_client.avg_bandwidth の API クエリに応答して NSX Advanced Load Balancer Controller が返すデータの例を示します。
{
"entity_uuid": "virtualservice-9062c630-a835-4c22-8596-dfa625b9697d",
"limit": 365,
"metric_entity": "VSERVER_METRICS_ENTITY",
"metric_id": "l4_client.avg_bandwidth",
"series": [
{
"data": [
{
"timestamp": "2015-11-17T00:00:00+00:00",
"value": 511500369.582942
},
{
"timestamp": "2015-11-18T00:00:00+00:00",
"value": 641335291.443974
},
{
"timestamp": "2015-11-19T00:00:00+00:00",
"value": 642964876.307424
},
{
"timestamp": "2015-11-20T00:00:00+00:00",
"value": 652721668.799788
},
{
"timestamp": "2015-11-21T00:00:00+00:00",
"value": 833373106.654519
},
{
"timestamp": "2015-11-22T00:00:00+00:00",
"value": 670429050.977858
},
{
"timestamp": "2015-11-23T00:00:00+00:00",
"value": 671784391.196803
},
],
"header": {
"derivation_data": {
"derivation_fn": "SUM_BW_GAUGE",
"metric_ids": "avg_rx_bytes, avg_tx_bytes"
},
"entity_uuid": "virtualservice-9062c630-a835-4c22-8596-dfa625b9697d",
"metric_description": "Average transmit and receive network bandwidth between client and virtual service.",
"metrics_min_scale": 1000000.0,
"metrics_sum_agg_invalid": false,
"name": "l4_client.avg_bandwidth",
"obj_id_type": "METRICS_OBJ_ID_TYPE_VIRTUALSERVICE",
"priority": true,
"statistics": {
"max": 833373106.654519,
"max_ts": "2015-11-21T00:00:00+00:00",
"mean": 663407846.526,
"min": 511500369.582942,
"min_ts": "2015-11-17T00:00:00+00:00",
"num_samples": 7,
"trend": -0.029
},
"tenant_uuid": "admin",
"units": "BITS_PER_SECOND"
}
}
],
"start": "2015-11-17T00:00:00.000Z",
"step": 86400,
"stop": "2015-11-23T00:00:00+00:00"
}
