Metrics - List

參考

Service:: Monitor

API Version:: 2023-10-01

清單資源的計量值。

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

With optional parameters:

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 參數

名稱	位於	必要	類型	Description
resourceUri	path	True	string	資源的標識碼。
api-version	query	True	string	用於此作業的 API 版本。
$filter	query		string	$filter可用來減少傳回的計量數據集。範例：計量包含元數據 A、B 和 C。 - 傳回 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 ''*。
aggregation	query		string	要擷取的匯總類型清單 (逗號分隔) 。範例：平均值、最小值、最大值
AutoAdjustTimegrain	query		boolean	當設定為 true 時，如果此計量不支援傳入的時間範圍，API 將會使用最接近的支援時間範圍傳回結果。當設定為 false 時，會針對無效的時間範圍參數傳回錯誤。預設為 False。
interval	query		string	間隔 (，也就是 ISO 8601 持續時間格式查詢的 timegrain) 。預設為 PT1M。 'FULL' 值的特殊案例，會針對要求的整個時間範圍傳回單一數據點。範例：PT15M、PT1H、P1D、FULL
metricnames	query		string	要擷取的計量名稱 (逗號分隔) 。
metricnamespace	query		string	您想要所在計量的計量命名空間。
orderby	query		string	用於排序結果和排序方向的匯總。只能指定一個訂單。範例：sum asc
resultType	query		ResultType	減少收集的數據集。允許的語法取決於作業。如需詳細資訊，請參閱作業的描述。
rollupby	query		string	要匯總結果的維度名稱 () 。例如，如果您只想要查看具有『City eq Seattle 或 City eq Tacoma』等篩選條件的計量值，但不想查看每個城市的不同值，您可以指定 'RollUpBy=City' 來查看西雅圖和 Tacoma 的結果匯總成一次。
timespan	query		string	查詢的時間範圍。它是格式為『startDateTime_ISO/endDateTime_ISO』的字串。
top	query		integer int32	在要求中擷取每個資源標識碼的最大記錄數目。只有在指定篩選條件時才有效。預設值為 10。
ValidateDimensions	query		boolean	當設定為 false 時，將會忽略無效的篩選參數值。當設定為 true 時，會針對無效的篩選參數傳回錯誤。預設為 true。

回應

名稱	類型	Description
200 OK	Response	成功要求以取得計量值清單。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get Metric for data

Get Metric for metadata

Get Metric with error

Get Metric for data

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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"
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	錯誤回應
LocalizableString	可本地化的字串類別。
MetadataValue	表示計量元數據值。
Metric	查詢的結果數據。
MetricUnit	計量的單位。
MetricValue	表示計量值。
Response	計量查詢的回應。
ResultType	減少收集的數據集。允許的語法取決於作業。如需詳細資訊，請參閱作業的描述。
TimeSeriesElement	時間序列結果類型。在此情況下，鑒別子值一律是 TimeSeries。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

錯誤回應

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

LocalizableString

可本地化的字串類別。

名稱	類型	Description
localizedValue	string	顯示名稱。
value	string	非變異值。

MetadataValue

表示計量元數據值。

名稱	類型	Description
name	LocalizableString	中繼資料名稱。
value	string	中繼資料的值。

Metric

查詢的結果數據。

名稱	類型	Description
displayDescription	string	此計量的詳細描述。
errorCode	string	「成功」或此計量查詢失敗的錯誤詳細數據。
errorMessage	string	查詢此特定計量時發生錯誤訊息。
id	string	計量標識碼。
name	LocalizableString	計量的名稱和顯示名稱，亦即它是可本地化的字串。
timeseries	TimeSeriesElement[]	執行資料查詢時傳回的時間序列。
type	string	計量資源的資源類型。
unit	MetricUnit	計量的單位。

MetricUnit

計量的單位。

名稱	類型	Description
BitsPerSecond	string	每秒二進位數的速率單位。
ByteSeconds	string	數據傳輸或記憶體的單位。這是以位元組為單位的數據大小，乘以傳輸或儲存資料所需的時間，以秒為單位。
Bytes	string	以位元組為單位的記憶體單位。
BytesPerSecond	string	每秒以位元組為單位的記憶體速率單位。
Cores	string	處理能力單位。
Count	string	原始數量單位。
CountPerSecond	string	每秒原始數量的速率單位。
MilliCores	string	CPU 核心中 1/1000 的處理能力單位。
MilliSeconds	string	以 1/1000 秒為單位的時間單位。
NanoCores	string	CPU 核心中十億分之一的處理能力單位。
Percent	string	百分比單位。
Seconds	string	以秒為單位的時間單位。
Unspecified	string	沒有指定的單位。

MetricValue

表示計量值。

名稱	類型	Description
average	number	時間範圍內的平均值。
count	number	時間範圍內的樣本數目。可用來判斷參與平均值的值數目。
maximum	number	時間範圍內的最大值。
minimum	number	時間範圍內的最小值。
timeStamp	string	ISO 8601 格式計量值的時間戳。
total	number	時間範圍內所有值的總和。

Response

計量查詢的回應。

名稱	類型	Description
cost	number	表示查詢相對成本的整數值。
interval	string	間隔 (視窗大小) ，計量數據是以 ISO 8601 持續時間格式傳回，其特殊案例為『FULL』值，會針對要求之整個時間範圍傳回單一數據點 (範例：PT15M、PT1H、P1D、FULL) 。如果指定 AutoAdjustTimegrain=true，可能會調整和原本要求的內容不同。如果已提出元數據要求，則不會出現此專案。
namespace	string	正在查詢之計量的命名空間
resourceregion	string	正在查詢計量之資源的區域。
timespan	string	擷取數據的時間範圍。其值是由兩個串連的 datetime 所組成，並以『/』分隔。這可能會在未來進行調整，並從原先要求的內容傳回。
value	Metric[]	集合的值。

ResultType

減少收集的數據集。允許的語法取決於作業。如需詳細資訊，請參閱作業的描述。

名稱	類型	Description
Data	string
Metadata	string

TimeSeriesElement

時間序列結果類型。在此情況下，鑒別子值一律是 TimeSeries。

名稱	類型	Description
data	MetricValue[]	代表度量值的數據點陣列。只有在指定數據的結果類型時，才會傳回這個值。
metadatavalues	MetadataValue[]	如果在呼叫中指定$filter，則傳回的元數據值。

Metrics - List

URI 參數

回應

安全性

azure_auth

Scopes

範例

Get Metric for data

Sample Request

Sample Response

Get Metric for metadata

Sample Request

Sample Response

Get Metric with error

Sample Request

Sample Response

定義

ErrorAdditionalInfo

ErrorResponse

LocalizableString

MetadataValue

Metric

MetricUnit

MetricValue

Response

ResultType

TimeSeriesElement

其他資源