Metrics - List

サービス:: Monitor

API バージョン:: 2023-10-01

リソースのメトリック値を一覧表示します。この API では、既定の ARM 調整制限が使用されました。

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?api-version=2023-10-01

省略可能なパラメーターを含む:

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&api-version=2023-10-01&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}

URI パラメーター

名前	/	必須	型	説明
resourceUri	path	True	string	リソースの識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	$filter は、返されるメトリックデータのセットを減らすために使用されます。例：メトリックには、メタデータ A、B、C が含まれています。 - A = a1 および B = b1 または b2 の C のすべての時系列を返します *$filter=A eq 'a1' と B eq 'b1' または B eq 'b2' と C eq '' - バリアントが無効です。 $filter=A eq 'a1' と B eq 'b1' と C eq '' または B = 'b2'* 論理または演算子は 2 つの異なるメタデータ名を区切ることができないため、これは無効です。 - A = a1、B = b1、C = c1 のすべての時系列を返します。 $filter=A eq 'a1' および B eq 'b1' と C eq 'c1' - A = a1 のすべての時系列を返します *$filter=A eq 'a1' and B eq '' and C eq ''*.
aggregation	query		string	取得する集計の種類 (コンマ区切り) の一覧。例: average、minimum、maximum
AutoAdjustTimegrain	query		boolean	true に設定すると、渡された期間がこのメトリックでサポートされていない場合、API はサポートされている最も近い期間を使用して結果を返します。 false に設定すると、無効な timespan パラメーターに対してエラーが返されます。既定値は false です。
interval	query		string	ISO 8601 期間形式のクエリの間隔 (つまり、タイムグレイン)。既定値は PT1M です。要求された期間全体の単一データポイントを返す 'FULL' 値の特殊なケース。例: PT15M、PT1H、P1D、FULL
metricnames	query		string	取得するメトリックの名前 (コンマ区切り)。 20 のメトリックを制限します。
metricnamespace	query		string	必要なメトリックが存在するメトリック名前空間。
orderby	query		string	結果の並べ替えに使用する集計と並べ替えの方向。指定できる注文は 1 つだけです。例: 合計 asc
resultType	query		ResultType	収集されるデータのセットを減らします。使用できる構文は、操作によって異なります。詳細については、操作の説明を参照してください。
rollupby	query		string	結果をロールアップするディメンション名。たとえば、"City eq Seattle or City eq Tacoma" のようなフィルターを使用してメトリック値のみを表示したいが、市区町村ごとに個別の値を表示したくない場合は、'RollUpBy=City' を指定して、シアトルとタコマの結果を 1 つの時系列にロールアップして表示できます。
timespan	query		string	クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。
top	query		integer (int32)	要求内のリソース ID ごとに取得するレコードの最大数。フィルターが指定されている場合にのみ有効です。既定値は 10 です。
ValidateDimensions	query		boolean	false に設定すると、無効なフィルターパラメーター値は無視されます。 true に設定すると、無効なフィルターパラメーターに対してエラーが返されます。既定値は true です。

応答

名前	型	説明
200 OK	Response	メトリック値の一覧を取得する要求が成功しました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get Metric for data

Get Metric for metadata

Get Metric with error

Get Metric for data

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2021-04-20T09:00:00.000Z/2021-04-20T14:00:00.000Z&interval=PT6H&metricnames=BlobCount,BlobCapacity&aggregation=average,minimum,maximum&top=5&orderby=average asc&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices&AutoAdjustTimegrain=True&ValidateDimensions=False

応答のサンプル

状態コード:: 200

{
  "cost": 598,
  "timespan": "2021-04-20T09:00:00Z/2021-04-20T14:00:00Z",
  "interval": "PT1H",
  "value": [
    {
      "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCount",
        "localizedValue": "Blob Count"
      },
      "displayDescription": "The number of blob objects stored in the storage account.",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Hot"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Standard"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Cool"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Archive"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Untiered"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        }
      ],
      "errorCode": "Success"
    },
    {
      "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCapacity",
        "localizedValue": "Blob Capacity"
      },
      "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
      "unit": "Bytes",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Standard"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Hot"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Archive"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Untiered"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Cool"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.storage/storageaccounts/blobservices",
  "resourceregion": "westus2"
}

Get Metric for metadata

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices

応答のサンプル

状態コード:: 200

{
  "timespan": "2021-04-15T02:18:00Z/2021-04-22T02:18:00Z",
  "interval": "PT1H",
  "value": [
    {
      "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCount",
        "localizedValue": "Blob Count"
      },
      "displayDescription": "The number of blob objects stored in the storage account.",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Cool"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Archive"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Standard"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Untiered"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Hot"
            }
          ]
        }
      ]
    }
  ],
  "namespace": "microsoft.storage/storageaccounts/blobservices",
  "resourceregion": "westus2"
}

Get Metric with error

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics?timespan=2021-06-07T21:51:00Z/2021-06-08T01:51:00Z&interval=FULL&metricnames=MongoRequestsCount,MongoRequests&aggregation=average&api-version=2023-10-01&metricnamespace=microsoft.documentdb/databaseaccounts&AutoAdjustTimegrain=True&ValidateDimensions=False

