Metrics - List
geeft een lijst weer van de metrische waarden voor een resource. Deze API heeft de standaardlimieten voor ARM-beperking gebruikt.
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-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De id van de resource. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
$filter
|
query |
string |
De $filter wordt gebruikt om de set metrische gegevens te verminderen die worden geretourneerd. |
|
aggregation
|
query |
string |
De lijst met aggregatietypen (door komma's gescheiden) die moeten worden opgehaald. Voorbeelden: gemiddelde, minimum, maximum |
|
Auto
|
query |
boolean |
Als de doorgegeven tijdsperiode niet wordt ondersteund door deze metrische waarde, retourneert de API het resultaat met behulp van de dichtstbijzijnde ondersteunde periode. Als deze waarde is ingesteld op onwaar, wordt er een fout geretourneerd voor ongeldige tijdspanneparameters. De standaardwaarde is onwaar. |
|
interval
|
query |
string |
Het interval (bijvoorbeeld timegrain) van de query in iso 8601-duurnotatie. Standaard ingesteld op PT1M. Speciale case voor 'FULL'-waarde die één gegevenspunt retourneert voor een volledige periode die is aangevraagd. Voorbeelden: PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
De namen van de metrische gegevens (door komma's gescheiden) die moeten worden opgehaald. Limiet van 20 metrische gegevens. |
|
metricnamespace
|
query |
string |
Metrische naamruimte waarin de gewenste metrische gegevens zich bevinden. |
|
orderby
|
query |
string |
De aggregatie die moet worden gebruikt voor het sorteren van resultaten en de richting van de sortering. Er kan slechts één bestelling worden opgegeven. Voorbeelden: asc- optellen |
|
result
|
query |
Vermindert de set verzamelde gegevens. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie. |
||
rollupby
|
query |
string |
Dimensienaam(en) om resultaten samen te vouwen op. Als u bijvoorbeeld alleen metrische waarden wilt zien met een filter zoals 'City eq Seattle of City eq Tacoma', maar geen afzonderlijke waarden voor elke stad wilt zien, kunt u RollUpBy=City opgeven om de resultaten voor Seattle en Tacoma in één tijdreeks te zien. |
|
timespan
|
query |
string |
De tijdsduur van de query. Het is een tekenreeks met de volgende notatie 'startDateTime_ISO/endDateTime_ISO'. |
|
top
|
query |
integer int32 |
Het maximum aantal records dat moet worden opgehaald per resource-id in de aanvraag. Alleen geldig als filter is opgegeven. De standaardwaarde is 10. |
|
Validate
|
query |
boolean |
Als deze waarde is ingesteld op onwaar, worden ongeldige filterparameterwaarden genegeerd. Als deze waarde is ingesteld op true, wordt er een fout geretourneerd voor ongeldige filterparameters. De standaardwaarde is waar. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Geslaagde aanvraag om de lijst met metrische waarden op te halen. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Voorbeeldaanvraag
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
Voorbeeldrespons
{
"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
Voorbeeldaanvraag
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
Voorbeeldrespons
{
"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
Voorbeeldaanvraag
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
Voorbeeldrespons
{
"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"
}
Definities
Name | Description |
---|---|
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
Foutreactie |
Localizable |
De lokaliseerbare tekenreeksklasse. |
Metadata |
Vertegenwoordigt een metrische metagegevenswaarde. |
Metric |
De resultaatgegevens van een query. |
Metric |
De eenheid van de metrische waarde. |
Metric |
Vertegenwoordigt een metrische waarde. |
Response |
Het antwoord op een metrische query. |
Result |
Vermindert de set verzamelde gegevens. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie. |
Time |
Een resultaattype voor een tijdreeks. In dit geval is de discriminatorwaarde altijd TimeSeries. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het extra informatietype. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
additionalInfo |
De fout bevat aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
LocalizableString
De lokaliseerbare tekenreeksklasse.
Name | Type | Description |
---|---|---|
localizedValue |
string |
De weergavenaam. |
value |
string |
De invariante waarde. |
MetadataValue
Vertegenwoordigt een metrische metagegevenswaarde.
Name | Type | Description |
---|---|---|
name |
De naam van de metagegevens. |
|
value |
string |
De waarde van de metagegevens. |
Metric
De resultaatgegevens van een query.
Name | Type | Description |
---|---|---|
displayDescription |
string |
Gedetailleerde beschrijving van deze metrische waarde. |
errorCode |
string |
'Geslaagd' of de foutdetails over queryfouten voor deze metrische waarde. |
errorMessage |
string |
Er is een foutbericht opgetreden bij het uitvoeren van een query op deze specifieke metrische waarde. |
id |
string |
De metrische id. |
name |
De naam en de weergavenaam van de metrische waarde, dat wil bijvoorbeeld de lokaliseerbare tekenreeks. |
|
timeseries |
De tijdreeks die wordt geretourneerd wanneer een gegevensquery wordt uitgevoerd. |
|
type |
string |
Het resourcetype van de metrische resource. |
unit |
De eenheid van de metrische waarde. |
MetricUnit
De eenheid van de metrische waarde.
Name | Type | Description |
---|---|---|
BitsPerSecond |
string |
Snelheidseenheid van binaire cijfers per seconde. |
ByteSeconds |
string |
Eenheid van gegevensoverdracht of opslag. Het is de grootte van de gegevens in bytes vermenigvuldigd met de tijd die nodig is om de gegevens over te dragen of op te slaan in seconden. |
Bytes |
string |
Geheugeneenheid in bytes. |
BytesPerSecond |
string |
Snelheidseenheid van het geheugen in bytes per seconde. |
Cores |
string |
Verwerkingskracht. |
Count |
string |
Eenheid van onbewerkte hoeveelheid. |
CountPerSecond |
string |
Tariefeenheid van onbewerkte hoeveelheid per seconde. |
MilliCores |
string |
Verwerkingskracht in 1/1000e van een CPU-kern. |
MilliSeconds |
string |
Tijdseenheid in 1/1000e van een seconde. |
NanoCores |
string |
Verwerkingskracht in één miljardste van een CPU-kern. |
Percent |
string |
Percentageeenheid. |
Seconds |
string |
Tijdseenheid in seconden. |
Unspecified |
string |
Geen opgegeven eenheid. |
MetricValue
Vertegenwoordigt een metrische waarde.
Name | Type | Description |
---|---|---|
average |
number |
De gemiddelde waarde in het tijdsbereik. |
count |
number |
Het aantal steekproeven in het tijdsbereik. Kan worden gebruikt om het aantal waarden te bepalen dat heeft bijgedragen aan de gemiddelde waarde. |
maximum |
number |
De grootste waarde in het tijdsbereik. |
minimum |
number |
De minste waarde in het tijdsbereik. |
timeStamp |
string |
De tijdstempel voor de metrische waarde in ISO 8601-indeling. |
total |
number |
De som van alle waarden in het tijdsbereik. |
Response
Het antwoord op een metrische query.
Name | Type | Description |
---|---|---|
cost |
number |
De geheel getalwaarde die de relatieve kosten van de query vertegenwoordigt. |
interval |
string |
Het interval (venstergrootte) waarvoor de metrische gegevens zijn geretourneerd in iso 8601-duurnotatie met een speciaal geval voor 'FULL'-waarde die één gegevenspunt retourneert voor een volledige tijdsperiode (Voorbeelden: PT15M, PT1H, P1D, FULL). Dit kan worden aangepast en verschilt van wat oorspronkelijk is aangevraagd als AutoAdjustTimegrain=true is opgegeven. Dit is niet aanwezig als er een metagegevensaanvraag is ingediend. |
namespace |
string |
De naamruimte van de metrische gegevens die worden opgevraagd |
resourceregion |
string |
De regio van de resource die wordt opgevraagd voor metrische gegevens. |
timespan |
string |
De periode waarvoor de gegevens zijn opgehaald. De waarde bestaat uit twee datum/tijd-samenvoeging, gescheiden door '/'. Dit kan in de toekomst worden aangepast en geretourneerd van wat oorspronkelijk is aangevraagd. |
value |
Metric[] |
De waarde van de verzameling. |
ResultType
Vermindert de set verzamelde gegevens. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie.
Name | Type | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Een resultaattype voor een tijdreeks. In dit geval is de discriminatorwaarde altijd TimeSeries.
Name | Type | Description |
---|---|---|
data |
Een matrix met gegevenspunten die de metrische waarden vertegenwoordigen. Dit wordt alleen geretourneerd als een resultaattype van gegevens is opgegeven. |
|
metadatavalues |
De metagegevenswaarden die worden geretourneerd als $filter is opgegeven in de aanroep. |