Metrics - List
Obsahuje hodnoty metriky proprostředku . Toto rozhraní API používalo výchozí omezení omezování 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}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Identifikátor prostředku. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
$filter
|
query |
string |
$filter slouží ke snížení sady vrácených dat metriky. |
|
aggregation
|
query |
string |
Seznam typů agregace (oddělených čárkami) k načtení. příklady : průměr, minimum, maximální |
|
Auto
|
query |
boolean |
Pokud je tato metrika nastavená na hodnotu true, rozhraní API vrátí výsledek pomocí nejbližšího podporovaného časového rozsahu. Při nastavení na hodnotu false se vrátí chyba pro neplatné parametry časového rozsahu. Výchozí hodnota je false. |
|
interval
|
query |
string |
Interval dotazu (tj. timegrain) dotazu ve formátu doby trvání ISO 8601. Výchozí hodnota je PT1M. Zvláštní případ pro hodnotu FULL, která vrací jeden datový bod po celou dobu požadovanou. Příklady : PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Názvy metrik (oddělené čárkami) pro načtení. Omezte 20 metrik. |
|
metricnamespace
|
query |
string |
Obor názvů metrik, ve kterém se mají nacházet metriky, které chcete mít. |
|
orderby
|
query |
string |
Agregace, která se má použít k řazení výsledků a směru řazení. Lze zadat pouze jednu objednávku. Příklady : součet asc |
|
result
|
query |
Snižuje sadu shromážděných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace. |
||
rollupby
|
query |
string |
Názvy dimenzí pro souhrnné výsledky. Pokud například chcete zobrazit jenom hodnoty metrik s filtrem, jako je City eq Seattle nebo City eq Tacoma, ale nechcete zobrazit samostatné hodnoty pro každé město, můžete zadat RollUpBy=City, abyste viděli výsledky pro Seattle a Tacoma, které se shrnují do časových období. |
|
timespan
|
query |
string |
Časový rozsah dotazu. Jedná se o řetězec s následujícím formátem "startDateTime_ISO/endDateTime_ISO". |
|
top
|
query |
integer int32 |
Maximální početzáznamůch Platné pouze v případě, že je zadán filtr. Výchozí hodnota je 10. |
|
Validate
|
query |
boolean |
Pokud je nastavená hodnota false, budou neplatné hodnoty parametrů filtru ignorovány. Pokud je hodnota true, vrátí se chyba pro neplatné parametry filtru. Výchozí hodnota je true. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Úspěšný požadavek na získání seznamu hodnot metrik |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Ukázkový požadavek
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
Ukázková odpověď
{
"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
Ukázkový požadavek
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
Ukázková odpověď
{
"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
Ukázkový požadavek
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
Ukázková odpověď
{
"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"
}
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Odpověď na chybu |
Localizable |
Lokalizovatelná třída řetězce. |
Metadata |
Představuje hodnotu metadat metriky. |
Metric |
Výsledná data dotazu. |
Metric |
Jednotka metriky. |
Metric |
Představuje hodnotu metriky. |
Response |
Odpověď na dotaz metrik. |
Result |
Snižuje sadu shromážděných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace. |
Time |
Typ výsledku časové řady. Diskriminující hodnota je v tomto případě vždy TimeSeries. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Další typ informací. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby. |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva. |
target |
string |
Cíl chyby. |
LocalizableString
Lokalizovatelná třída řetězce.
Name | Typ | Description |
---|---|---|
localizedValue |
string |
Zobrazovaný název. |
value |
string |
Invariantní hodnota. |
MetadataValue
Představuje hodnotu metadat metriky.
Name | Typ | Description |
---|---|---|
name |
Název metadat. |
|
value |
string |
Hodnota metadat. |
Metric
Výsledná data dotazu.
Name | Typ | Description |
---|---|---|
displayDescription |
string |
Podrobný popis této metriky |
errorCode |
string |
Úspěch nebo podrobnosti o chybě u selhání dotazů pro tuto metriku. |
errorMessage |
string |
Při dotazování na tuto konkrétní metriku byla zjištěna chybová zpráva. |
id |
string |
ID metriky. |
name |
Název a zobrazovaný název metriky, tj. lokalizovatelný řetězec. |
|
timeseries |
Časová řada vrácená při provedení datového dotazu. |
|
type |
string |
Typ prostředku metriky |
unit |
Jednotka metriky. |
MetricUnit
Jednotka metriky.
Name | Typ | Description |
---|---|---|
BitsPerSecond |
string |
Jednotku sazby binárních číslic za sekundu |
ByteSeconds |
string |
Jednotka přenosu nebo úložiště dat. Jedná se o velikost dat v bajtech vynásobenou časem potřebným k přenosu nebo uložení dat v sekundách. |
Bytes |
string |
Jednotka paměti v bajtech |
BytesPerSecond |
string |
Ohodnoťte jednotku paměti v bajtech za sekundu. |
Cores |
string |
Jednotka výpočetního výkonu. |
Count |
string |
Jednotka nezpracovaného množství. |
CountPerSecond |
string |
Jednotku sazby nezpracovaného množství za sekundu |
MilliCores |
string |
Jednotka výpočetního výkonu v 1/1000. jádru procesoru. |
MilliSeconds |
string |
Jednotku času v 1/1000. sekundě. |
NanoCores |
string |
Jednotka výpočetního výkonu v jedné miliardě jádra procesoru. |
Percent |
string |
Procento jednotky. |
Seconds |
string |
Jednotka času v sekundách |
Unspecified |
string |
Žádná zadaná jednotka. |
MetricValue
Představuje hodnotu metriky.
Name | Typ | Description |
---|---|---|
average |
number |
Průměrná hodnota v časovém rozsahu. |
count |
number |
Počet vzorků v časovém rozsahu Lze použít k určení počtu hodnot, které přispěly k průměrné hodnotě. |
maximum |
number |
Nejvyšší hodnota v časovém rozsahu. |
minimum |
number |
Nejmenší hodnota v časovém rozsahu. |
timeStamp |
string |
Časové razítko pro hodnotu metriky ve formátu ISO 8601. |
total |
number |
Součet všech hodnot v časovém rozsahu |
Response
Odpověď na dotaz metrik.
Name | Typ | Description |
---|---|---|
cost |
number |
Celočíselná hodnota představující relativní náklady dotazu. |
interval |
string |
Interval (velikost okna), pro který byla data metrik vrácena ve formátu doby trvání ISO 8601 se speciálním případem pro hodnotu FULL, která vrací jeden datový bod pro celé časové období (Příklady: PT15M, PT1H, P1D, FULL). To se může upravit a lišit od toho, co bylo původně požadováno, pokud je zadána funkce AutoAdjustTimegrain=true. To není k dispozici, pokud byl proveden požadavek na metadata. |
namespace |
string |
Obor názvů dotazovaných metrik |
resourceregion |
string |
Oblast prostředku, na který se dotazuje metriky. |
timespan |
string |
Časový rozsah, pro který byla data načtena. Jeho hodnota se skládá ze dvou zřetězených datových časů oddělených hodnotou /. To se může v budoucnu upravit a vrátit zpět z původního požadavku. |
value |
Metric[] |
Hodnota kolekce. |
ResultType
Snižuje sadu shromážděných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace.
Name | Typ | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Typ výsledku časové řady. Diskriminující hodnota je v tomto případě vždy TimeSeries.
Name | Typ | Description |
---|---|---|
data |
Pole datových bodů představujících hodnoty metrik Tato hodnota se vrátí pouze v případě, že je zadán typ výsledku dat. |
|
metadatavalues |
Hodnoty metadat vrácené v případě, že $filter bylo zadáno ve volání. |