応答のサンプル

状態コード:: 200

{
  "cost": 239,
  "timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z",
  "interval": "PT4H",
  "value": [
    {
      "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequestsCount",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "MongoRequestsCount",
        "localizedValue": "(deprecated) Mongo Request Rate"
      },
      "unit": "CountPerSecond",
      "timeseries": [],
      "errorMessage": "Sampling type is not found. Metric:CosmosDBCustomer,AzureMonitor,MongoRequests, SamplingType:NullableAverage.",
      "errorCode": "InvalidSamplingType"
    },
    {
      "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequests",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "MongoRequests",
        "localizedValue": "Mongo Requests"
      },
      "displayDescription": "Number of Mongo Requests Made",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [],
          "data": [
            {
              "timeStamp": "2021-06-07T21:51:00Z",
              "average": 0
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.documentdb/databaseaccounts",
  "resourceregion": "westus2"
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
LocalizableString	ローカライズ可能な文字列クラス。
MetadataValue	メトリックメタデータ値を表します。
Metric	クエリの結果データ。
MetricUnit	メトリックの単位。
MetricValue	メトリック値を表します。
Response	メトリッククエリへの応答。
ResultType	収集されるデータのセットを減らします。使用できる構文は、操作によって異なります。詳細については、操作の説明を参照してください。
TimeSeriesElement	時系列の結果の種類。この場合、識別子の値は常に TimeSeries です。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

Object

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorResponse[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

LocalizableString

Object

ローカライズ可能な文字列クラス。

名前	型	説明
localizedValue	string	表示名。
value	string	不変値。

MetadataValue

Object

メトリックメタデータ値を表します。

名前	型	説明
name	LocalizableString	メタデータの名前。
value	string	メタデータの値。

Metric

Object

クエリの結果データ。

名前	型	説明
displayDescription	string	このメトリックの詳細な説明。
errorCode	string	"成功" またはこのメトリックのクエリエラーに関するエラーの詳細。
errorMessage	string	この特定のメトリックに対してクエリを実行するエラーメッセージが発生しました。
id	string	メトリック ID。
name	LocalizableString	メトリックの名前と表示名。つまり、ローカライズ可能な文字列です。
timeseries	TimeSeriesElement[]	データクエリの実行時に返される時系列。
type	string	メトリックリソースのリソースの種類。
unit	MetricUnit	メトリックの単位。

MetricUnit

列挙

メトリックの単位。

値	説明
Count	未加工数量の単位。
Bytes	メモリの単位 (バイト単位)。
Seconds	秒単位の時間の単位。
CountPerSecond	1 秒あたりの生量のレート単位。
BytesPerSecond	1 秒あたりのメモリのレート単位 (バイト単位)。
Percent	パーセンテージの単位。
MilliSeconds	秒の 1/1000 分の 1 の時間単位。
ByteSeconds	データ転送またはストレージの単位。これは、データのサイズ (バイト単位) に、データの転送または格納にかかる時間を秒単位で乗算したものです。
Unspecified	指定された単位はありません。
Cores	処理能力の単位。
MilliCores	CPU コアの 1/1000 分の 1 の処理能力の単位。
NanoCores	CPU コアの 10 億分の 1 の処理能力の単位。
BitsPerSecond	1 秒あたりの 2 進数のレート単位。

MetricValue

Object

メトリック値を表します。

名前	型	説明
average	number (double)	時間範囲の平均値。
count	number (double)	時間範囲内のサンプルの数。平均値に寄与した値の数を決定するために使用できます。
maximum	number (double)	時間範囲内の最大値。
minimum	number (double)	時間範囲内の最小値。
timeStamp	string (date-time)	ISO 8601 形式のメトリック値のタイムスタンプ。
total	number (double)	時間範囲内のすべての値の合計。

Response

Object

メトリッククエリへの応答。

名前	型	説明
cost	number (int32) minimum: 0	クエリの相対コストを表す整数値。
interval	string	メトリックデータが ISO 8601 期間形式で返された間隔 (ウィンドウサイズ) 。要求された期間全体の単一データポイントを返す 'FULL' 値の特殊なケース (例: PT15M、PT1H、P1D、FULL)。これは、AutoAdjustTimegrain=true が指定されている場合に最初に要求されたものとは異なる場合があります。これは、メタデータ要求が行われた場合は存在しません。
namespace	string	クエリ対象のメトリックの名前空間
resourceregion	string	メトリックのクエリを実行するリソースのリージョン。
timespan	string	データが取得された期間。その値は、連結された 2 つの datetime で構成され、'/' で区切ります。これは将来調整され、最初に要求されたものから返される可能性があります。
value	Metric[]	コレクションの値。

ResultType

列挙

収集されるデータのセットを減らします。使用できる構文は、操作によって異なります。詳細については、操作の説明を参照してください。

値	説明
Data
Metadata

TimeSeriesElement

Object

時系列の結果の種類。この場合、識別子の値は常に TimeSeries です。

名前	型	説明
data	MetricValue[]	メトリック値を表すデータポイントの配列。これは、結果のデータ型が指定されている場合にのみ返されます。
metadatavalues	MetadataValue[]	呼び出しで$filterが指定された場合に返されるメタデータ値。