Metrics - List
Seznamy hodnoty metrik pro prostředek.
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 se používá ke snížení sady vrácených dat metrik. |
|
aggregation
|
query |
string |
Seznam typů agregace (oddělených čárkami), které se mají načíst. Příklady: průměr, minimum, maximum |
|
Auto
|
query |
boolean |
Pokud je nastavená hodnota true a předaný časový rozsah není touto metrikou podporován, rozhraní API vrátí výsledek s použitím nejbližšího podporovaného časového rozsahu. Pokud je nastavená hodnota false, vrátí se chyba pro neplatné parametry časového rozsahu. Výchozí hodnota je false. |
|
interval
|
query |
string |
Interval (tj. časový interval) 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 pro celé požadované časové rozpětí. Příklady: PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Názvy metrik (oddělených čárkami), které se mají načíst. |
|
metricnamespace
|
query |
string |
Obor názvů metrik, ve kterém se nacházejí požadované metriky. |
|
orderby
|
query |
string |
Agregace, která se má použít pro řazení výsledků, a směr řazení. Zadat lze pouze jednu objednávku. Příklady: sum asc |
|
result
|
query |
Snižuje množství shromážděných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace. |
||
rollupby
|
query |
string |
Názvy dimenzí, podle které se mají výsledky sčítá. Pokud například chcete zobrazit pouze hodnoty metrik pomocí filtru, jako je "City eq Seattle nebo City eq Tacoma", ale nechcete zobrazit samostatné hodnoty pro každé město, můžete zadat RollUpBy=City a zobrazit výsledky pro Seattle a Tacoma zahrnuté do jednoho časového období. |
|
timespan
|
query |
string |
Časový rozsah dotazu Jedná se o řetězec v následujícím formátu "startDateTime_ISO/endDateTime_ISO". |
|
top
|
query |
integer int32 |
Maximální počet záznamů, které se mají načíst na ID prostředku v požadavku. Platí pouze v případě, že je zadaný filtr. Výchozí hodnota je 10. |
|
Validate
|
query |
boolean |
Pokud je nastavená hodnota false, neplatné hodnoty parametrů filtru budou ignorovány. Pokud je nastavená hodnota true, vrátí se chyba kvůli neplatným parametrům 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
Tok Azure Active Directory OAuth2
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ý řetězec třídy. |
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 množství 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 |
Typ další informace. |
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ý řetězec třídy.
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 |
Success (Úspěch) nebo podrobnosti o chybách dotazů pro tuto metriku |
errorMessage |
string |
Při dotazování na tuto konkrétní metriku se zobrazila chybová zpráva. |
id |
string |
ID metriky |
name |
Název a zobrazovaný název metriky, tj. jedná se o lokalizovatelný řetězec. |
|
timeseries |
Časová řada vrácená při provedení dotazu na data |
|
type |
string |
Typ prostředku metriky. |
unit |
Jednotka metriky. |
MetricUnit
Jednotka metriky.
Name | Typ | Description |
---|---|---|
BitsPerSecond |
string |
Jednotka rychlosti binárních číslic za sekundu. |
ByteSeconds |
string |
Jednotka přenosu dat nebo úložiště. Jedná se o velikost dat v bajtech vynásobenou dobou potřebnou k přenosu nebo uložení dat v sekundách. |
Bytes |
string |
Jednotka paměti v bajtech. |
BytesPerSecond |
string |
Jednotka rychlosti paměti v bajtech za sekundu |
Cores |
string |
Jednotka výpočetního výkonu. |
Count |
string |
Jednotka nezpracovaného množství. |
CountPerSecond |
string |
Sazba jednotky nezpracovaného množství za sekundu. |
MilliCores |
string |
Jednotka výpočetního výkonu v 1/1000th jádra procesoru. |
MilliSeconds |
string |
Jednotka času v 1/1000 sekundy. |
NanoCores |
string |
Jednotka výpočetního výkonu v jedné miliardthě jádra procesoru. |
Percent |
string |
Jednotka procent. |
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 |
Největší hodnota v časovém rozsahu. |
minimum |
number |
Nejmenší hodnota v časovém rozsahu. |
timeStamp |
string |
Časové razítko hodnoty 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 na dotaz. |
interval |
string |
Interval (velikost okna), pro který byla vrácena data metriky ve formátu doby trvání ISO 8601, se zvláštním případem pro hodnotu FULL, která vrací jeden datový bod pro celý požadovaný časový rozsah (příklady: PT15M, PT1H, P1D, FULL). Pokud je zadána hodnota AutoAdjustTimegrain=true, může se tato možnost upravit a lišit se od původního požadavku. Pokud byl proveden požadavek na metadata, není k dispozici. |
namespace |
string |
Obor názvů dotazovaných metrik |
resourceregion |
string |
Oblast prostředku, který se dotazuje na metriky. |
timespan |
string |
Časový rozsah, pro který byla data načtena. Jeho hodnota se skládá ze dvou zřetězených hodnot datetime oddělených parametrem '/'. To může být v budoucnu upraveno a vráceno zpět z původního požadavku. |
value |
Metric[] |
Hodnota kolekce. |
ResultType
Snižuje množství 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í hodnoty metriky. Tato hodnota se vrátí pouze v případě, že je zadán typ výsledku dat. |
|
metadatavalues |
Hodnoty metadat vrácené, pokud byla ve volání zadána $filter. |