Azure REST API を使用して Load Balancer の使用状況メトリックを取得する

[アーティクル]
05/11/2023

Azure REST API を使用して、ある期間に Standard Load Balancer によって処理されたバイト数を収集します。

完全なリファレンスドキュメントと REST API の他の例は、Azure Monitor REST リファレンスで確認できます。

要求を作成する

Standard Load Balancer から ByteCount メトリックを収集するには、次の GET 要求を使用します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/providers/microsoft.insights/metrics?api-version=2018-01-01&metricnames=ByteCount&timespan=2018-06-05T03:00:00Z/2018-06-07T03:00:00Z

要求ヘッダー

次のヘッダーは必須です｡

要求ヘッダー	説明
Content-Type:	必須。 `application/json` を設定します。
Authorization:	必須。有効な `Bearer` アクセストークンを設定します｡

URI パラメーター

Name	説明
subscriptionId	Azure サブスクリプションを識別するサブスクリプション ID。複数のサブスクリプションをお持ちの場合は､Working with multiple subscriptionsを参照してください｡
resourceGroupName	リソースが含まれているリソースグループの名前。この値は、Azure Resource Manager API、CLI、またはポータルから取得できます。
loadBalancerName	Azure Load Balancer の名前。
metric names	有効な Load Balancer メトリックのコンマ区切りリスト。
api-version	要求で使用する API のバージョン。このドキュメントでは、api-version `2018-01-01` を使用し、上記の URL に含まれています。
TimeSpan	クエリの期間。これは `startDateTime_ISO/endDateTime_ISO` の形式を持つ文字列です。この省略可能なパラメーターは、例では 1 日分のデータを返すように設定されています。

要求本文

この操作では、要求本文は必要ありません。

応答の処理

メトリック値の一覧が正常に返された場合は、状態コード 200 が返されます。エラーコードの完全な一覧は、リファレンスドキュメントで確認できます。

応答の例

{
    "cost": 0,
    "timespan": "2018-06-05T03:00:00Z/2018-06-07T03:00:00Z",
    "interval": "PT1M",
    "value": [
        {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/providers/Microsoft.Insights/metrics/ByteCount",
            "type": "Microsoft.Insights/metrics",
            "name": {
                "value": "ByteCount",
                "localizedValue": "Byte Count"
            },
            "unit": "Count",
            "timeseries": [
                {
                    "metadatavalues": [],
                    "data": [
                        {
                            "timeStamp": "2018-06-06T17:24:00Z",
                            "total": 1067921034.0
                        },
                        {
                            "timeStamp": "2018-06-06T17:25:00Z",
                            "total": 0.0
                        },
                        {
                            "timeStamp": "2018-06-06T17:26:00Z",
                            "total": 3781344.0
                        },
                    ]
                }
            ]
        }
    ],
    "namespace": "Microsoft.Network/loadBalancers",
    "resourceregion": "eastus"
}