Metrics - List
Répertorie les valeurs de métrique d’une ressource. Cette API a utilisé les limites de limitation ARM par défaut.
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}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Identificateur de la ressource. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
$filter
|
query |
string |
La $filter est utilisée pour réduire l’ensemble de données de métrique retournées. |
|
aggregation
|
query |
string |
Liste des types d’agrégation (séparés par des virgules) à récupérer. exemples : moyenne, minimale, maximale |
|
Auto
|
query |
boolean |
Lorsque la valeur est true, si l’intervalle de temps passé n’est pas pris en charge par cette métrique, l’API retourne le résultat à l’aide de l’intervalle de temps le plus proche pris en charge. Lorsque la valeur est false, une erreur est retournée pour les paramètres d’intervalle de temps non valides. La valeur par défaut est false. |
|
interval
|
query |
string |
Intervalle (c.-à-d. timegrain) de la requête au format de durée ISO 8601. La valeur par défaut est PT1M. Cas spécial pour la valeur « FULL » qui retourne un point de données unique pendant toute la durée demandée. exemples : PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Noms des métriques (séparées par des virgules) à récupérer. Limitez 20 métriques. |
|
metricnamespace
|
query |
string |
Espace de noms de métrique où résident les métriques souhaitées. |
|
orderby
|
query |
string |
Agrégation à utiliser pour trier les résultats et la direction du tri. Une seule commande peut être spécifiée. exemples : somme d’asc |
|
result
|
query |
Réduit le jeu de données collectées. La syntaxe autorisée dépend de l’opération. Pour plus d’informations, consultez la description de l’opération. |
||
rollupby
|
query |
string |
Nom(s) de dimension par utilisant les résultats cumulatifs. Par exemple, si vous souhaitez uniquement voir les valeurs de métrique avec un filtre tel que « City eq Seattle ou City eq Tacoma », mais que vous ne souhaitez pas voir des valeurs distinctes pour chaque ville, vous pouvez spécifier « RollUpBy=City » pour afficher les résultats de Seattle et Tacoma inscrits dans une seule série chronologique. |
|
timespan
|
query |
string |
Intervalle de temps de la requête. Il s’agit d’une chaîne au format suivant « startDateTime_ISO/endDateTime_ISO ». |
|
top
|
query |
integer int32 |
Nombre maximal d’enregistrements à récupérer par ID de ressource dans la requête. Valide uniquement si le filtre est spécifié. La valeur par défaut est 10. |
|
Validate
|
query |
boolean |
Lorsque la valeur est false, les valeurs de paramètre de filtre non valides sont ignorées. Lorsqu’elle est définie sur true, une erreur est retournée pour les paramètres de filtre non valides. La valeur par défaut est true. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Demande réussie pour obtenir la liste des valeurs de métriques. |
|
Other Status Codes |
Réponse d’erreur décrivant pourquoi l’opération a échoué. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Exemple de requête
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
Exemple de réponse
{
"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
Exemple de requête
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
Exemple de réponse
{
"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
Exemple de requête
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
Exemple de réponse
{
"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"
}
Définitions
Nom | Description |
---|---|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Réponse d’erreur |
Localizable |
Classe de chaîne localisable. |
Metadata |
Représente une valeur de métadonnées de métrique. |
Metric |
Données de résultat d’une requête. |
Metric |
Unité de la métrique. |
Metric |
Représente une valeur de métrique. |
Response |
Réponse à une requête de métriques. |
Result |
Réduit le jeu de données collectées. La syntaxe autorisée dépend de l’opération. Pour plus d’informations, consultez la description de l’opération. |
Time |
Type de résultat de série chronologique. La valeur de discriminateur est toujours TimeSeries dans ce cas. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires. |
type |
string |
Type d’informations supplémentaire. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d’erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
LocalizableString
Classe de chaîne localisable.
Nom | Type | Description |
---|---|---|
localizedValue |
string |
Nom complet. |
value |
string |
Valeur invariante. |
MetadataValue
Représente une valeur de métadonnées de métrique.
Nom | Type | Description |
---|---|---|
name |
Nom des métadonnées. |
|
value |
string |
Valeur des métadonnées. |
Metric
Données de résultat d’une requête.
Nom | Type | Description |
---|---|---|
displayDescription |
string |
Description détaillée de cette métrique. |
errorCode |
string |
« Réussite » ou détails de l’erreur sur les échecs de requête pour cette métrique. |
errorMessage |
string |
Message d’erreur rencontré lors de l’interrogation de cette métrique spécifique. |
id |
string |
ID de métrique. |
name |
Nom et nom complet de la métrique, c’est-à-dire chaîne localisable. |
|
timeseries |
Série chronologique retournée lorsqu’une requête de données est effectuée. |
|
type |
string |
Type de ressource de la ressource de métrique. |
unit |
Unité de la métrique. |
MetricUnit
Unité de la métrique.
Nom | Type | Description |
---|---|---|
BitsPerSecond |
string |
Unité de taux de chiffres binaires par seconde. |
ByteSeconds |
string |
Unité de transfert ou de stockage de données. Il s’agit de la taille des données en octets multipliées par le temps nécessaire pour transférer ou stocker les données en secondes. |
Bytes |
string |
Unité de mémoire en octets. |
BytesPerSecond |
string |
Unité de débit de mémoire en octets par seconde. |
Cores |
string |
Unité de puissance de traitement. |
Count |
string |
Unité de quantité brute. |
CountPerSecond |
string |
Unité de taux de quantité brute par seconde. |
MilliCores |
string |
Unité de puissance de traitement en 1/1000e d’un cœur de processeur. |
MilliSeconds |
string |
Unité de temps en 1/1000e d’une seconde. |
NanoCores |
string |
Unité de puissance de traitement en un milliardième d’un cœur de processeur. |
Percent |
string |
Unité de pourcentage. |
Seconds |
string |
Unité de temps en secondes. |
Unspecified |
string |
Aucune unité spécifiée. |
MetricValue
Représente une valeur de métrique.
Nom | Type | Description |
---|---|---|
average |
number |
Valeur moyenne dans l’intervalle de temps. |
count |
number |
Nombre d’échantillons dans l’intervalle de temps. Peut être utilisé pour déterminer le nombre de valeurs qui ont contribué à la valeur moyenne. |
maximum |
number |
Valeur la plus élevée dans l’intervalle de temps. |
minimum |
number |
Valeur minimale dans l’intervalle de temps. |
timeStamp |
string |
Horodatage de la valeur de métrique au format ISO 8601. |
total |
number |
Somme de toutes les valeurs de l’intervalle de temps. |
Response
Réponse à une requête de métriques.
Nom | Type | Description |
---|---|---|
cost |
number |
Valeur entière représentant le coût relatif de la requête. |
interval |
string |
Intervalle (taille de fenêtre) pour lequel les données de métrique ont été retournées au format de durée ISO 8601 avec un cas spécial pour la valeur « FULL » qui retourne un point de données unique pour l’intervalle de temps entier demandé (Exemples : PT15M, PT1H, P1D, FULL). Cela peut être ajusté et différent de ce qui a été demandé à l’origine si AutoAdjustTimegrain=true est spécifié. Cela n’est pas présent si une demande de métadonnées a été effectuée. |
namespace |
string |
Espace de noms des métriques interrogées |
resourceregion |
string |
Région de la ressource interrogée pour les métriques. |
timespan |
string |
Intervalle de temps pour lequel les données ont été récupérées. Sa valeur se compose de deux datetimes concaténées, séparées par « / ». Cela peut être ajusté à l’avenir et retourné à partir de ce qui a été demandé à l’origine. |
value |
Metric[] |
Valeur de la collection. |
ResultType
Réduit le jeu de données collectées. La syntaxe autorisée dépend de l’opération. Pour plus d’informations, consultez la description de l’opération.
Nom | Type | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Type de résultat de série chronologique. La valeur de discriminateur est toujours TimeSeries dans ce cas.
Nom | Type | Description |
---|---|---|
data |
Tableau de points de données représentant les valeurs de métriques. Cela n’est retourné que si un type de données de résultat est spécifié. |
|
metadatavalues |
Valeurs de métadonnées retournées si $filter a été spécifié dans l’appel. |