REST API を使用して仮想マシンの使用状況のメトリックを取得する

[アーティクル]
10/15/2024

適用対象: ✔️ Linux VM ✔️ フレキシブルなスケールセット

この例では、Azure REST API を使用して、Linux 仮想マシンの CPU 使用率を取得する方法を示します。

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

要求を作成する

仮想マシンから CPU の割合メトリックを収集するには、次の GET 要求を使用します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmname}/providers/microsoft.insights/metrics?api-version=2018-01-01&metricnames=Percentage%20CPU&timespan=2018-06-05T03:00:00Z/2018-06-07T03:00:00Z

要求ヘッダー

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

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

URI パラメーター

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

要求本文

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

応答の処理

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

応答の例

{
    "cost": 0,
    "timespan": "2018-06-08T23:48:10Z/2018-06-09T00:48:10Z",
    "interval": "PT1M",
    "value": [
        {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmname}/providers/microsoft.insights/metrics?api-version=2018-01-01&metricnames=Percentage%20CPU",
            "type": "Microsoft.Insights/metrics",
            "name": {
                "value": "Percentage CPU",
                "localizedValue": "Percentage CPU"
            },
            "unit": "Percent",
            "timeseries": [
                {
                    "metadatavalues": [],
                    "data": [
                        {
                            "timeStamp": "2018-06-08T23:48:00Z",
                            "average": 0.44
                        },
                        {
                            "timeStamp": "2018-06-08T23:49:00Z",
                            "average": 0.31
                        },
                        {
                            "timeStamp": "2018-06-08T23:50:00Z",
                            "average": 0.29
                        },
                        {
                            "timeStamp": "2018-06-08T23:51:00Z",
                            "average": 0.29
                        },
                        {
                            "timeStamp": "2018-06-08T23:52:00Z",
                            "average": 0.285
                        } ]
                } ]
        } ]
}

次の方法で共有