Metrics - List
Elenca i valori delle metriche per una risorsa. Questa API usava i limiti di limitazione arm predefiniti .
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}
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
resource
|
path | True |
string |
Identificatore della risorsa. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
$filter
|
query |
string |
Il $filter viene usato per ridurre il set di dati delle metriche restituiti. |
|
aggregation
|
query |
string |
Elenco di tipi di aggregazione (delimitati da virgole) da recuperare. esempi : media, minima, massima |
|
Auto
|
query |
boolean |
Se impostato su true, se l'intervallo di tempo passato non è supportato da questa metrica, l'API restituirà il risultato usando l'intervallo di tempo supportato più vicino. Se impostato su false, viene restituito un errore per i parametri timespan non validi. Il valore predefinito è false. |
|
interval
|
query |
string |
Intervallo (ad esempio timegrain) della query nel formato di durata ISO 8601. Il valore predefinito è PT1M. Caso speciale per il valore 'FULL' che restituisce un singolo punto dati per l'intero intervallo di tempo richiesto. esempi di : PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Nomi delle metriche (delimitate da virgole) da recuperare. Limitare 20 metriche. |
|
metricnamespace
|
query |
string |
Spazio dei nomi della metrica in cui risiedono le metriche desiderate. |
|
orderby
|
query |
string |
Aggregazione da utilizzare per l'ordinamento dei risultati e la direzione dell'ordinamento. È possibile specificare un solo ordine. esempi di : somma asc |
|
result
|
query |
Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione. |
||
rollupby
|
query |
string |
Nomi delle dimensioni per cui eseguire il rollup dei risultati. Ad esempio, se si vogliono visualizzare solo i valori delle metriche con un filtro come "City eq Seattle o City eq Tacoma", ma non si vogliono visualizzare valori separati per ogni città, è possibile specificare "RollUpBy=City" per visualizzare i risultati per Seattle e Tacoma distribuiti in un'unica occorrenza. |
|
timespan
|
query |
string |
Intervallo di tempo della query. Si tratta di una stringa con il formato seguente 'startDateTime_ISO/endDateTime_ISO'. |
|
top
|
query |
integer int32 |
Numero massimo di record da recuperare per ID risorsa nella richiesta. Valido solo se viene specificato il filtro. Il valore predefinito è 10. |
|
Validate
|
query |
boolean |
Se impostato su false, i valori dei parametri di filtro non validi verranno ignorati. Se impostato su true, viene restituito un errore per i parametri di filtro non validi. Il valore predefinito è true. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Richiesta riuscita per ottenere l'elenco dei valori delle metriche. |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Esempio di richiesta
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
Risposta di esempio
{
"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
Esempio di richiesta
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
Risposta di esempio
{
"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
Esempio di richiesta
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
Risposta di esempio
{
"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"
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Risposta errore |
Localizable |
Classe stringa localizzabile. |
Metadata |
Rappresenta un valore dei metadati della metrica. |
Metric |
Dati dei risultati di una query. |
Metric |
Unità della metrica. |
Metric |
Rappresenta un valore della metrica. |
Response |
Risposta a una query sulle metriche. |
Result |
Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione. |
Time |
Tipo di risultato time series. Il valore discriminatorio è sempre TimeSeries in questo caso. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorResponse
Risposta errore
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
LocalizableString
Classe stringa localizzabile.
Nome | Tipo | Descrizione |
---|---|---|
localizedValue |
string |
Nome visualizzato. |
value |
string |
Valore invariante. |
MetadataValue
Rappresenta un valore dei metadati della metrica.
Nome | Tipo | Descrizione |
---|---|---|
name |
Nome dei metadati. |
|
value |
string |
Valore dei metadati. |
Metric
Dati dei risultati di una query.
Nome | Tipo | Descrizione |
---|---|---|
displayDescription |
string |
Descrizione dettagliata di questa metrica. |
errorCode |
string |
'Operazione riuscita' o dettagli dell'errore sugli errori di query per questa metrica. |
errorMessage |
string |
Messaggio di errore durante la query su questa metrica specifica. |
id |
string |
ID metrica. |
name |
Il nome e il nome visualizzato della metrica, ovvero è una stringa localizzabile. |
|
timeseries |
Serie temporale restituita quando viene eseguita una query di dati. |
|
type |
string |
Tipo di risorsa della risorsa metrica. |
unit |
Unità della metrica. |
MetricUnit
Unità della metrica.
Nome | Tipo | Descrizione |
---|---|---|
BitsPerSecond |
string |
Unità di frequenza delle cifre binarie al secondo. |
ByteSeconds |
string |
Unità di trasferimento o archiviazione dei dati. Si tratta delle dimensioni dei dati in byte moltiplicati per il tempo necessario per trasferire o archiviare i dati in secondi. |
Bytes |
string |
Unità di memoria in byte. |
BytesPerSecond |
string |
Unità di frequenza della memoria in byte al secondo. |
Cores |
string |
Unità di potenza di elaborazione. |
Count |
string |
Unità di quantità non elaborata. |
CountPerSecond |
string |
Unità di frequenza della quantità non elaborata al secondo. |
MilliCores |
string |
Unità di potenza di elaborazione in 1/1000 di un core CPU. |
MilliSeconds |
string |
Unità di tempo in 1/1000 di secondo. |
NanoCores |
string |
Unità di potenza di elaborazione in un miliardesimo di core CPU. |
Percent |
string |
Unità percentuale. |
Seconds |
string |
Unità di tempo in secondi. |
Unspecified |
string |
Nessuna unità specificata. |
MetricValue
Rappresenta un valore della metrica.
Nome | Tipo | Descrizione |
---|---|---|
average |
number |
Valore medio nell'intervallo di tempo. |
count |
number |
Numero di campioni nell'intervallo di tempo. Può essere usato per determinare il numero di valori che hanno contribuito al valore medio. |
maximum |
number |
Valore massimo nell'intervallo di tempo. |
minimum |
number |
Valore minimo nell'intervallo di tempo. |
timeStamp |
string |
Timestamp per il valore della metrica in formato ISO 8601. |
total |
number |
Somma di tutti i valori nell'intervallo di tempo. |
Response
Risposta a una query sulle metriche.
Nome | Tipo | Descrizione |
---|---|---|
cost |
number |
Valore intero che rappresenta il costo relativo della query. |
interval |
string |
Intervallo (dimensione finestra) per il quale sono stati restituiti i dati delle metriche nel formato di durata ISO 8601 con un caso speciale per il valore "FULL" che restituisce un singolo punto dati per l'intero intervallo di tempo richiesto (Esempi: PT15M, PT1H, P1D, FULL). Questa operazione può essere modificata e diversa da quella richiesta originariamente se viene specificato AutoAdjustTimegrain=true. Non è presente se è stata effettuata una richiesta di metadati. |
namespace |
string |
Spazio dei nomi delle metriche sottoposte a query |
resourceregion |
string |
Area della risorsa sottoposta a query per le metriche. |
timespan |
string |
Intervallo di tempo per il quale sono stati recuperati i dati. Il valore è costituito da due datetime concatenate, separate da '/'. Questo può essere modificato in futuro e restituito da ciò che è stato originariamente richiesto. |
value |
Metric[] |
Valore dell'insieme. |
ResultType
Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione.
Nome | Tipo | Descrizione |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Tipo di risultato time series. Il valore discriminatorio è sempre TimeSeries in questo caso.
Nome | Tipo | Descrizione |
---|---|---|
data |
Matrice di punti dati che rappresentano i valori delle metriche. Viene restituito solo se viene specificato un tipo di dati di risultato. |
|
metadatavalues |
I valori dei metadati restituiti se $filter è stato specificato nella chiamata. |