Metrics - List
Listor måttvärdena för en resurs.
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-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Resursens identifierare. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
$filter
|
query |
string |
Den $filter används för att minska mängden måttdata som returneras. |
|
aggregation
|
query |
string |
Listan över sammansättningstyper (kommaavgränsade) som ska hämtas. Exempel: genomsnitt, minimum, maximum |
|
Auto
|
query |
boolean |
Om det angivna tidsintervallet inte stöds av det här måttet returnerar API:et resultatet med det närmaste tidsintervallet som stöds. När värdet är false returneras ett fel för ogiltiga tidsintervallparametrar. Standardvärdet är falskt. |
|
interval
|
query |
string |
Intervallet (t.ex. timegrain) för frågan i ISO 8601-varaktighetsformat. Standardvärdet är PT1M. Specialfall för värdet "FULL" som returnerar en enskild datapunkt för hela det begärda tidsintervallet. Exempel: PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Namnen på måtten (kommaavgränsade) som ska hämtas. |
|
metricnamespace
|
query |
string |
Måttnamnområde där de mått du vill ha finns. |
|
orderby
|
query |
string |
Den sammansättning som ska användas för sortering av resultat och sorteringens riktning. Endast en order kan anges. Exempel: sum asc |
|
result
|
query |
Minskar mängden data som samlas in. Vilken syntax som tillåts beror på åtgärden. Mer information finns i beskrivningen av åtgärden. |
||
rollupby
|
query |
string |
Dimensionsnamn som ska summeras resulterar i. Om du till exempel bara vill se måttvärden med ett filter som "City eq Seattle eller City eq Tacoma" men inte vill se separata värden för varje stad, kan du ange "RollUpBy=City" för att se resultaten för Seattle och Tacoma samlade i en tidsserie. |
|
timespan
|
query |
string |
Tidsintervallet för frågan. Det är en sträng med följande format startDateTime_ISO/endDateTime_ISO. |
|
top
|
query |
integer int32 |
Det maximala antalet poster som ska hämtas per resurs-ID i begäran. Endast giltigt om filter har angetts. Standardvärdet är 10. |
|
Validate
|
query |
boolean |
När värdet är false ignoreras ogiltiga filterparametervärden. När värdet är true returneras ett fel för ogiltiga filterparametrar. Standardvärdet är true. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Lyckad begäran om att hämta listan över måttvärden. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Exempelbegäran
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
Exempelsvar
{
"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
Exempelbegäran
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
Exempelsvar
{
"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
Exempelbegäran
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
Exempelsvar
{
"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"
}
Definitioner
Name | Description |
---|---|
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felsvar |
Localizable |
Den localizable strängklassen. |
Metadata |
Representerar ett värde för måttmetadata. |
Metric |
Resultatdata för en fråga. |
Metric |
Enheten för måttet. |
Metric |
Representerar ett måttvärde. |
Response |
Svaret på en måttfråga. |
Result |
Minskar mängden data som samlas in. Vilken syntax som tillåts beror på åtgärden. Mer information finns i beskrivningen av åtgärden. |
Time |
En tidsserieresultattyp. Det diskriminerande värdet är alltid TimeSeries i det här fallet. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
LocalizableString
Den localizable strängklassen.
Name | Typ | Description |
---|---|---|
localizedValue |
string |
Visningsnamnet. |
value |
string |
Det invarianta värdet. |
MetadataValue
Representerar ett värde för måttmetadata.
Name | Typ | Description |
---|---|---|
name |
Namnet på metadata. |
|
value |
string |
Värdet för metadata. |
Metric
Resultatdata för en fråga.
Name | Typ | Description |
---|---|---|
displayDescription |
string |
Detaljerad beskrivning av det här måttet. |
errorCode |
string |
"Lyckades" eller felinformationen om frågefel för det här måttet. |
errorMessage |
string |
Ett felmeddelande påträffades när det här specifika måttet efterfrågas. |
id |
string |
Mått-ID:t. |
name |
Måttets namn och visningsnamn, d.v.s. det är en localizable-sträng. |
|
timeseries |
Tidsserien returnerades när en datafråga utförs. |
|
type |
string |
Måttresursens resurstyp. |
unit |
Enheten för måttet. |
MetricUnit
Enheten för måttet.
Name | Typ | Description |
---|---|---|
BitsPerSecond |
string |
Frekvensenhet för binära siffror per sekund. |
ByteSeconds |
string |
Enhet för dataöverföring eller lagring. Det är storleken på data i byte multiplicerat med den tid det tar att överföra eller lagra data i sekunder. |
Bytes |
string |
Minnesenhet i byte. |
BytesPerSecond |
string |
Betygsätt minnesenheten i byte per sekund. |
Cores |
string |
Enheten för bearbetningskraft. |
Count |
string |
Enheten för råkvantitet. |
CountPerSecond |
string |
Frekvensenhet för råkvantitet per sekund. |
MilliCores |
string |
Enheten för bearbetningskraft i 1/1000th av en CPU-kärna. |
MilliSeconds |
string |
Tidsenhet i 1/1000 sekund. |
NanoCores |
string |
Enheten för bearbetningskraft i en miljarddel av en CPU-kärna. |
Percent |
string |
Procentenhet. |
Seconds |
string |
Tidsenhet i sekunder. |
Unspecified |
string |
Ingen angiven enhet. |
MetricValue
Representerar ett måttvärde.
Name | Typ | Description |
---|---|---|
average |
number |
Det genomsnittliga värdet i tidsintervallet. |
count |
number |
Antalet exempel i tidsintervallet. Kan användas för att fastställa antalet värden som bidrog till det genomsnittliga värdet. |
maximum |
number |
Det största värdet i tidsintervallet. |
minimum |
number |
Det minsta värdet i tidsintervallet. |
timeStamp |
string |
Tidsstämpeln för måttvärdet i ISO 8601-format. |
total |
number |
Summan av alla värden i tidsintervallet. |
Response
Svaret på en måttfråga.
Name | Typ | Description |
---|---|---|
cost |
number |
Heltalsvärdet som representerar frågans relativa kostnad. |
interval |
string |
Intervallet (fönsterstorlek) för vilket måttdata returnerades i ISO 8601-varaktighetsformat med ett specialfall för värdet "FULL" som returnerar en enskild datapunkt för hela det begärda tidsintervallet (exempel: PT15M, PT1H, P1D, FULL). Detta kan justeras och skilja sig från vad som ursprungligen begärdes om AutoAdjustTimegrain=true har angetts. Detta är inte aktuellt om en metadatabegäran har gjorts. |
namespace |
string |
Namnområdet för måtten som efterfrågas |
resourceregion |
string |
Regionen för resursen som efterfrågas för mått. |
timespan |
string |
Det tidsintervall som data hämtades för. Dess värde består av två sammanlänkade datetimes, avgränsade med "/". Detta kan justeras i framtiden och returneras från det som ursprungligen begärdes. |
value |
Metric[] |
Värdet för samlingen. |
ResultType
Minskar mängden data som samlas in. Vilken syntax som tillåts beror på åtgärden. Mer information finns i beskrivningen av åtgärden.
Name | Typ | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
En tidsserieresultattyp. Det diskriminerande värdet är alltid TimeSeries i det här fallet.
Name | Typ | Description |
---|---|---|
data |
En matris med datapunkter som representerar måttvärdena. Detta returneras endast om en resultattyp av data har angetts. |
|
metadatavalues |
Metadatavärdena returnerades om $filter angavs i anropet. |