Metrics - List

リソース のメトリック値を一覧表示します

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?api-version=2018-01-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=2018-01-01&metricnamespace={metricnamespace}

URI パラメーター

Name In Required Type Description
resourceUri
path True
  • string

リソースの識別子。

api-version
query True
  • string

この操作に使用する API バージョン。

$filter
query
  • string

この $filter 返されるメトリック データのセットを減らすために使用されます。 例: メトリックにメタデータ A が含まれている B および C. - A = a1 および B = b1 または b2 $filter=A eq 'a1' と B eq 'b1' または B eq 'b2' と C eq '*' - 無効なバリアント: $filter=A eq 'a1' と B eq 'b1' と C eq '*' または B = 'b2' の間で異なる名前を付けないので無効です。 - A = a1, B = b1 および C = c1: $filter=A eq 'a1' および B eq 'b1' および C eq 'c1' - A = a1 $filter=A eq 'a1' および B eq ' および C eq ' ' のすべての時系列を返します。 特殊なケース: ディメンション名またはディメンション値が丸かっこを使用する場合。 例: ディメンション名が dim (test) 1 の場合、$filter= "dim (test) 1 eq '' " を使用する代わりに **、$filter= "dim %2528test%2529 1 eq '' "** ディメンション名が dim (test) 3 でディメンション値が dim の場合 3 (テスト) val $filter= "dim (test) 3 eq 'dim3 (test) val' " を使用する代わりに 、$filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' " を使用します

aggregation
query
  • string

取得する集計の種類の一覧 (コンマ区切り)。

interval
query
  • string
duration

クエリの間隔 (つまり、timegrain)。

metricnames
query
  • string

取得するメトリックの名前 (コンマ区切り)。 特殊なケース: メトリック名自体にコンマがある場合は、%2 を使用してそれを示します。 例: 'Metric,Name1' は 'Metric%2Name1' である必要があります

metricnamespace
query
  • string

メトリック定義のクエリを実行するメトリック名前空間。

orderby
query
  • string

結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つのみです。 例: sum asc。

resultType
query

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

timespan
query
  • string

クエリの期間。 これは、'startDateTime_ISO/endDateTime_ISO' という形式の文字列です。

top
query
  • integer
int32

取得するレコードの最大数。 指定した値が$filter場合にのみ有効です。 既定値は 10 です。

応答

Name Type Description
200 OK

メトリック値の一覧を取得する要求が成功しました。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

Get Metric for data
Get Metric for metadata
Get Metric with error

Get Metric for data

Sample Request

GET https://management.azure.com/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&interval=PT1M&aggregation=Average,count&top=3&orderby=Average asc&$filter=BlobType eq '*'&api-version=2018-01-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices

Sample Response

{
  "cost": 0,
  "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
  "interval": "PT1M",
  "namespace": "Microsoft.Storage/storageAccounts/blobServices",
  "resourceregion": "eastus2",
  "value": [
    {
      "id": "/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
      "type": "Microsoft.Insights/metrics",
      "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
      "name": {
        "value": "BlobCapacity",
        "localizedValue": "Blob Capacity"
      },
      "unit": "Bytes",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "PageBlob"
            }
          ],
          "data": [
            {
              "timeStamp": "2017-04-14T02:20:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:21:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:22:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:23:00Z",
              "count": 1,
              "average": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "BlockBlob"
            }
          ],
          "data": [
            {
              "timeStamp": "2017-04-14T02:20:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:21:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:22:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:23:00Z",
              "count": 1,
              "average": 245
            }
          ]
        }
      ]
    }
  ]
}

Get Metric for metadata

Sample Request

GET https://management.azure.com/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&interval=PT1M&aggregation=Average,count&top=3&orderby=Average asc&$filter=BlobType eq '*'&api-version=2018-01-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices

Sample Response

{
  "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
  "namespace": "Microsoft.Storage/storageAccounts/blobServices",
  "resourceregion": "eastus2",
  "value": [
    {
      "id": "/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/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": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "BlockBlob"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "PageBlob"
            }
          ]
        }
      ]
    }
  ]
}

Get Metric with error

Sample Request

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=2018-01-01&metricnamespace=microsoft.documentdb/databaseaccounts

Sample Response

{
  "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"
}

定義

ErrorResponse

エラー応答の形式について説明します。

LocalizableString

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

MetadataValue

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

Metric

クエリの結果データ。

MetricUnit

メトリックの単位。

MetricValue

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

Response

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

ResultType

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

TimeSeriesElement

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

ErrorResponse

エラー応答の形式について説明します。

Name Type Description
code
  • string

エラー コード

message
  • string

操作が失敗した理由を示すエラー メッセージ。

LocalizableString

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

Name Type Description
localizedValue
  • string

ロケール固有の値。

value
  • string

インバリアント値。

MetadataValue

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

Name Type Description
name

メタデータの名前。

value
  • string

メタデータの値。

Metric

クエリの結果データ。

Name Type Description
displayDescription
  • string

このメトリックの詳細な説明。

errorCode
  • string

'Success' またはこのメトリックのクエリ エラーに関するエラーの詳細。

errorMessage
  • string

この特定のメトリックのクエリを実行中にエラー メッセージが発生しました。

id
  • string

メトリック ID。

name

メトリックの名前と表示名 。つまり、ローカライズ可能な文字列です。

timeseries

データ クエリの実行時に返される時系列。

type
  • string

メトリック リソースのリソースの種類。

unit

メトリックの単位。

MetricUnit

メトリックの単位。

Name Type Description
BitsPerSecond
  • string
ByteSeconds
  • string
Bytes
  • string
BytesPerSecond
  • string
Cores
  • string
Count
  • string
CountPerSecond
  • string
MilliCores
  • string
MilliSeconds
  • string
NanoCores
  • string
Percent
  • string
Seconds
  • string
Unspecified
  • string

MetricValue

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

Name Type Description
average
  • number

時間範囲内の平均値。

count
  • number

時間範囲内のサンプルの数。 平均値に寄与した値の数を決定するために使用できます。

maximum
  • number

時間範囲内の最大の値。

minimum
  • number

時間範囲内の最小の値。

timeStamp
  • string

ISO 8601 形式のメトリック値のタイムスタンプ。

total
  • number

時間範囲内のすべての値の合計。

Response

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

Name Type Description
cost
  • number

クエリの相対コストを表す整数値。

interval
  • string

メトリック データが返された間隔 (ウィンドウ サイズ)。 これは将来調整され、最初に要求されたものから返される可能性があります。 メタデータ要求が行われた場合、これは存在しない。

namespace
  • string

クエリを実行するメトリックの名前空間

resourceregion
  • string

メトリックのクエリを実行するリソースのリージョン。

timespan
  • string

データが取得された時間。 その値は、'/' で区切られた 2 つの datetime で連結されたで構成されます。 これは将来調整され、最初に要求されたものから返される可能性があります。

value

コレクションの値。

ResultType

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

Name Type Description
Data
  • string
Metadata
  • string

TimeSeriesElement

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

Name Type Description
data

メトリック値を表すデータ ポイントの配列。 これは、データの結果型が指定されている場合にのみ返されます。

metadatavalues

呼び出しで指定された$filter返されるメタデータ値。